stream_socket_enable_crypto

Function • Params and return types changed in PHP 8.0

Turns encryption on/off on an already connected socket.

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

stream_socket_enable_crypto Function synopsis

stream_socket_enable_crypto(
    $stream,
    bool $enable,
    ?int $crypto_method = null,
    $session_stream = null
  ): int|bool

Parameters

$stream

The stream resource.

$enable

Typebool

Enable/disable cryptography on the stream.

$crypto_method

OptionalType?intDefault valuenull

Setup encryption on the stream. Valid methods are

$session_stream

OptionalDefault valuenull

Seed the stream with settings from $session_stream.

Return value

Typeint|bool

Returns true on success, false if negotiation has failed or 0 if there isn't enough data and you should try again (only for non-blocking sockets).

Changes to the stream_socket_enable_crypto Function

PHP 8.0

  • Return type added: int|bool
  • Parameter type added for parameter #2 ($enable): bool
  • Parameter name of parameter #3 changed: $cryptokind to $crypto_method
  • Parameter type added for parameter #3 ($crypto_method): ?int
  • Parameter default value added for position #3 ($crypto_method): null
  • Parameter name of parameter #4 changed: $sessionstream to $session_stream
  • Parameter default value added for position #4 ($session_stream): null
  stream_socket_enable_crypto(
      $stream,
-     $enable,
+     bool $enable,
-     $cryptokind,
+     ?int $crypto_method = null,
-     $sessionstream
+     $session_stream = null
-   )
+   ): int|bool

stream_socket_enable_crypto 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