class EntityFieldDeriver
Provides entity field block definitions for every field.
Hierarchy
- class \Drupal\Component\Plugin\Derivative\DeriverBase implements \Drupal\Component\Plugin\Derivative\DeriverInterface- class \Drupal\ctools\Plugin\Deriver\EntityDeriverBase implements \Drupal\Core\Plugin\Discovery\ContainerDeriverInterface uses \Drupal\Core\StringTranslation\StringTranslationTrait extends \Drupal\Component\Plugin\Derivative\DeriverBase- class \Drupal\ctools_block\Plugin\Deriver\EntityFieldDeriver extends \Drupal\ctools\Plugin\Deriver\EntityDeriverBase
 
 
- class \Drupal\ctools\Plugin\Deriver\EntityDeriverBase implements \Drupal\Core\Plugin\Discovery\ContainerDeriverInterface uses \Drupal\Core\StringTranslation\StringTranslationTrait extends \Drupal\Component\Plugin\Derivative\DeriverBase
Expanded class hierarchy of EntityFieldDeriver
File
- 
              modules/ctools_block/ src/ Plugin/ Deriver/ EntityFieldDeriver.php, line 11 
Namespace
Drupal\ctools_block\Plugin\DeriverView source
class EntityFieldDeriver extends EntityDeriverBase {
  
  /**
   * {@inheritdoc}
   */
  public function getDerivativeDefinitions($base_plugin_definition) {
    $entity_type_labels = $this->entityTypeRepository
      ->getEntityTypeLabels();
    foreach ($this->entityFieldManager
      ->getFieldMap() as $entity_type_id => $entity_field_map) {
      // Check if entity_type is defined.
      if (!$this->entityTypeManager
        ->hasDefinition($entity_type_id)) {
        continue;
      }
      // Some base fields have no storage.
      /** @var \Drupal\Core\Field\FieldDefinitionInterface[] $field_storage_definitions */
      $field_storage_definitions = array_merge($this->entityFieldManager
        ->getBaseFieldDefinitions($entity_type_id), $this->entityFieldManager
        ->getFieldStorageDefinitions($entity_type_id));
      foreach ($field_storage_definitions as $field_storage_definition) {
        $field_name = $field_storage_definition->getName();
        // The blocks are based on fields. However, we are looping through field
        // storages for which no fields may exist. If that is the case, skip
        // this field storage.
        if (!isset($entity_field_map[$field_name])) {
          continue;
        }
        $field_info = $entity_field_map[$field_name];
        $derivative_id = $entity_type_id . ":" . $field_name;
        // Get the admin label for both base and configurable fields.
        if ($field_storage_definition->isBaseField()) {
          $admin_label = $field_storage_definition->getLabel();
        }
        else {
          // We take the field label used on the first bundle.
          $first_bundle = reset($field_info['bundles']);
          $bundle_field_definitions = $this->entityFieldManager
            ->getFieldDefinitions($entity_type_id, $first_bundle);
          // The field storage config may exist, but it's possible that no
          // fields are actually using it. If that's the case, skip to the next
          // field.
          if (empty($bundle_field_definitions[$field_name])) {
            continue;
          }
          $admin_label = $bundle_field_definitions[$field_name]->getLabel();
        }
        // Set plugin definition for derivative.
        $derivative = $base_plugin_definition;
        $derivative['category'] = $this->t('@entity', [
          '@entity' => $entity_type_labels[$entity_type_id],
        ]);
        $derivative['admin_label'] = $admin_label;
        $derivative['context_definitions'] = [
          'entity' => new EntityContextDefinition('entity:' . $entity_type_id, $entity_type_labels[$entity_type_id], TRUE),
        ];
        $this->derivatives[$derivative_id] = $derivative;
      }
    }
    return $this->derivatives;
  }
}Members
| Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides | 
|---|---|---|---|---|---|
| DeriverBase::$derivatives | protected | property | List of derivative definitions. | 1 | |
| DeriverBase::getDerivativeDefinition | public | function | Gets the definition of a derivative plugin. | Overrides DeriverInterface::getDerivativeDefinition | |
| EntityDeriverBase::$entityFieldManager | protected | property | The entity field manager. | ||
| EntityDeriverBase::$entityTypeManager | protected | property | The entity type manager. | ||
| EntityDeriverBase::$entityTypeRepository | protected | property | The entity type repository. | ||
| EntityDeriverBase::create | public static | function | Creates a new class instance. | Overrides ContainerDeriverInterface::create | |
| EntityDeriverBase::__construct | public | function | Constructs new EntityViewDeriver. | ||
| EntityFieldDeriver::getDerivativeDefinitions | public | function | Gets the definition of all derivatives of a base plugin. | Overrides DeriverBase::getDerivativeDefinitions | |
| StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | 3 | |
| StringTranslationTrait::formatPlural | protected | function | Formats a string containing a count of items. | ||
| StringTranslationTrait::getNumberOfPlurals | protected | function | Returns the number of plurals supported by a given language. | ||
| StringTranslationTrait::getStringTranslation | protected | function | Gets the string translation service. | ||
| StringTranslationTrait::setStringTranslation | public | function | Sets the string translation service to use. | 2 | |
| StringTranslationTrait::t | protected | function | Translates a string to the current language or to a given language. | 
