deflate_add

Function • Params and return types changed in PHP 8.0

Incrementally deflate data.

PHP 5
PHP 7.0
Added
PHP 7.1-7.4
PHP 8.0
Improved
PHP 8.1
PHP 8.2-8.3
PHP 8.4
PHP 8.5
PHP 8.6

deflate_add Function synopsis

deflate_add(
    DeflateContext $context,
    string $data,
    int $flush_mode = ZLIB_SYNC_FLUSH
  ): string|false

Parameters

$context

TypeDeflateContext

A context created with deflate_init.

$data

Typestring

A chunk of data to compress.

$flush_mode

OptionalTypeintDefault valueZLIB_SYNC_FLUSH

One of ZLIB_BLOCK, ZLIB_NO_FLUSH, ZLIB_PARTIAL_FLUSH, ZLIB_SYNC_FLUSH (default), ZLIB_FULL_FLUSH, ZLIB_FINISH. Normally you will want to set ZLIB_NO_FLUSH to maximize compression, and ZLIB_FINISH to terminate with the last chunk of data. See the zlib manual for a detailed description of these constants.

Return value

Typestring|false

Returns a chunk of compressed data, or false on failure.

Changes to the deflate_add Function

PHP 8.0

  • Return type added: string|false
  • Parameter name of parameter #1 changed: $resource to $context
  • Parameter type added for parameter #1 ($context): DeflateContext
  • Parameter name of parameter #2 changed: $add to $data
  • Parameter type added for parameter #2 ($data): string
  • Parameter name of parameter #3 changed: $flush_behavior to $flush_mode
  • Parameter type added for parameter #3 ($flush_mode): int
  • Parameter default value added for position #3 ($flush_mode): ZLIB_SYNC_FLUSH
  deflate_add(
-     $resource,
+     DeflateContext $context,
-     $add,
+     string $data,
-     $flush_behavior
+     int $flush_mode = ZLIB_SYNC_FLUSH
-   )
+   ): string|false

PHP 7.0

  • Function added

deflate_add 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 No
PHP 5.5Unsupported No
PHP 5.4Unsupported No
PHP 5.3Unsupported No