Issue #2336101 by benjy, chx: Add @property declarations to field types.
Entity classes (for example Drupal\node\Entity\Node) do not have any of the fields (for example title) added as a class property. This is impossible anyways because some fields might be configurable fields. So, in any IDE, even if you know a certain object is a Node entity, you can't autocomplete for $node->. phpdoc uses @property to resolve this exact situation. Further, even if you have a
module →
that generates the @property definitions for a certain node type, you still can't autocomplete in $node->title-> because the field item classes also need @property on them. The latter is added by the patch in the issue.
If we adopted this change, the Drupal Project would benefit by ...
Provide all proposed changes to the Drupal Coding standards → . Give a link to each section that will be changed, and show the current text and proposed text as in the following layout:
There is no text fof '@property'
Add the following after @param: Function parameters.
@property: Dynamic properties
The @property tag is used to document properties made available via __get, which are not class member variables. One example is the base field 'title' of the Node entity. The Node entity class does not declare the 'title' property but you can access $node->title as if there was one.
Example:
* @property \Drupal\Core\Field\FieldItemList title * The title of the node. * @property \Drupal\Core\Field\FieldItemList nid * The nid of the node.
For a full explanation of these steps see the Coding Standards project page →
Needs review
Coding Standards
It involves compliance with, or the content of coding standards. Requires broad community agreement.
Enhances developer experience.
Issue summaries save everyone time if they are kept up-to-date. See Update issue summary task instructions.
Not all content is available!
It's likely this issue predates Contrib.social: some issue and comment data are missing.
Revisiting this - phpstan drupal is adding these via stubs but I think it would make more sense for them to be in the codebase instead.
Tagging for an update to the new coding standards issue summary
Convert to the new template.
if accepted this will need an issue in the API project.
I think the new text needs work, the second sentence is a bit complex. And I think the example needs more context,