class ElementInfoController in Devel 4.x

Provides route responses for the element info page.

Hierarchy

• class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
  • class \Drupal\devel\Controller\ElementInfoController

File

src/Controller/ElementInfoController.php, line 16

Namespace

Drupal\devel\Controller

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,
        'filter' => TRUE,
      ];
      $row['provider'] = [
        'data' => $definition['provider'],
        'filter' => TRUE,
      ];
      $row['class'] = [
        'data' => $definition['class'],
        'filter' => TRUE,
      ];
      $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['elements'] = [
      '#type' => 'devel_table_filter',
      '#filter_label' => $this
        ->t('Search'),
      '#filter_placeholder' => $this
        ->t('Enter element id, provider or class'),
      '#filter_description' => $this
        ->t('Enter a part of the element id, provider or class to filter by.'),
      '#header' => $headers,
      '#rows' => $rows,
      '#empty' => $this
        ->t('No elements found.'),
      '#sticky' => TRUE,
      '#attributes' => [
        'class' => [
          'devel-element-list',
        ],
      ],
    ];
    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

Name	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::$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::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.
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.
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.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
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.	4
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.