Document field item properties with @property doc

Created on 11 August 2017, almost 7 years ago

Updated 2 February 2023, over 1 year ago

Field item properties can be accessed via magic method.
This is thanks to FieldItemBase::__get().

IMO, magic __get() is only useful if the IDE can determine the return type.

Fortunately this is easy to achieve. E.g. like this on EntityReferenceItem:

namespace Drupal\Core\Field\Plugin\Field\FieldType;
[..]
/**
[..]
 *
 * @property string|int $target_id
 * @property EntityInterface $entity
 */
class EntityReferenceItem [..] {

There are probably more magic __get() in other places. But for this issue let us focus on field items.

📌 Task

Status

Needs work

Version

10.1 ✨

Component

Field →

Last updated about 12 hours ago

Maintained by
🇷🇴Romania @amateescu

Created by

🇩🇪Germany donquixote

Live updates comments and jobs are added and updated live.

Novice
It would make a good project for someone who is new to the Drupal contribution process. It's preferred over Newbie.

CSKyiv18

Incomplete comments

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

Comment over 1 year ago →
needs-review-queue-bot
The Needs Review Queue Bot → tested this issue. It either no longer applies to Drupal core, or fails the Drupal core commit checks. Therefore, this issue status is now "Needs work".

Apart from a re-roll or rebase, this issue may need more work to address feedback in the issue or MR comments. To progress an issue, incorporate this feedback as part of the process of updating the issue. This helps other contributors to know what is outstanding.

Consult the Drupal Contributor Guide → to find step-by-step guides for working with issues.
Comment over 1 year ago →
🇮🇳India _utsavsharma
Patch for 10.1.x.

contrib.social Blog FAQ Discussions

Production build 0.69.0 2024