function FieldAPIHandlerTrait::getFieldDefinition

Same name and namespace in other branches
  1. 11.x core/modules/views/src/FieldAPIHandlerTrait.php \Drupal\views\FieldAPIHandlerTrait::getFieldDefinition()

Gets the field definition.

A View works on an entity type across bundles, and thus only has access to field storage definitions. In order to be able to use widgets and formatters, we create a generic field definition out of that storage definition.

Return value

\Drupal\Core\Field\FieldDefinitionInterface The field definition used by this handler.

See also

BaseFieldDefinition::createFromFieldStorageDefinition()

File

core/modules/views/src/FieldAPIHandlerTrait.php, line 46

Class

FieldAPIHandlerTrait
A trait containing helper methods for field definitions.

Namespace

Drupal\views

Code

protected function getFieldDefinition() {
  if (!$this->fieldDefinition) {
    $field_storage_config = $this->getFieldStorageDefinition();
    $this->fieldDefinition = BaseFieldDefinition::createFromFieldStorageDefinition($field_storage_config);
  }
  return $this->fieldDefinition;
}

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