Update phpdoc-types.md#13659
Update phpdoc-types.md #13659
Conversation
I'm using this page as a reference doc for PHPDoc types, and I was surprised that some types are missing here (according to `TypeNodeResolver.php`).
| `uppercase-string` accepts strings where `strtoupper($string) === $string` is true. There is also non empty version `non-empty-uppercase-string`. | ||
| `__stringandstringable` is any string or object implementing `Stringable` interface or object with a magic `__toString()` method. |
There was a problem hiding this comment.
This is private and undocumented for a reason
There was a problem hiding this comment.
Ok, I understand __stringandstringable - but I saw this type in PHPStan error report, and it was a little bit strange that there is no mention in official documentation about it. What about some "internals" section in the docs?
Can I ask why is private uppercase-string when lowercase-string is documented?
There was a problem hiding this comment.
uppercase-string and lowercase-string are not private, they can be used by users and thus should be documented.
Uh oh!
There was an error while loading. Please reload this page.
| `trait-string` is a string representing a trait. | ||
| `enum-string` is a string representing an enum. |
There was a problem hiding this comment.
I don't want to call much attention to interface-, trait- and enum- because they don't actually enforce the right types
There was a problem hiding this comment.
Ok, the same question as for __stringandstringable - what about some internal/other section, just to have these types mention in the doc?
There was a problem hiding this comment.
The point of internal types is that people should not use them and they should not be documented.
| *`array` | ||
| *`number` (or `numeric`) | ||
| *`scalar`, `non-empty-scalar`, `empty-scalar` | ||
| *`array`, `non-empty-array`, `associative-array` |
There was a problem hiding this comment.
Isn't it weird to consider non-empty-array as a basic type here without explanation, while there is a section for no-empty-string ?
Same question for non-empty-scalar and empty-scalar
There was a problem hiding this comment.
I agree, but I didn't want to start new sections for one or two types. On the other hand, scalar is not PHP type either, and it is mentioned here too.
There was a problem hiding this comment.
Wondering if numeric and other similar union types be documented under the Global type aliases section?
| *`number` | ||
| *`scalar` | ||
| *`array` | ||
| *`number` (or `numeric`) |
There was a problem hiding this comment.
Number and numeric are two different types, they should be on separate lines and explained
| `trait-string` is a string representing a trait. | ||
| `enum-string` is a string representing an enum. |
There was a problem hiding this comment.
The point of internal types is that people should not use them and they should not be documented.
| `uppercase-string` accepts strings where `strtoupper($string) === $string` is true. There is also non empty version `non-empty-uppercase-string`. | ||
| `__stringandstringable` is any string or object implementing `Stringable` interface or object with a magic `__toString()` method. |
There was a problem hiding this comment.
uppercase-string and lowercase-string are not private, they can be used by users and thus should be documented.
4 participants
I'm using this page as a reference doc for PHPDoc types, and I was surprised that some types are missing here (according to
TypeNodeResolver.php).