Account for changes introduced in PHP 8.6

[jrfnl]

This is just an issue to keep track of which of the implemented RFCs for PHP 8.6 have been addressed.

This list should be updated when additional RFCs are accepted/implemented.

To Do

• Stream Error Handling Improvements
  Note: the classes/enums/function etc are addressed via PR #.... Still needs evaluation whether the new stream error context options are sniffable.
• Allow Object Property Writes on Objects Referenced by Constants
• Limit maximum number of filter chains
• Add Locale::getDisplayKeyword and Locale::getDisplayKeywordValue functions
  Note: the procedural functions have been addressed via PR #.... The OO methods still needs detecting.
• Secure Session Configuration Defaults
• DocComments For Function Parameters
• isReadable/Writeable Reflection methods
• New function mysqli_quote_string
  Note: the procedural function has been addressed via PR #.... The OO method still needs detecting.
• TLS Session Resumption Support for Streams
  Note: the classes are addressed via PR #.... Still needs evaluation whether the new stream context options are sniffable.
• Closure optimizations
• Readonly Property Defaults
• SNMP improvements for encryption protocols, mib reset, and controlling output
• Deprecations for PHP 8.6
  Note: these may not all be fully implemented yet! PRs to detect the deprecation will only be accepted after the deprecation has been merged into PHP Core.
  Sublist:
  • Deprecate using certain names as identifiers to reserve them as keywords
    • Deprecate using “let” as an identifier
    • Deprecate using “is” as an identifier
    • Deprecate using “_” as a constant and compile time alias
  • Passing objects which are interpreted as arrays
    • Passing objects for $array parameter of array_walk() and array_walk_recursive() - PR - commit
    • Passing objects for $options parameter of deflate_init() and inflate_init() - PR - commit
    • Passing objects as parameters to the zlib.inflate and zlib.deflate stream filters - PR - commit
    • Passing objects as parameters to the bzip2.decompress and bzip2.compress stream filters - PR - commit
    • Passing objects for $vars parameter of mb_convert_variables() - PR - commit
    • Passing objects for $data parameter of http_build_query() - PR - commit
  • Deprecate is_subclass_of with string when $allow_string is false
  • Deprecate is_a with string when $allow_string is false
  • Deprecate ReflectionProperty::setValue() and ReflectionProperty::setRawValue() with wrong types - PR - commit + commit
  • Deprecate ReflectionMethod::invoke() and ReflectionMethod::invokeArgs() with objects for static methods - PR - commit
  • Deprecate ArrayIterator methods that inherit ArrayObject implementation - PR - commit
  • Deprecate SplFileObject CSV methods - PR - commit
  • Deprecate mysqli::stmt_init() - PR - commit
    Note: the procedural function has been addressed via PR #.... The OO method + constructor signature still needs detecting.
  • Deprecate mysqli_get_charset() - PR - commit
    Note: the procedural function has been addressed via PR #.... The OO method still needs detecting.
  • Deprecate passing a $sessionhandler object to session_set_save_handler() which does not contain the create_sid() and validateId() methods - PR - commit

Aside from the RFCs, there are also the changes which were made outside of the RFC process and are listed in:

• The PHP 8.6 Upgrading guide.
• The PHP 8.5 to 8.6 Migration guide (once available)
• PHP 8.6 NEWS/Changelog
• Changelog

Claimed

• Add pack()/unpack() endianness modifiers for floating-point numbers
  Status: Ready to be pulled.
  Owner: @jrfnl
• Add pack()/unpack() support for endianness modifiers on integers
  Status: Ready to be pulled.
  Owner: @jrfnl
• Stream Error Handling Improvements
  Status: Ready to be pulled for the classes, functions, params. Still needs evaluation whether the new stream error context options are sniffable.
  Owner: @jrfnl
• Deprecate returning values from __construct() and __destruct()
  Status: Ready to be pulled.
  Owner: @jrfnl
• #[\Override] for class constants
  Status: TODO / needs a good think, see Further improve attribute detection/flagging #1935
  Owner: @jrfnl
• Add Locale::getDisplayKeyword and Locale::getDisplayKeywordValue functions
  Status: Ready to be pulled for the procedural functions.
  Owner: @jrfnl
• Polling API
  Status: WIP, including updates via upcoming new NewEnums sniff.
  Owner: @jrfnl
• Debugable Enums
  Status: Ready to be pulled.
  Owner: @jrfnl
• Oniguruma maintenance end and end of mbregex
  Status: Ready to be pulled.
  Owner: @jrfnl
• enum SortDirection
  Status: WIP via upcoming new NewEnums sniff.
  Owner: @jrfnl
• Add Form Feed in Trim Functions
  Status: Ready to be pulled.
  Owner: @jrfnl
• grapheme_strrev: strrev for grapheme cluster
  Status: Ready to be pulled.
  Owner: @jrfnl
• Add "clamp()" function
  Status: Ready to be pulled.
  Owner: @jrfnl
• New function mysqli_quote_string
  Status: Ready to be pulled for the procedural function.
  Owner: @jrfnl
• TLS Session Resumption Support for Streams
  Status: Ready to be pulled for the classes. Still needs evaluation whether the new stream context options are sniffable.
  Owner: @jrfnl
• Display Function Arguments in Errors
  Status: Ready to be pulled. We may also want to investigate whether a useful detection can be set up for custom error handlers which would be impacted via set_error_handler.
  Owner: @jrfnl
• Partial Function Application, v2
  • Partial Function Application: Handling of Optional Parameters
    Status: Needs tokenizer support in PHPCS
    Owner: @jrfnl
• Duration class
  Status: Ready to be pulled.
  Owner: @jrfnl
• Deprecations for PHP 8.6
  Sublist:
  • Deprecate returning from a finally block - PR - commit
    Status: Ready to be pulled.
    Owner: @jrfnl
  • Deprecate using certain names as identifiers to reserve them as keywords
    • Deprecate using “namespace” as a class constant name - PR - commit
      Status: Ready to be pulled.
      Owner: @jrfnl
    • Deprecate the possibility to name a function “readonly” - PR - commit
      Status: Ready to be pulled.
      Owner: @jrfnl
  • Deprecate function aliases with non-canonical type name
    Status: Ready to be pulled.
    Owner: @jrfnl
    • Deprecate is_double(), an alias of is_float() - PR - commit
    • Deprecate is_integer(), an alias of is_int() - PR - commit
    • Deprecate is_long(), an alias of is_int() - PR - commit
    • Deprecate doubleval(), an alias of floatval() - PR - commit
  • Deprecate strcoll() - PR - commit
    Status: Ready to be pulled.
    Owner: @jrfnl
  • Deprecate SORT_LOCALE_STRING flag for sort() functions - PR - commit
    Status: Ready to be pulled.
    Owner: @jrfnl
  • Deprecate metaphone function - PR - commit
    Status: Ready to be pulled.
    Owner: @jrfnl
  • Deprecate spl_classes() - PR - commit
    Status: Ready to be pulled.
    Owner: @jrfnl
  • Deprecate spl_object_hash - PR - commit
    Status: Ready to be pulled.
    Owner: @jrfnl
  • Deprecate mysqli::stmt_init() - PR - commit
    Status: Ready to be pulled for the procedural function.
    Owner: @jrfnl
  • Deprecate mysqli_get_charset() - PR - commit
    Status: Ready to be pulled for the procedural function.
    Owner: @jrfnl

Additionally, an initial scan of the UPGRADING file for additional list-based updates to be made is ongoing and owned by @jrfnl.

Has PR

Nothing yet

Reviewed and concluded non-sniffable

• Deprecations for PHP 8.6
  Sublist:
  • Deprecate define() with $case_insensitive being specified - PR - commit
    Reviewed by @jrfnl and concluded there's nothing to do here for PHPCompatibility.
    "This appears to be a correction to the implementation of the removal of support for case-sensitive constants in PHP 8.0 as previously deprecated in PHP 7.3.
    In my opinion, this is an irrelevant implementation error on the side of PHP and the actual removal of support for case-sensitive constants is what PHPCompatibility should flag and already does via the RemovedFunctionParameters sniff."
    Relevant PHPCompatibility PRs: PHP 7.3: DeprecatedFunctionParameters: account for change to define() #706 and PHP 8.0: RemovedFunctionParameters: handle removed parameter x 3 #1185

Rejected RFCs

• Deprecations for PHP 8.6
  Sublist:
  • Deprecate the list() construct RFC rejected
  • Deprecate using certain names as identifiers to reserve them as keywords
    • Deprecate using “in”, “out”, and “inout” as identifiers RFC rejected
    • Deprecate using “_” as a function name and the _() function alias for gettext() RFC rejected
  • Deprecate dechunk filter RFC rejected

Delayed to later PHP version

Nothing yet

Status yet to be determined

These are RFCs which have either not yet been implemented or are still in voting at this time.
Once their final status for PHP 8.6 is determined, they will either be moved to the "To Do" list or removed from this ticket.

Accepted, not yet (fully) implemented

• Minimum supported versions for PHP 8.6
  Already reviewed by @jrfnl and concluded there's nothing to do here for PHPCompatibility.
• Followup Improvements for ext/uri
• Deprecations for PHP 8.6
  Sublist:
  • Deprecate using certain names as identifiers to reserve them as keywords
    • Deprecate using “let” as an identifier
    • Deprecate using “is” as an identifier
    • Deprecate using “_” as a constant and compile time alias
  • Deprecate is_subclass_of with string when $allow_string is false
  • Deprecate is_a with string when $allow_string is false

In voting

All votes have been closed

Process

If anyone starts work on updating PHPCompatibility to handle any of these issues, please either update the above list (if you can) or leave a comment below, so one of the maintainers can update the list.

Once PHP 8.6 comes out, individual issues should be opened for the changes which remain at that point in time.

Guidelines

• When in doubt how to address something and/or if your approach is the right one: ask.
  This also means that it is perfectly acceptable to open an dedicated issue to discuss a particular change in more detail.
• PRs which address RFCs should only contain the changes for one RFC per PR. One RFC may warrant multiple PRs depending on the nature of the changes.
  Exception: when a RFC builds onto a previous RFC, combining the necessary changes into one PR addressing the cumulative changes to PHP is fine.
• PRs not directly related to RFCs may address multiple changes in one go, as long as the changes are logically closely related (like adding a range of new constants to be detected).
• Please include relevant change justification and links in each commit message.
  Typically this means that a commit message should include:
  • Text snippet from the PHP UPGRADING guide/changelog/migration guide or the RFC to back up the change being made.
  • A link to the RFC (if applicable).
  • A link to the exact UPGRADING guide/changelog/migration guide section which documents the change in PHP Core.
  • A link to the PR to PHP Core which proposed the change (if applicable).
  • A link to the commit which added the change to PHP Core.
• Changes which were proposed/accepted for PHP, but have not been merged into PHP Core yet, should not be detected by PHPCompatibility (yet).
  The commit to PHP Core should always come first, PHPCompatibility follows.