gzencode

Function • Params and return types changed in PHP 8.0

Create a gzip compressed string.

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

gzencode Function synopsis

gzencode(
    string $data,
    int $level = -1,
    int $encoding = ZLIB_ENCODING_GZIP
  ): string|false

Parameters

$data

Typestring

The data to encode.

$level

OptionalTypeintDefault value-1

The level of compression. Can be given as 0 for no compression up to 9 for maximum compression. If not given, the default compression level will be the default compression level of the zlib library.

$encoding

OptionalTypeintDefault valueZLIB_ENCODING_GZIP

The encoding mode. Can be FORCE_GZIP (the default) or FORCE_DEFLATE.

Return value

Typestring|false

The encoded string, or false if an error occurred.

Changes to the gzencode Function

PHP 8.0

  • Return type added: string|false
  • Parameter type added for parameter #1 ($data): string
  • Parameter type added for parameter #2 ($level): int
  • Parameter default value added for position #2 ($level): -1
  • Parameter type added for parameter #3 ($encoding): int
  • Parameter default value added for position #3 ($encoding): ZLIB_ENCODING_GZIP
  gzencode(
-     $data,
+     string $data,
-     $level,
+     int $level = -1,
-     $encoding
+     int $encoding = ZLIB_ENCODING_GZIP
-   )
+   ): string|false

PHP 5.4

  • Parameter name of parameter #3 changed: $encoding_mode to $encoding
  gzencode(
      $data,
      $level,
-     $encoding_mode
+     $encoding
    )

gzencode 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