function FieldUiLocalTask::getDerivativeDefinitions

Overrides DeriverBase::getDerivativeDefinitions

File

core/modules/field_ui/src/Plugin/Derivative/FieldUiLocalTask.php, line 75

Class

FieldUiLocalTask

Provides local task definitions for all entity bundles.

Namespace

Code

public function getDerivativeDefinitions($base_plugin_definition) {
    $this->derivatives = [];
    foreach ($this->entityTypeManager
        ->getDefinitions() as $entity_type_id => $entity_type) {
        if ($entity_type->get('field_ui_base_route')) {
            $this->derivatives["overview_{$entity_type_id}"] = [
                'route_name' => "entity.{$entity_type_id}.field_ui_fields",
                'weight' => 1,
                'title' => $this->t('Manage fields'),
                'base_route' => "entity.{$entity_type_id}.field_ui_fields",
            ];
            // 'Manage form display' tab.
            $this->derivatives["form_display_overview_{$entity_type_id}"] = [
                'route_name' => "entity.entity_form_display.{$entity_type_id}.default",
                'weight' => 2,
                'title' => $this->t('Manage form display'),
                'base_route' => "entity.{$entity_type_id}.field_ui_fields",
            ];
            // 'Manage display' tab.
            $this->derivatives["display_overview_{$entity_type_id}"] = [
                'route_name' => "entity.entity_view_display.{$entity_type_id}.default",
                'weight' => 3,
                'title' => $this->t('Manage display'),
                'base_route' => "entity.{$entity_type_id}.field_ui_fields",
            ];
            // Field edit tab.
            $this->derivatives["field_edit_{$entity_type_id}"] = [
                'route_name' => "entity.field_config.{$entity_type_id}_field_edit_form",
                'title' => $this->t('Edit'),
                'base_route' => "entity.field_config.{$entity_type_id}_field_edit_form",
            ];
            // View and form modes secondary tabs.
            // The same base $path for the menu item (with a placeholder) can be
            // used for all bundles of a given entity type; but depending on
            // administrator settings, each bundle has a different set of view
            // modes available for customization. So we define menu items for all
            // view modes, and use a route requirement to determine which ones are
            // actually visible for a given bundle.
            $this->derivatives['field_form_display_default_' . $entity_type_id] = [
                'title' => 'Default',
                'route_name' => "entity.entity_form_display.{$entity_type_id}.default",
                'parent_id' => "field_ui.fields:form_display_overview_{$entity_type_id}",
                'weight' => -1,
            ];
            $this->derivatives['field_display_default_' . $entity_type_id] = [
                'title' => 'Default',
                'route_name' => "entity.entity_view_display.{$entity_type_id}.default",
                'parent_id' => "field_ui.fields:display_overview_{$entity_type_id}",
                'weight' => -1,
            ];
            // One local task for each form mode.
            $form_modes = $this->entityDisplayRepository
                ->getFormModes($entity_type_id);
            // Sort all form modes by title.
            $form_modes_titles = array_values(array_map(fn($item) => (string) $item['label'], $form_modes));
            sort($form_modes_titles, SORT_NATURAL);
            foreach ($form_modes as $form_mode => $form_mode_info) {
                $this->derivatives['field_form_display_' . $form_mode . '_' . $entity_type_id] = [
                    'title' => $form_mode_info['label'],
                    'route_name' => "entity.entity_form_display.{$entity_type_id}.form_mode",
                    'route_parameters' => [
                        'form_mode_name' => $form_mode,
                    ],
                    'parent_id' => "field_ui.fields:form_display_overview_{$entity_type_id}",
                    'weight' => array_flip($form_modes_titles)[(string) $form_mode_info['label']],
                    'cache_tags' => $this->entityTypeManager
                        ->getDefinition('entity_form_display')
                        ->getListCacheTags(),
                ];
            }
            // One local task for each view mode.
            $view_modes = $this->entityDisplayRepository
                ->getViewModes($entity_type_id);
            // Sort all view modes by title.
            $view_modes_titles = array_values(array_map(fn($item) => (string) $item['label'], $view_modes));
            sort($view_modes_titles, SORT_NATURAL);
            foreach ($view_modes as $view_mode => $form_mode_info) {
                $this->derivatives['field_display_' . $view_mode . '_' . $entity_type_id] = [
                    'title' => $form_mode_info['label'],
                    'route_name' => "entity.entity_view_display.{$entity_type_id}.view_mode",
                    'route_parameters' => [
                        'view_mode_name' => $view_mode,
                    ],
                    'parent_id' => "field_ui.fields:display_overview_{$entity_type_id}",
                    'weight' => array_flip($view_modes_titles)[(string) $form_mode_info['label']],
                    'cache_tags' => $this->entityTypeManager
                        ->getDefinition('entity_view_display')
                        ->getListCacheTags(),
                ];
            }
        }
    }
    foreach ($this->derivatives as &$entry) {
        $entry += $base_plugin_definition;
    }
    return $this->derivatives;
}