W3cubDocs

/Drupal 8

public function BaseFieldDefinition::getMainPropertyName

public BaseFieldDefinition::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.

Overrides FieldStorageDefinitionInterface::getMainPropertyName

File

core/lib/Drupal/Core/Field/BaseFieldDefinition.php, line 554

Class

BaseFieldDefinition
A class for defining entity fields.

Namespace

Drupal\Core\Field

Code

public function getMainPropertyName() {
  $class = $this->getFieldItemClass();
  return $class::mainPropertyName();
}

© 2001–2016 by the original authors
Licensed under the GNU General Public License, version 2 and later.
Drupal is a registered trademark of Dries Buytaert.
https://api.drupal.org/api/drupal/core!lib!Drupal!Core!Field!BaseFieldDefinition.php/function/BaseFieldDefinition::getMainPropertyName/8.1.x