Add documentation for the Spoofchecker::setRestrictionLevel method
#2792
Conversation
| @@ -308,6 +308,7 @@ | |||
| <function name="spoofchecker::issuspicious" from="PHP 5 >= 5.4.0, PHP 7, PHP 8, PECL intl >= 2.0.0"/> | |||
| <function name="spoofchecker::setallowedlocales" from="PHP 5 >= 5.4.0, PHP 7, PHP 8, PECL intl >= 2.0.0"/> | |||
| <function name="spoofchecker::setchecks" from="PHP 5 >= 5.4.0, PHP 7, PHP 8, PECL intl >= 2.0.0"/> | |||
| <function name="spoofchecker::setrestrictionlevel" from="PHP 7 >= 7.3, PHP 8, PECL intl >= 2.0.0"/> | |||
There was a problem hiding this comment.
I'm not sure for PECL intl >= 2.0.0, where can I know that ?
There was a problem hiding this comment.
You could check the https://github.com/cataphract/PECL-intl source code.
But this is not going to be present in the PECL version, as it has been bundled for a while.
There was a problem hiding this comment.
One possible gotcha that should probably be mentioned is this one: https://github.com/WoltLab/WCF/blob/372e52a4a91eab9872c395d4ed42eaea1d790410/wcfsetup/install/files/lib/system/event/listener/UsernameValidatingCheckCharactersListener.class.php#L48-L55
Calling ->setChecks() after ->setRestrictionLevel() nullifies the restriction level.
(I hope to propose a cleaner API if / when PHP has tagged unions)
|
@TimWolla Do you know where I can found an example of a warning/mention in phpdoc ? I don't know how to add it |
|
doc-en/reference/password/functions/password-hash.xml Lines 133 to 140 in 43f61d4 doc-en/reference/password/functions/password-hash.xml Lines 71 to 77 in 43f61d4 See: https://www.php.net/manual/en/function.password-hash.php |
Hi,
This PR try to document
Spoofchecker::setRestrictionLevelphp-src commit is php/php-src@f56ceb7
It's my first contribution on this repository, tell me if something is wrong 😄