public function BaseFieldDefinition::getMainPropertyName in Drupal 8

Same name and namespace in other branches

1. 9 core/lib/Drupal/Core/Field/BaseFieldDefinition.php \Drupal\Core\Field\BaseFieldDefinition::getMainPropertyName()
2. 10 core/lib/Drupal/Core/Field/BaseFieldDefinition.php \Drupal\Core\Field\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

3 calls to BaseFieldDefinition::getMainPropertyName()

BaseFieldDefinition::getDefaultValue in core/lib/Drupal/Core/Field/BaseFieldDefinition.php

Returns the default value for the field in a newly created entity.

BaseFieldDefinition::getInitialValue in core/lib/Drupal/Core/Field/BaseFieldDefinition.php

Returns the initial value for the field.

BaseFieldDefinition::setInitialValue in core/lib/Drupal/Core/Field/BaseFieldDefinition.php

Sets an initial value for the field.

File

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

Class

BaseFieldDefinition

A class for defining entity fields.

Namespace

Drupal\Core\Field

Code

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