class FieldConfigListBuilder

Same name in other branches
  1. 9 core/modules/field_ui/src/FieldConfigListBuilder.php \Drupal\field_ui\FieldConfigListBuilder
  2. 8.9.x core/modules/field_ui/src/FieldConfigListBuilder.php \Drupal\field_ui\FieldConfigListBuilder
  3. 11.x core/modules/field_ui/src/FieldConfigListBuilder.php \Drupal\field_ui\FieldConfigListBuilder

Provides lists of field config entities.

Hierarchy

Expanded class hierarchy of FieldConfigListBuilder

File

core/modules/field_ui/src/FieldConfigListBuilder.php, line 19

Namespace

Drupal\field_ui
View source
class FieldConfigListBuilder extends ConfigEntityListBuilder {
    
    /**
     * The name of the entity type the listed fields are attached to.
     *
     * @var string
     */
    protected $targetEntityTypeId;
    
    /**
     * The name of the bundle the listed fields are attached to.
     *
     * @var string
     */
    protected $targetBundle;
    
    /**
     * The entity type manager.
     *
     * @var \Drupal\Core\Entity\EntityTypeManagerInterface
     */
    protected $entityTypeManager;
    
    /**
     * The field type plugin manager.
     *
     * @var \Drupal\Core\Field\FieldTypePluginManagerInterface
     */
    protected $fieldTypeManager;
    
    /**
     * The entity field manager.
     *
     * @var \Drupal\Core\Entity\EntityFieldManagerInterface
     */
    protected $entityFieldManager;
    
    /**
     * Constructs a new class instance.
     *
     * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
     *   The entity type definition.
     * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
     *   The entity type manager.
     * @param \Drupal\Core\Field\FieldTypePluginManagerInterface $field_type_manager
     *   The field type manager.
     * @param \Drupal\Core\Entity\EntityFieldManagerInterface|null $entity_field_manager
     *   The entity field manager.
     */
    public function __construct(EntityTypeInterface $entity_type, EntityTypeManagerInterface $entity_type_manager, FieldTypePluginManagerInterface $field_type_manager, EntityFieldManagerInterface $entity_field_manager) {
        parent::__construct($entity_type, $entity_type_manager->getStorage($entity_type->id()));
        $this->entityTypeManager = $entity_type_manager;
        $this->fieldTypeManager = $field_type_manager;
        $this->entityFieldManager = $entity_field_manager;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
        return new static($entity_type, $container->get('entity_type.manager'), $container->get('plugin.manager.field.field_type'), $container->get('entity_field.manager'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function render($target_entity_type_id = NULL, $target_bundle = NULL) {
        $this->targetEntityTypeId = $target_entity_type_id;
        $this->targetBundle = $target_bundle;
        $build = parent::render();
        $build['table']['#attributes']['id'] = 'field-overview';
        $build['table']['#empty'] = $this->t('No fields are present yet.');
        $build['#attached']['library'][] = 'field_ui/drupal.field_ui';
        return $build;
    }
    
    /**
     * {@inheritdoc}
     */
    public function load() {
        $entities = array_filter($this->entityFieldManager
            ->getFieldDefinitions($this->targetEntityTypeId, $this->targetBundle), function ($field_definition) {
            return $field_definition instanceof FieldConfigInterface;
        });
        // Sort the entities using the entity class's sort() method.
        // See \Drupal\Core\Config\Entity\ConfigEntityBase::sort().
        uasort($entities, [
            $this->entityType
                ->getClass(),
            'sort',
        ]);
        return $entities;
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildHeader() {
        $header = [
            'label' => $this->t('Label'),
            'field_name' => [
                'data' => $this->t('Machine name'),
                'class' => [
                    RESPONSIVE_PRIORITY_MEDIUM,
                ],
            ],
            'settings_summary' => $this->t('Field type'),
        ];
        return $header + parent::buildHeader();
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildRow(EntityInterface $field_config) {
        
        /** @var \Drupal\field\FieldConfigInterface $field_config */
        $field_storage = $field_config->getFieldStorageDefinition();
        $storage_summary = $this->fieldTypeManager
            ->getStorageSettingsSummary($field_storage);
        $instance_summary = $this->fieldTypeManager
            ->getFieldSettingsSummary($field_config);
        $summary_list = [
            $storage_summary,
            $instance_summary,
        ];
        $settings_summary = [
            'data' => [
                '#theme' => 'item_list',
                '#items' => [
                    $this->fieldTypeManager
                        ->getDefinitions()[$field_storage->getType()]['label'],
                    $summary_list,
                ],
            ],
            'class' => [
                'field-settings-summary-cell',
            ],
        ];
        $row = [
            'id' => Html::getClass($field_config->getName()),
            'data' => [
                'label' => $field_config->getLabel(),
                'field_name' => $field_config->getName(),
                'settings_summary' => $settings_summary,
            ],
        ];
        // Add the operations.
        $row['data'] = $row['data'] + parent::buildRow($field_config);
        if ($field_storage->isLocked()) {
            $row['data']['operations'] = [
                'data' => [
                    '#markup' => $this->t('Locked'),
                ],
            ];
            $row['class'][] = 'menu-disabled';
        }
        return $row;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getDefaultOperations(EntityInterface $entity) {
        
        /** @var \Drupal\field\FieldConfigInterface $entity */
        $operations = parent::getDefaultOperations($entity);
        if ($entity->access('update') && $entity->hasLinkTemplate("{$entity->getTargetEntityTypeId()}-field-edit-form")) {
            $operations['edit'] = [
                'title' => $this->t('Edit'),
                'weight' => 10,
                'url' => $entity->toUrl("{$entity->getTargetEntityTypeId()}-field-edit-form"),
                'attributes' => [
                    'title' => $this->t('Edit field settings.'),
                ],
            ];
        }
        if ($entity->access('delete') && $entity->hasLinkTemplate("{$entity->getTargetEntityTypeId()}-field-delete-form")) {
            $operations['delete'] = [
                'title' => $this->t('Delete'),
                'weight' => 100,
                'url' => $entity->toUrl("{$entity->getTargetEntityTypeId()}-field-delete-form"),
                'attributes' => [
                    'title' => $this->t('Delete field.'),
                    'class' => [
                        'use-ajax',
                    ],
                    'data-dialog-type' => 'modal',
                    'data-dialog-options' => Json::encode([
                        'width' => 880,
                    ]),
                ],
            ];
        }
        return $operations;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ConfigEntityListBuilder::$storage protected property The config entity storage class. Overrides EntityListBuilder::$storage
ConfigEntityListBuilder::getStorage public function Gets the config entity storage. Overrides EntityListBuilder::getStorage
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
EntityHandlerBase::$moduleHandler protected property The module handler to invoke hooks on. 5
EntityHandlerBase::moduleHandler protected function Gets the module handler. 5
EntityHandlerBase::setModuleHandler public function Sets the module handler for this handler.
EntityListBuilder::$entityType protected property Information about the entity type.
EntityListBuilder::$entityTypeId protected property The entity type ID.
EntityListBuilder::$limit protected property The number of entities to list per page, or FALSE to list all entities.
EntityListBuilder::buildOperations public function Builds a renderable list of operation links for the entity. 2
EntityListBuilder::ensureDestination protected function Ensures that a destination is present on the given URL. 1
EntityListBuilder::getEntityIds protected function Loads entity IDs using a pager sorted by the entity id. 5
EntityListBuilder::getEntityListQuery protected function Returns a query object for loading entity IDs from the storage.
EntityListBuilder::getOperations public function Provides an array of information to build a list of operation links. Overrides EntityListBuilderInterface::getOperations 3
EntityListBuilder::getTitle protected function Gets the title of the page. 1
FieldConfigListBuilder::$entityFieldManager protected property The entity field manager.
FieldConfigListBuilder::$entityTypeManager protected property The entity type manager.
FieldConfigListBuilder::$fieldTypeManager protected property The field type plugin manager.
FieldConfigListBuilder::$targetBundle protected property The name of the bundle the listed fields are attached to.
FieldConfigListBuilder::$targetEntityTypeId protected property The name of the entity type the listed fields are attached to.
FieldConfigListBuilder::buildHeader public function Builds the header row for the entity listing. Overrides EntityListBuilder::buildHeader
FieldConfigListBuilder::buildRow public function Builds a row for an entity in the entity listing. Overrides EntityListBuilder::buildRow
FieldConfigListBuilder::createInstance public static function Instantiates a new instance of this entity handler. Overrides EntityListBuilder::createInstance
FieldConfigListBuilder::getDefaultOperations public function Gets this list's default operations. Overrides ConfigEntityListBuilder::getDefaultOperations
FieldConfigListBuilder::load public function Loads entities of this type from storage for listing. Overrides ConfigEntityListBuilder::load
FieldConfigListBuilder::render public function Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilder::render
FieldConfigListBuilder::__construct public function Constructs a new class instance. Overrides EntityListBuilder::__construct
MessengerTrait::$messenger protected property The messenger. 16
MessengerTrait::messenger public function Gets the messenger. 16
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 2
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
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.

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