class EntityDebugController

Same name in other branches
  1. 5.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

File

src/Controller/EntityDebugController.php, line 18

Namespace

Drupal\devel\Controller
View source
class EntityDebugController extends ControllerBase {
    
    /**
     * The dumper service.
     *
     * @var \Drupal\devel\DevelDumperManagerInterface
     */
    protected $dumper;
    
    /**
     * EntityDebugController constructor.
     *
     * @param \Drupal\devel\DevelDumperManagerInterface $dumper
     *   The dumper service.
     */
    public function __construct(DevelDumperManagerInterface $dumper) {
        $this->dumper = $dumper;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) {
        return new static($container->get('devel.dumper'));
    }
    
    /**
     * 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) {
        $output = [];
        $entity = $this->getEntityFromRouteMatch($route_match);
        if ($entity instanceof EntityInterface) {
            $output = $this->dumper
                ->exportAsRenderable($entity->getEntityType());
        }
        return $output;
    }
    
    /**
     * 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) {
        $output = [];
        $entity = $this->getEntityFromRouteMatch($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 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) {
        $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;
    }
    
    /**
     * 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);
    }

}

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. 3
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. 3
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::$dumper protected property The dumper service.
EntityDebugController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
EntityDebugController::entityLoad public function Returns the loaded structure of the current entity.
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::__construct public function EntityDebugController constructor.
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. 17
MessengerTrait::messenger public function Gets the messenger. 17
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
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.