pg_lo_write

FunctionParams changed in PHP 8.1

Write to a large object.

PHP 5
PHP 7
PHP 8.0
Improved
PHP 8.1
Improved
PHP 8.2-8.3
PHP 8.4
PHP 8.5
PHP 8.6

pg_lo_write Function synopsis

pg_lo_write(
    PgSql\Lob $lob,
    string $data,
    ?int $length = null
  ): int|false

Parameters

$lob

TypePgSql\Lob

$data

Typestring

The data to be written to the large object. If $length is an int and is less than the length of $data, only $length bytes will be written.

$length

OptionalType?intDefault valuenull

An optional maximum number of bytes to write. Must be greater than zero and no greater than the length of $data. Defaults to the length of $data.

Return value

Typeint|false

The number of bytes written to the large object, or false on error.

Changes to the pg_lo_write Function

PHP 8.1

  • Parameter type added for parameter #1 ($lob): PgSql\Lob
  pg_lo_write(
-     $lob,
+     PgSql\Lob $lob,
      string $data,
      ?int $length = null
    ): int|false

PHP 8.0

  • Return type added: int|false
  • Parameter name of parameter #1 changed: $large_object to $lob
  • Parameter name of parameter #2 changed: $buf to $data
  • Parameter type added for parameter #2 ($data): string
  • Parameter name of parameter #3 changed: $len to $length
  • Parameter type added for parameter #3 ($length): ?int
  • Parameter default value added for position #3 ($length): null
  pg_lo_write(
-     $large_object,
+     $lob,
-     $buf,
+     string $data,
-     $len
+     ?int $length = null
-   )
+   ): int|false

pg_lo_write Function Availability

PHP VersionAvailability
PHP 8.6Upcoming Release Yes
PHP 8.5Supported (Latest) Yes
PHP 8.4Supported Yes
PHP 8.3Security-Fixes Only Yes
PHP 8.2Security-Fixes Only Yes
PHP 8.1Unsupported Yes
PHP 8.0Unsupported Yes
PHP 7.4Unsupported Yes
PHP 7.3Unsupported Yes
PHP 7.2Unsupported Yes
PHP 7.1Unsupported Yes
PHP 7.0Unsupported Yes
PHP 5.6Unsupported Yes
PHP 5.5Unsupported Yes
PHP 5.4Unsupported Yes
PHP 5.3Unsupported Yes