PHP 8.0 documentation tracker

[Girgias]

Pages which need to be added/modified for complete documentation of PHP 8.0:

Based of the migration guide: https://www.php.net/manual/en/migration80.php (formally #170)

Core:

• New features:
  • Type declarations (Split type declaration into its own page #174)
    • Union types
    • mixed
    • static return
  • Constructor Promotion (Overhaul constructor page, including PHP 8 promotion. #188)
  • match expressions (Add match expression page #206)
    • UnhandledMatchError
  • Named arguments allow passing arguments to a function based on the parameter name, rather than the parameter position. (Document named arguments #251)
  • Attributes (Add chapter on Attributes in language section. #254)
  • Null-safe operator (Add nullsafe arrow. #244)
  • Stringable interface (Stringable #478)
  • WeakMap (core) (Describe WeakMaps. #479)
  • $object::class (Document the ::class constant on objects. #239)
  • Catch without variable (Exception updates #238)
  • traits can now have abstract private methods and they are validated against the implementation provided in the using class, according to our usual inheritance rules. (Note that all visibilities of trait abstract methods are supported. #476)
  • ValueError (Add ValueError page #205)
  • DateTime format specifier p (Document p date formatter code. #230)
• Modified features:
  • throw expression (Exception updates #238)
  • &new; and &instanceof; can now be used with arbitrary expressions
  • trailing commas in parameter lists (Function trailing commas #241)
  • private methods do not enforce inheritance rules on child classes any more (except __construct) (Note changes in how private methods inherit. #481)
  • Numeric strings (Add an appendix about numeric strings #215)
    • Comparison
    • When a string is considered numeric
  • Float to string conversion (Add an appendix about numeric strings #215)
  • Operator precedence
    • Concatenation (011596b)
• Deprecated
  • Optional args after mandatory ones (Document named arguments #251, fixed description about passing [mandatory|optional] parameter order. #270)
  • The ability to define case-insensitive constants has been removed. The third argument to define() may no longer be true.

Classes

• New classes
  • Tokenizer: PhpToken (Add PhpToken reference #272)
  • DOM
    • DOMParentNode ([PHP 8.0] Add new DOM interfaces #1025)
    • DOMChildNode ([PHP 8.0] Add new DOM interfaces #1025)
• Resource to Opaque Object conversions:
  • CurlHandle (5f8047c)
  • CurlMultiHandle (5f8047c)
  • CurlShareHandle (5f8047c)
  • EnchantBroker (5f8047c)
  • EnchantDictionary (5f8047c)
  • GdImage (5f8047c)
  • OpenSSLCertificate (5f8047c)
  • OpenSSLCertificateSigningRequest (5f8047c)
  • OpenSSLAsymmetricKey (5f8047c)
  • Shmop (5f8047c)
  • Socket (5f8047c)
  • AddressInfo (5f8047c)
  • SysvMessageQueue ([PHP 8.0] Add Semaphore opaque classes #1020)
  • SysvSemaphore ([PHP 8.0] Add Semaphore opaque classes #1020)
  • SysvSharedMemory ([PHP 8.0] Add Semaphore opaque classes #1020)
  • XmlParser (5f8047c)
  • XMLWriter (c31630c)
  • InflateContext (5f8047c)
  • DeflateContext (5f8047c)
• Renamed classes (OCI8 class renaming for PHP 8 #246)
  • OCI-Lob to OCILob
  • OCI-Collection to OCICollection

Functions/Methods:

• New functions
  • Standard
    • fdiv() (Add fdiv() #258)
    • get_debug_type() (Help page for get_debug_type #591)
    • get_resource_id() (Added documentation for the get_resource_id function #227)
    • str_contains() (Added documentation for the str_contains #216)
    • str_start_with() (Documentation for str_starts_with and str_ends_with #217)
    • str_ends_with() (Documentation for str_starts_with and str_ends_with #217)
  • Date and Time
    • DateTime::createFromInterface() (Add createFromInterface() for DateTime objects. #257)
    • DateTimeImmutable::createFromInterface() (Add createFromInterface() for DateTime objects. #257)
  • GD
    • imagegetinterpolation() (0ebd26c)
  • LDAP
    • ldap_count_references() (Fix ldap functions description #733)
  • OpenSSL (ad0175b)
    • openssl_cms_encrypt()
    • openssl_cms_decrypt()
    • openssl_cms_read()
    • openssl_cms_sign()
    • openssl_cms_verify()
  • ZIP
    • ZipArchive::setProgressCallback() (rename misspelled methods #228)
    • ZipArchive::setCancelCallback() (rename misspelled methods #228)
• Modified functions
  • printf and friends (Add new string format codes. #268)
  • imagepolygon and friends (de8b75c)
• Deprecated
  • PGSQL aliases (7a81e2b)
  • Enchant (94f2c27)
    • enchant_broker_set_dict_path()
    • enchant_broker_get_dict_path()
    • enchant_dict_add_to_personal()
    • enchant_broker_free()
  • libxml_disable_entity_loader()
  • Procedural ZIP API (e727888)
  • Reflection
    • ReflectionFunction::isDisabled()
    • ReflectionParameter::getClass()
    • ReflectionParameter::isArray()
    • ReflectionParameter::isCallable()

Constants:

• New
  • Filter
    • FILTER_VALIDATE_BOOL (Add FILTER_VALIDATE_BOOL alias to docs #676)
  • Intl
    • IntlDateFormatter::RELATIVE_FULL (Add new IntlDateFormatter constants. #267)
    • IntlDateFormatter::RELATIVE_LONG (Add new IntlDateFormatter constants. #267)
    • IntlDateFormatter::RELATIVE_MEDIUM (Add new IntlDateFormatter constants. #267)
    • IntlDateFormatter::RELATIVE_SHORT (Add new IntlDateFormatter constants. #267)
  • Reflection (98df2cf)
    • ReflectionClassConstant::IS_PUBLIC
    • ReflectionClassConstant::IS_PROTECTED
    • ReflectionClassConstant::IS_PRIVATE
  • OpenSSL (1ae5ae9)
    • OPENSSL_ENCODING_DER
    • OPENSSL_ENCODING_SMIME
    • OPENSSL_ENCODING_PEM
• Deprecated
  • Enchant (94f2c27)
    • ENCHANT_MYSPELL
    • ENCHANT_ISPELL
  • PGSQL_LIBPQ_VERSION_STR (fa7cb18)

[TysonAndre]

traits can now have abstract methods

That should say "abstract trait methods are validated against the implementation provided in the using class, according to our usual inheritance rules." and "traits can now have abstract private methods"

https://wiki.php.net/rfc/abstract_trait_method_validation

named params

named arguments - "Named arguments allow passing arguments to a function based on the parameter name, rather than the parameter position."

The php 8 migration docs in the linked pr seem to be correct

[Girgias]

traits can now have abstract methods

That should say "abstract trait methods are validated against the implementation provided in the using class, according to our usual inheritance rules." and "traits can now have abstract private methods"

https://wiki.php.net/rfc/abstract_trait_method_validation

named params

named arguments - "Named arguments allow passing arguments to a function based on the parameter name, rather than the parameter position."

The php 8 migration docs in the linked pr seem to be correct

This rather a tracker and not an accurate description of the features, but will modify them

[emmanix2002]

@Girgias I'd like to help with adding the docs for a few of the new strig functions

[Girgias]

@Girgias I'd like to help with adding the docs for a few of the new strig functions

The best way to do that is to fork https://github.com/php/doc-en/ and then to base the documentation on the strpos() function which is located here: https://github.com/php/doc-en/blob/master/reference/strings/functions/stripos.xml

[matthewtrask]

@Girgias I'll take a shot at the $object::class docs.

[jrfnl]

To add to the update list:

• Update the function signatures of all functions and methods where parameters have been renamed in anticipation of named parameters. (as otherwise people won't know what parameter names to use for PHP native functions)
• Where relevant, update the function signatures of all functions and methods where type declarations have been added or have been changed.
  In the case of changed: including adding a changelog entry to the function page.

[Girgias]

To add to the update list:

* [ ]  Update the function signatures of all functions and methods where parameters have been renamed in anticipation of named parameters. (as otherwise people won't know what parameter names to use for PHP native functions)

* [ ]  Where relevant, update the function signatures of all functions and methods where type declarations have been added or have been changed.
  In the case of _changed_: including adding a changelog entry to the function page.

This is already handled "internally" by us as @kocsismate is running a script to update the docs based on the official stubs and I'm confident he's tracking which extensions have already been covered.

My intent with this issue tracker is to track changes which don't need to be done in bulk, as those would be rather painful to do manually.

So I can add them, but I'm not sure it makes a lot of sense as I don't want someone to attempt to do this specific part.

[jrfnl]

@Girgias Happy to hear this will be handled via a script and totally understand not adding it to the list in that case. Kudos to @kocsismate.

Just figured I'd mention it as I already ran into this - case in point: the example code in the Named Arguments RFC for array_fill() will no longer work as $num has been renamed to $count ;-)

[kocsismate]

And thanks to cmb, there is already a tracker for the function signature updates in the manual: https://github.com/php/doc-en/labels/methodsynopses

[emmanix2002]

@Girgias I'd like to help with adding the docs for a few of the new strig functions

The best way to do that is to fork https://github.com/php/doc-en/ and then to base the documentation on the strpos() function which is located here: https://github.com/php/doc-en/blob/master/reference/strings/functions/stripos.xml

Thanks

[emmanix2002]

@Girgias opened PR for str_contains here: #216

[50bhan]

Is there any guidelines about how to write proper docs for PHP?

[emmanix2002]

@50bhan I simply followed the instructions in the repo's README to understand set up and you can look at the review comments on my first PR to understand some of the things to watch out for.

#216

[cmb69]

There is a small tutorial for doc contributors. PRs to improve that tutorial are also welcome!

[emmanix2002]

Any suggestions for the preferred directory for the get_resource_id() and get_debug_type() documentation reference?