PHP 8.1 documentation tracker

[Girgias]

Pages which need to be added/modified for complete documentation of PHP 8.1.

Based of the migration guide: https://www.php.net/manual/en/migration81.php

This is currently still heavily a work in progress.

Core:

• New features:
  • Type declarations
    • Intersection types (Restructure type declaration page & document Intersection types #982)
    • never (Add documentation about the never type #889)
  • Integer Octal Literal Prefix (PHP 8.1: Update integer docs for new octal notation #1091)
  • Array Unpacking with String Keys ([PHP 8.1] Document Array Unpacking with [int|string] Keys. #1171)
  • Named Argument After Argument Unpacking ([PHP 8.1] Use named arguments after unpacking #1329)
    • No RFC. related PR -> Allow named args after unpack php-src#7009
  • full-path Key for File Uploads ([PHP 8.1] Documentation for full_path entry of $_FILES #1130)
  • Enumerations (Document enumerations #960)
  • Fibers (Fiber documentation #1096)
  • First Class Callable Syntax ([PHP 8.1] Document the first class callable syntax. #1176)
  • new in Initializers ([PHP 8.1] New in initializers #1327)
  • Readonly properties ([PHP 8.1] Document readonly properties. #1047)
  • Final class constants ([PHP 8.1] Document final class constants. #1041)
• Deprecated
  • Implementing Serializable without __serialize() and __unserialize() ([PHP 8.1] Add note about implementing Serializable without __serialize #1141)
  • Passing null to non-nullable parameters of built-in functions #1554
  • Implicit incompatible float to int conversions ([PHP 8.1] Implicit incompatible float to int conversions #1528)
  • Calling a static element on a trait ([PHP 8.1] Calling a static element on a trait is deprecated #1330)
  • Returning by reference from a void function (Document returning by reference from a void function deprecation. #1127)
  • Autovivification from false (Document autovivification from false deprecation. #1126)
• BC Break
  • $GLOBALS Access Restrictions ([PHP 8.1] Document restriction of $GLOBALS usage. #1147)
  • Usage of static Variables in Inherited Methods ([PHP 8.1] Usage of static Variables in Inherited Methods #1549)
  • Return Type Compatibility with Internal Classes ([PHP 8.1] Return Type Compatibility with Internal Classes #1560)
• Other Changes
  • ReflectionProperty::setAccessible() and ReflectionMethod::setAccessible() no longer have an effect. (7b6a20e)

Classes

• New classes
  • IntlDatePatternGenerator ([PHP 8.1] Add IntlDatePatternGenerator description #1026)
  • ReflectionIntersectionType ([PHP 8.1] Add ReflectionIntersectionType description #1027)
  • CURLStringFile ([PHP 8.1] Document CURLStringFile #1154)
• Resource to Opaque Object conversions ([PHP 8.1] Resource to Object Migration #972)

Functions/Methods:

• New functions
  • Core
    • array_is_list() ([PHP 8.1] Add array_is_list description #986)
  • Standard
    • fsync() ([PHP 8.1] Add fdatasync and fsync description #1002)
    • fdatasync() ([PHP 8.1] Add fdatasync and fsync description #1002)
  • GD
    • imagecreatefromavif() ([PHP 8.1] Add imageavif and imagecreatefromavif functions #983)
    • imageavif() ([PHP 8.1] Add imageavif and imagecreatefromavif functions #983)
  • MySQLi
    • mysqli_result::fetch_column() (PHP 8.1: Document mysqli_result::fetch_column #776)
  • pcntl_rfork() ([PHP 8.1] Add pcntl_rfork description #1033)
  • ReflectionFunctionAbstract::getClosureUsedVariables() ([PHP 8.1] Add ReflectionFunctionAbstract::getClosureUsedVariables #1032)
  • Sodium
    • XChaCha20
      • sodium_crypto_stream_xchacha20() ([PHP 8.1] Add new sodium functions #1045)
      • sodium_crypto_stream_xchacha20_keygen() ([PHP 8.1] Add new sodium functions #1045)
      • sodium_crypto_stream_xchacha20_xor() ([PHP 8.1] Add new sodium functions #1045)
    • Ristretto255
      • sodium_crypto_core_ristretto255_add() ([PHP 8.1] Add sodium ristretto255 functions #1051)
      • sodium_crypto_core_ristretto255_from_hash() ([PHP 8.1] Add sodium ristretto255 functions #1051)
      • sodium_crypto_core_ristretto255_is_valid_point() ([PHP 8.1] Add sodium ristretto255 functions #1051)
      • sodium_crypto_core_ristretto255_random() ([PHP 8.1] Add sodium ristretto255 functions #1051)
      • sodium_crypto_core_ristretto255_scalar_add() ([PHP 8.1] Add sodium ristretto255 functions #1051)
      • sodium_crypto_core_ristretto255_scalar_complement() ([PHP 8.1] Add sodium ristretto255 functions #1051)
      • sodium_crypto_core_ristretto255_scalar_invert() ([PHP 8.1] Add sodium ristretto255 functions #1051)
      • sodium_crypto_core_ristretto255_scalar_mul() ([PHP 8.1] Add sodium ristretto255 functions #1051)
      • sodium_crypto_core_ristretto255_scalar_negate() ([PHP 8.1] Add sodium ristretto255 functions #1051)
      • sodium_crypto_core_ristretto255_scalar_random() ([PHP 8.1] Add sodium ristretto255 functions #1051)
      • sodium_crypto_core_ristretto255_scalar_reduce() ([PHP 8.1] Add sodium ristretto255 functions #1051)
      • sodium_crypto_core_ristretto255_scalar_sub() ([PHP 8.1] Add sodium ristretto255 functions #1051)
      • sodium_crypto_core_ristretto255_sub() ([PHP 8.1] Add sodium ristretto255 functions #1051)
      • sodium_crypto_scalarmult_ristretto255() ([PHP 8.1] Add sodium ristretto255 functions #1051)
      • sodium_crypto_scalarmult_ristretto255_base() ([PHP 8.1] Add sodium ristretto255 functions #1051)
• Modified functions
  • fputcsv() and SplFileObject::fputcsv() ([PHP 8.1] Update fputcsv and SplFileObject::fputcsv description #978)
  • Hash (WIP) (Update ext/hash documentation #1215 [PHP 8.1] Deprecated functions and constants #981)
  • mysqli_stmt::execute() ([PHP 8.1] Update mysqli_stmt::execute description #987)
• Deprecated
  • ctype: Verifying non-string arguments ([PHP 8.1] Document deprecated ctype non-string argument. #1179)
  • Date
    • date_sunrise() ([PHP 8.1] Deprecated functions and constants #981)
    • date_sunset() ([PHP 8.1] Deprecated functions and constants #981)
    • strptime() ([PHP 8.1] Deprecated functions and constants #981)
    • strftime() (strftime is deprecated since PHP 8.1 #1164)

Constants:

• New
  • POSIX
    • POSIX_RLIMIT_KQUEUES (rlimit constants update related to php 8.0.2 update #436)
    • POSIX_RLIMIT_NPTS (rlimit constants update related to php 8.0.2 update #436)
  • cURL
    • CURLOPT_DOH_URL ([PHP 8.1] Add cURL constants #1039)
    • CURLOPT_ISSUERCERT_BLOB ([PHP 8.1] Add cURL constants #1039)
    • CURLOPT_PROXY_ISSUERCERT ([PHP 8.1] Add cURL constants #1039)
    • CURLOPT_PROXY_ISSUERCERT_BLOB ([PHP 8.1] Add cURL constants #1039)
    • CURLOPT_PROXY_SSLCERT_BLOB ([PHP 8.1] Add cURL constants #1039)
    • CURLOPT_PROXY_SSLKEY_BLOB ([PHP 8.1] Add cURL constants #1039)
    • CURLOPT_SSLCERT_BLOB ([PHP 8.1] Add cURL constants #1039)
    • CURLOPT_SSLKEY_BLOB ([PHP 8.1] Add cURL constants #1039)
  • MySQLI
    • MYSQLI_REFRESH_REPLICA (Add MYSQLI_REFRESH_REPLICA description #1006)
  • Sockets
    • SO_ACCEPTFILTER (socket_get_option/socket_set_option SO_ACCEPTFILTER constant introduc… #656)
    • SO_DONTTRUNC ([PHP 8.1] Add new Sockets constants #1018)
    • SO_WANTMORE ([PHP 8.1] Add new Sockets constants #1018)
    • SO_MARK (socket_get_option/socket_set_option SO_ACCEPTFILTER constant introduc… #656)
    • TCP_DEFER_ACCEPT ([PHP 8.1] Add new Sockets constants #1018)
• Deprecated
  • IMAP
    • NIL ([PHP 8.1] Deprecated functions and constants #981)

[AllenJB]

It's not in the list (probably due to the lack of existing documentation on it!), but I've updated my PR for the FPM status page to include the new openmetrics format: #738

[njames]

Hey there ... I saw this linked from the @php_official twitter and I thought I would love to assist in any way I can but the onboarding of a new documentor is a tad opaque.

I have close this repo and installed phd (updating pear in the process) but the very sparse README is leaving me lost.

Is there "Getting started with being a PHP Documentor for Dummies" link somewhere?

[njames]

After a little more digging I found http://doc.php.net/tutorial/local-setup.php 👍

[Irker]

Hello! Can we add the CurlStringFile to the list?

[saundefined]

Hello! Can we add the CurlStringFile to the list?

Thanks! Done

[mumumu]

Hello! Can we add the CurlStringFile to the list?

Oh. I already added in #1154, sorry... @Irker
I closed #1154, please refer it if you can.

[Irker]

@mumumu No, my message was only about adding CurlStringFile to the TODO list for documentation. So please restore your PR. And thank you!

[mumumu]

@Irker OK, I restored my PR, thank you! Please reveiew #1154 if you would like.

[mallardduck]

I feel like this PR technically is completing documentation that was only done as stubs for PHP 8.0. However I think it'd be worth it to have this PR which documents the ReflectionClass::getAttributes() method in this tracker.

#1539

[kocsismate]

I've removed "Returning a non-array from __sleep()" (#1134) from the list, as it's a PHP 8.0 change (so the migration guide should also be fixed). With all that said, I'm closing the issue as all the tasks are now completed. Congrats to everyone involved!