You are here

Home » API reference » Devel 8 » ElementInfoController.php

class ElementInfoController in Devel 8

Same name and namespace in other branches
  1. 8.3 src/Controller/ElementInfoController.php \Drupal\devel\Controller\ElementInfoController
  2. 8.2 src/Controller/ElementInfoController.php \Drupal\devel\Controller\ElementInfoController
  3. 4.x src/Controller/ElementInfoController.php \Drupal\devel\Controller\ElementInfoController

Provides route responses for the element info page.

Hierarchy

Expanded class hierarchy of ElementInfoController

File

src/Controller/ElementInfoController.php, line 16

Namespace

Drupal\devel\Controller
View source 
class ElementInfoController extends ControllerBase {

  /**
   * Element info manager service.
   *
   * @var \Drupal\Core\Render\ElementInfoManagerInterface
   */
  protected $elementInfo;

  /**
   * The dumper service.
   *
   * @var \Drupal\devel\DevelDumperManagerInterface
   */
  protected $dumper;

  /**
   * EventInfoController constructor.
   *
   * @param \Drupal\Core\Render\ElementInfoManagerInterface $element_info
   *   Element info manager service.
   * @param \Drupal\devel\DevelDumperManagerInterface $dumper
   *   The dumper service.
   */
  public function __construct(ElementInfoManagerInterface $element_info, DevelDumperManagerInterface $dumper) {
    $this->elementInfo = $element_info;
    $this->dumper = $dumper;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('element_info'), $container
      ->get('devel.dumper'));
  }

  /**
   * Builds the element overview page.
   *
   * @return array
   *   A render array as expected by the renderer.
   */
  public function elementList() {
    $headers = [
      $this
        ->t('Name'),
      $this
        ->t('Provider'),
      $this
        ->t('Class'),
      $this
        ->t('Operations'),
    ];
    $rows = [];
    foreach ($this->elementInfo
      ->getDefinitions() as $element_type => $definition) {
      $row['name'] = [
        'data' => $element_type,
        'class' => 'table-filter-text-source',
      ];
      $row['provider'] = [
        'data' => $definition['provider'],
        'class' => 'table-filter-text-source',
      ];
      $row['class'] = [
        'data' => $definition['class'],
        'class' => 'table-filter-text-source',
      ];
      $row['operations']['data'] = [
        '#type' => 'operations',
        '#links' => [
          'devel' => [
            'title' => $this
              ->t('Devel'),
            'url' => Url::fromRoute('devel.elements_page.detail', [
              'element_name' => $element_type,
            ]),
            'attributes' => [
              'class' => [
                'use-ajax',
              ],
              'data-dialog-type' => 'modal',
              'data-dialog-options' => Json::encode([
                'width' => 700,
                'minHeight' => 500,
              ]),
            ],
          ],
        ],
      ];
      $rows[$element_type] = $row;
    }
    ksort($rows);
    $output['#attached']['library'][] = 'system/drupal.system.modules';
    $output['filters'] = [
      '#type' => 'container',
      '#attributes' => [
        'class' => [
          'table-filter',
          'js-show',
        ],
      ],
    ];
    $output['filters']['text'] = [
      '#type' => 'search',
      '#title' => $this
        ->t('Search'),
      '#size' => 30,
      '#placeholder' => $this
        ->t('Enter element id, provider or class'),
      '#attributes' => [
        'class' => [
          'table-filter-text',
        ],
        'data-table' => '.devel-filter-text',
        'autocomplete' => 'off',
        'title' => $this
          ->t('Enter a part of the element id, provider or class to filter by.'),
      ],
    ];
    $output['elements'] = [
      '#type' => 'table',
      '#header' => $headers,
      '#rows' => $rows,
      '#empty' => $this
        ->t('No elements found.'),
      '#sticky' => TRUE,
      '#attributes' => [
        'class' => [
          'devel-element-list',
          'devel-filter-text',
        ],
      ],
    ];
    return $output;
  }

  /**
   * Returns a render array representation of the element.
   *
   * @param string $element_name
   *   The name of the element to retrieve.
   *
   * @return array
   *   A render array containing the element.
   *
   * @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
   *   If the requested element is not defined.
   */
  public function elementDetail($element_name) {
    if (!($element = $this->elementInfo
      ->getDefinition($element_name, FALSE))) {
      throw new NotFoundHttpException();
    }
    $element += $this->elementInfo
      ->getInfo($element_name);
    return $this->dumper
      ->exportAsRenderable($element, $element_name);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 1
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityManager protected property The entity manager.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 2
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 2
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. 1
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityManager Deprecated protected function Retrieves the entity manager service.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 2
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. 2
ControllerBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state protected function Returns the state storage service.
ElementInfoController::$dumper protected property The dumper service.
ElementInfoController::$elementInfo protected property Element info manager service.
ElementInfoController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
ElementInfoController::elementDetail public function Returns a render array representation of the element.
ElementInfoController::elementList public function Builds the element overview page.
ElementInfoController::__construct public function EventInfoController constructor.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
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. 29
MessengerTrait::messenger public function Gets the messenger. 29
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. 1
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.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.