class EntityDebugController

Same name in other branches
  1. 8.x-1.x src/Controller/EntityDebugController.php \Drupal\devel\Controller\EntityDebugController
  2. 4.x src/Controller/EntityDebugController.php \Drupal\devel\Controller\EntityDebugController

Controller for devel entity debug.

Hierarchy

Expanded class hierarchy of EntityDebugController

See also

\Drupal\devel\Routing\RouteSubscriber

\Drupal\devel\Plugin\Derivative\DevelLocalTask

1 file declares its use of EntityDebugController
RouteSubscriber.php in src/Routing/RouteSubscriber.php

File

src/Controller/EntityDebugController.php, line 20

Namespace

Drupal\devel\Controller
View source
class EntityDebugController extends ControllerBase {
    
    /**
     * The dumper service.
     */
    protected DevelDumperManagerInterface $dumper;
    
    /**
     * The translation manager.
     */
    protected TranslationManager $translationManager;
    
    /**
     * The alias storage.
     */
    protected PathAliasStorage $aliasStorage;
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) : static {
        $entityTypeManager = $container->get('entity_type.manager');
        $instance = parent::create($container);
        $instance->dumper = $container->get('devel.dumper');
        $instance->entityTypeManager = $entityTypeManager;
        $instance->translationManager = $container->get('string_translation');
        $instance->aliasStorage = $entityTypeManager->getStorage('path_alias');
        return $instance;
    }
    
    /**
     * Returns the entity type definition of the current entity.
     *
     * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
     *   A RouteMatch object.
     *
     * @return array
     *   Array of page elements to render.
     */
    public function entityTypeDefinition(RouteMatchInterface $route_match) : array {
        $entity = $this->getEntityFromRouteMatch($route_match);
        if (!$entity instanceof EntityInterface) {
            return [];
        }
        return $this->dumper
            ->exportAsRenderable($entity->getEntityType());
    }
    
    /**
     * Returns the loaded structure of the current entity.
     *
     * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
     *   A RouteMatch object.
     *
     * @return array
     *   Array of page elements to render.
     */
    public function entityLoad(RouteMatchInterface $route_match) : array {
        $output = [];
        $entity = $this->getEntityWithFieldDefinitions($route_match);
        if ($entity instanceof EntityInterface) {
            // Field definitions are lazy loaded and are populated only when needed.
            // By calling ::getFieldDefinitions() we are sure that field definitions
            // are populated and available in the dump output.
            // @see https://www.drupal.org/node/2311557
            if ($entity instanceof FieldableEntityInterface) {
                $entity->getFieldDefinitions();
            }
            $output = $this->dumper
                ->exportAsRenderable($entity);
        }
        return $output;
    }
    
    /**
     * Returns the loaded structure of the current entity with references.
     *
     * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
     *   A RouteMatch object.
     *
     * @return array
     *   Array of page elements to render.
     */
    public function entityLoadWithReferences(RouteMatchInterface $route_match) : array {
        $entity = $this->getEntityWithFieldDefinitions($route_match);
        if (!$entity instanceof EntityInterface) {
            return [];
        }
        return $this->dumper
            ->exportAsRenderable($entity, NULL, NULL, TRUE);
    }
    
    /**
     * Returns the render structure of the current entity.
     *
     * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
     *   A RouteMatch object.
     *
     * @return array
     *   Array of page elements to render.
     */
    public function entityRender(RouteMatchInterface $route_match) : array {
        $output = [];
        $entity = $this->getEntityFromRouteMatch($route_match);
        if ($entity instanceof EntityInterface) {
            $entity_type_id = $entity->getEntityTypeId();
            $view_hook = $entity_type_id . '_view';
            $build = [];
            // If module implements own {entity_type}_view() hook use it, otherwise
            // fallback to the entity view builder if available.
            if (function_exists($view_hook)) {
                $build = $view_hook($entity);
            }
            elseif ($this->entityTypeManager
                ->hasHandler($entity_type_id, 'view_builder')) {
                $build = $this->entityTypeManager
                    ->getViewBuilder($entity_type_id)
                    ->view($entity);
            }
            $output = $this->dumper
                ->exportAsRenderable($build);
        }
        return $output;
    }
    
    /**
     * Return definitions for any related path aliases.
     *
     * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
     *   A RouteMatch object.
     *
     * @return array
     *   Array of page elements to render.
     */
    public function pathAliases(RouteMatchInterface $route_match) : array {
        $entity = $this->getEntityFromRouteMatch($route_match);
        if ($entity === NULL) {
            return [];
        }
        $path = sprintf('/%s/%s', $entity->getEntityTypeId(), $entity->id());
        $aliases = $this->aliasStorage
            ->loadByProperties([
            'path' => $path,
        ]);
        $aliasCount = count($aliases);
        if ($aliasCount > 0) {
            $message = $this->translationManager
                ->formatPlural($aliasCount, 'Found 1 alias with path "@path."', 'Found @count aliases with path "@path".', [
                '@path' => $path,
            ]);
        }
        else {
            $message = $this->t('Found no aliases with path "@path".', [
                '@path' => $path,
            ]);
        }
        $build['header'] = [
            '#type' => 'html_tag',
            '#tag' => 'p',
            '#value' => $message,
        ];
        // Add alias dump to the response.
        $build['aliases'] = [];
        foreach ($aliases as $alias) {
            $build['aliases'][] = $this->dumper
                ->exportAsRenderable($alias);
        }
        return $build;
    }
    
    /**
     * Retrieves entity from route match.
     *
     * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
     *   The route match.
     *
     * @return \Drupal\Core\Entity\EntityInterface|null
     *   The entity object as determined from the passed-in route match.
     */
    protected function getEntityFromRouteMatch(RouteMatchInterface $route_match) {
        $parameter_name = $route_match->getRouteObject()
            ->getOption('_devel_entity_type_id');
        return $route_match->getParameter($parameter_name);
    }
    
    /**
     * Returns an entity with field definitions from the given route match.
     *
     * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
     *   The route match.
     *
     * @return \Drupal\Core\Entity\EntityInterface|null
     *   The entity object with field definitions as determined from the
     *   passed-in route match.
     */
    protected function getEntityWithFieldDefinitions(RouteMatchInterface $route_match) : ?EntityInterface {
        $entity = $this->getEntityFromRouteMatch($route_match);
        if (!$entity instanceof EntityInterface) {
            return NULL;
        }
        // Field definitions are lazy loaded and are populated only when needed.
        // By calling ::getFieldDefinitions() we are sure that field definitions
        // are populated and available in the dump output.
        // @see https://www.drupal.org/node/2311557
        if ($entity instanceof FieldableEntityInterface) {
            $entity->getFieldDefinitions();
        }
        return $entity;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 2
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 1
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 1
ControllerBase::$stateService protected property The state service.
ControllerBase::cache protected function Returns the requested cache bin.
ControllerBase::config protected function Retrieves a configuration object.
ControllerBase::container private function Returns the service container.
ControllerBase::currentUser protected function Returns the current user. 2
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 1
ControllerBase::keyValue protected function Returns a key/value storage collection. 1
ControllerBase::languageManager protected function Returns the language manager service. 1
ControllerBase::moduleHandler protected function Returns the module handler. 1
ControllerBase::redirect protected function Returns a redirect response object for the specified route.
ControllerBase::state protected function Returns the state storage service.
EntityDebugController::$aliasStorage protected property The alias storage.
EntityDebugController::$dumper protected property The dumper service.
EntityDebugController::$translationManager protected property The translation manager.
EntityDebugController::create public static function Instantiates a new instance of the implementing class using autowiring. Overrides AutowireTrait::create
EntityDebugController::entityLoad public function Returns the loaded structure of the current entity.
EntityDebugController::entityLoadWithReferences public function Returns the loaded structure of the current entity with references.
EntityDebugController::entityRender public function Returns the render structure of the current entity.
EntityDebugController::entityTypeDefinition public function Returns the entity type definition of the current entity.
EntityDebugController::getEntityFromRouteMatch protected function Retrieves entity from route match.
EntityDebugController::getEntityWithFieldDefinitions protected function Returns an entity with field definitions from the given route match.
EntityDebugController::pathAliases public function Return definitions for any related path aliases.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
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.