class FieldUiRouteEnhancer

Same name in other branches
  1. 9 core/modules/field_ui/src/Routing/FieldUiRouteEnhancer.php \Drupal\field_ui\Routing\FieldUiRouteEnhancer

Enhances Field UI routes by adding proper information about the bundle name.

Hierarchy

Expanded class hierarchy of FieldUiRouteEnhancer

1 string reference to 'FieldUiRouteEnhancer'
field_ui.services.yml in core/modules/field_ui/field_ui.services.yml
core/modules/field_ui/field_ui.services.yml
1 service uses FieldUiRouteEnhancer
field_ui.route_enhancer in core/modules/field_ui/field_ui.services.yml
Drupal\field_ui\Routing\FieldUiRouteEnhancer

File

core/modules/field_ui/src/Routing/FieldUiRouteEnhancer.php, line 15

Namespace

Drupal\field_ui\Routing
View source 
class FieldUiRouteEnhancer implements EnhancerInterface {
    use DeprecatedServicePropertyTrait;
    
    /**
     * {@inheritdoc}
     */
    protected $deprecatedProperties = [
        'entityManager' => 'entity.manager',
    ];
    
    /**
     * The entity type manager service.
     *
     * @var \Drupal\Core\Entity\EntityTypeManagerInterface
     */
    protected $entityTypeManager;
    
    /**
     * Constructs a FieldUiRouteEnhancer object.
     *
     * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
     *   The entity type manager service.
     */
    public function __construct(EntityTypeManagerInterface $entity_type_manager) {
        $this->entityTypeManager = $entity_type_manager;
    }
    
    /**
     * {@inheritdoc}
     */
    public function enhance(array $defaults, Request $request) {
        if (!$this->applies($defaults[RouteObjectInterface::ROUTE_OBJECT])) {
            return $defaults;
        }
        if (($bundle = $this->entityTypeManager
            ->getDefinition($defaults['entity_type_id'])
            ->getBundleEntityType()) && isset($defaults[$bundle])) {
            // Field UI forms only need the actual name of the bundle they're dealing
            // with, not an upcasted entity object, so provide a simple way for them
            // to get it.
            $defaults['bundle'] = $defaults['_raw_variables']->get($bundle);
        }
        return $defaults;
    }
    
    /**
     * {@inheritdoc}
     */
    protected function applies(Route $route) {
        return $route->hasOption('_field_ui');
    }

}

Members

Title Modifiers Object type Summary
DeprecatedServicePropertyTrait::__get public function Allows to access deprecated/removed properties.
FieldUiRouteEnhancer::$deprecatedProperties protected property
FieldUiRouteEnhancer::$entityTypeManager protected property The entity type manager service.
FieldUiRouteEnhancer::applies protected function
FieldUiRouteEnhancer::enhance public function
FieldUiRouteEnhancer::__construct public function Constructs a FieldUiRouteEnhancer object.

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