ElementInfoController.php
Same filename in other branches
Namespace
Drupal\devel\ControllerFile
-
src/
Controller/ ElementInfoController.php
View source
<?php
namespace Drupal\devel\Controller;
use Drupal\Component\Serialization\Json;
use Drupal\Core\Controller\ControllerBase;
use Drupal\Core\Render\ElementInfoManagerInterface;
use Drupal\Core\Url;
use Drupal\devel\DevelDumperManagerInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
/**
* Provides route responses for the element info page.
*/
class ElementInfoController extends ControllerBase {
/**
* Element info manager service.
*/
protected ElementInfoManagerInterface $elementInfo;
/**
* The dumper service.
*/
protected DevelDumperManagerInterface $dumper;
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) : static {
$instance = parent::create($container);
$instance->elementInfo = $container->get('element_info');
$instance->dumper = $container->get('devel.dumper');
$instance->stringTranslation = $container->get('string_translation');
return $instance;
}
/**
* Builds the element overview page.
*
* @return array
* A render array as expected by the renderer.
*/
public function elementList() : array {
$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) : array {
if (!($element = $this->elementInfo
->getDefinition($element_name, FALSE))) {
throw new NotFoundHttpException();
}
$element += $this->elementInfo
->getInfo($element_name);
return $this->dumper
->exportAsRenderable($element, $element_name);
}
}
Classes
Title | Deprecated | Summary |
---|---|---|
ElementInfoController | Provides route responses for the element info page. |