3 namespace Drupal\views;
5 use Drupal\Core\Field\BaseFieldDefinition;
8 * A trait containing helper methods for field definitions.
10 trait FieldAPIHandlerTrait {
13 * The field definition.
15 * @var \Drupal\Core\Field\FieldDefinitionInterface
17 protected $fieldDefinition;
20 * The field storage definition.
22 * @var \Drupal\field\FieldStorageConfigInterface
24 protected $fieldStorageDefinition;
27 * Gets the field definition.
29 * A View works on an entity type across bundles, and thus only has access to
30 * field storage definitions. In order to be able to use widgets and
31 * formatters, we create a generic field definition out of that storage
34 * @see BaseFieldDefinition::createFromFieldStorageDefinition()
36 * @return \Drupal\Core\Field\FieldDefinitionInterface
37 * The field definition used by this handler.
39 protected function getFieldDefinition() {
40 if (!$this->fieldDefinition) {
41 $field_storage_config = $this->getFieldStorageDefinition();
42 $this->fieldDefinition = BaseFieldDefinition::createFromFieldStorageDefinition($field_storage_config);
44 return $this->fieldDefinition;
48 * Gets the field storage configuration.
50 * @return \Drupal\field\FieldStorageConfigInterface
51 * The field storage definition used by this handler
53 protected function getFieldStorageDefinition() {
54 if (!$this->fieldStorageDefinition) {
55 $field_storage_definitions = $this->getEntityManager()->getFieldStorageDefinitions($this->definition['entity_type']);
56 $this->fieldStorageDefinition = $field_storage_definitions[$this->definition['field_name']];
58 return $this->fieldStorageDefinition;
62 * Returns the entity manager.
64 * @return \Drupal\Core\Entity\EntityManagerInterface
65 * The entity manager service.
67 protected function getEntityManager() {
68 if (!isset($this->entityManager)) {
69 $this->entityManager = \Drupal::entityManager();
71 return $this->entityManager;