function ComplexDataDefinitionInterface::getMainPropertyName

Same name in other branches
  1. 9 core/lib/Drupal/Core/TypedData/ComplexDataDefinitionInterface.php \Drupal\Core\TypedData\ComplexDataDefinitionInterface::getMainPropertyName()
  2. 10 core/lib/Drupal/Core/TypedData/ComplexDataDefinitionInterface.php \Drupal\Core\TypedData\ComplexDataDefinitionInterface::getMainPropertyName()
  3. 11.x core/lib/Drupal/Core/TypedData/ComplexDataDefinitionInterface.php \Drupal\Core\TypedData\ComplexDataDefinitionInterface::getMainPropertyName()

Returns the name of the main property, if any.

Some field items consist mainly of one main property, e.g. the value of a text field or the 

target_id;

of an entity reference. If the field item has no main property, the method returns NULL.

Return value

string|null The name of the value property, or NULL if there is none.

2 methods override ComplexDataDefinitionInterface::getMainPropertyName()
ComplexDataDefinitionBase::getMainPropertyName in core/lib/Drupal/Core/TypedData/ComplexDataDefinitionBase.php
Returns the name of the main property, if any.
FieldItemDataDefinition::getMainPropertyName in core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php
Returns the name of the main property, if any.

File

core/lib/Drupal/Core/TypedData/ComplexDataDefinitionInterface.php, line 44

Class

ComplexDataDefinitionInterface
Interface for complex data definitions.

Namespace

Drupal\Core\TypedData

Code

public function getMainPropertyName();

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.