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.

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

donquixote created an issue. See original summary.

ioana apetri’s picture

Status: Active » Needs review
FileSize
695 bytes

As I speak with @donquixote, I created this patch for the documenting the field item properties from this class. I will go to find out other classes which need this kind of updates.

donquixote’s picture

From my side this patch looks good. Thanks @yo30!

I am curious what other people think.

Venkatesh Rajan.J’s picture

Assigned: Unassigned » Venkatesh Rajan.J
Venkatesh Rajan.J’s picture

Assigned: Venkatesh Rajan.J » Unassigned
Status: Needs review » Reviewed & tested by the community
FileSize
22.3 KB

@yo30,

Thanks for the patch. Your patch applied cleanly. PFA screenshots for the same.

Status: Reviewed & tested by the community » Needs work

The last submitted patch, 2: 2901435.patch, failed testing. View results

Ivan Berezhnov’s picture

Issue tags: +CSKyiv18
ioana apetri’s picture

what represents CSKyiv18 tag?:)

donquixote’s picture

Status: Needs work » Needs review

I think this is just a bogus test fail which has nothing to do with this patch.
Queued a re-test.

donquixote’s picture

I imagine CSKyiv18 is an event in Kyiv (Kiev) in Ukraine?

Venkatesh Rajan.J’s picture

Status: Needs review » Reviewed & tested by the community

#2 looks good. Assigning the ticket to RTBC.

larowlan’s picture

Status: Reviewed & tested by the community » Needs work

Hi

I think this is a good idea, but if we're going to do it, we should do it for all field types, not just entity reference.

Thanks

Lee

larowlan’s picture

@Venkatesh Rajan.J, please don't paste screenshots of patches applying, we have automated testing that will tell us that.

Thanks

larowlan’s picture

snehi’s picture

Hi @larolwan can you please just elaborate that for which files you are mentioning to ?

Thanks

Version: 8.5.x-dev » 8.6.x-dev

Drupal 8.5.0-alpha1 will be released the week of January 17, 2018, which means new developments and disruptive changes should now be targeted against the 8.6.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

harsha012’s picture

Status: Needs work » Needs review
FileSize
4.18 KB

Tried to do it for other field type.

hchonov’s picture

Status: Needs review » Needs work

Still only a few of the field items are covered. Try to search by regex in your IDE for namespace(.*)Plugin\\Field\\FieldType and you'll find all the field items in core and in the core modules.

harsha012’s picture

Status: Needs work » Needs review
FileSize
11.09 KB

added the @property to all field type

Version: 8.6.x-dev » 8.7.x-dev

Drupal 8.6.0-alpha1 will be released the week of July 16, 2018, which means new developments and disruptive changes should now be targeted against the 8.7.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.7.x-dev » 8.8.x-dev

Drupal 8.7.0-alpha1 will be released the week of March 11, 2019, which means new developments and disruptive changes should now be targeted against the 8.8.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.8.x-dev » 8.9.x-dev

Drupal 8.8.0-alpha1 will be released the week of October 14th, 2019, which means new developments and disruptive changes should now be targeted against the 8.9.x-dev branch. (Any changes to 8.9.x will also be committed to 9.0.x in preparation for Drupal 9’s release, but some changes like significant feature additions will be deferred to 9.1.x.). For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 8.9.x-dev » 9.1.x-dev

Drupal 8.9.0-beta1 was released on March 20, 2020. 8.9.x is the final, long-term support (LTS) minor release of Drupal 8, which means new developments and disruptive changes should now be targeted against the 9.1.x-dev branch. For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 9.1.x-dev » 9.2.x-dev

Drupal 9.1.0-alpha1 will be released the week of October 19, 2020, which means new developments and disruptive changes should now be targeted for the 9.2.x-dev branch. For more information see the Drupal 9 minor version schedule and the Allowed changes during the Drupal 9 release cycle.

Version: 9.2.x-dev » 9.3.x-dev

Drupal 9.2.0-alpha1 will be released the week of May 3, 2021, which means new developments and disruptive changes should now be targeted for the 9.3.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.3.x-dev » 9.4.x-dev

Drupal 9.3.0-rc1 was released on November 26, 2021, which means new developments and disruptive changes should now be targeted for the 9.4.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.4.x-dev » 9.5.x-dev

Drupal 9.4.0-alpha1 was released on May 6, 2022, which means new developments and disruptive changes should now be targeted for the 9.5.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.5.x-dev » 10.1.x-dev

Drupal 9.5.0-beta2 and Drupal 10.0.0-beta2 were released on September 29, 2022, which means new developments and disruptive changes should now be targeted for the 10.1.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

needs-review-queue-bot’s picture

Status: Needs review » Needs work
FileSize
8.35 KB

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.

_utsavsharma’s picture

Patch for 10.1.x.

Version: 10.1.x-dev » 11.x-dev

Drupal core is moving towards using a “main” branch. As an interim step, a new 11.x branch has been opened, as Drupal.org infrastructure cannot currently fully support a branch named main. New developments and disruptive changes should now be targeted for the 11.x branch, which currently accepts only minor-version allowed changes. For more information, see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.