class ContainerInfoController in Devel 8

Same name and namespace in other branches

8.3 src/Controller/ContainerInfoController.php \Drupal\devel\Controller\ContainerInfoController
8.2 src/Controller/ContainerInfoController.php \Drupal\devel\Controller\ContainerInfoController
4.x src/Controller/ContainerInfoController.php \Drupal\devel\Controller\ContainerInfoController

Provides route responses for the container info pages.

Hierarchy

class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\devel\Controller\ContainerInfoController implements \Symfony\Component\DependencyInjection\ContainerAwareInterface uses \Symfony\Component\DependencyInjection\ContainerAwareTrait

Expanded class hierarchy of ContainerInfoController

File

src/Controller/ContainerInfoController.php, line 18

Namespace

Drupal\devel\Controller

View source

class ContainerInfoController extends ControllerBase implements ContainerAwareInterface {
  use ContainerAwareTrait;

  /**
   * The drupal kernel.
   *
   * @var \Drupal\Core\DrupalKernelInterface
   */
  protected $kernel;

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

  /**
   * ServiceInfoController constructor.
   *
   * @param \Drupal\Core\DrupalKernelInterface $drupalKernel
   *   The drupal kernel.
   * @param \Drupal\devel\DevelDumperManagerInterface $dumper
   *   The dumper manager service.
   */
  public function __construct(DrupalKernelInterface $drupalKernel, DevelDumperManagerInterface $dumper) {
    $this->kernel = $drupalKernel;
    $this->dumper = $dumper;
  }

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

  /**
   * Builds the services overview page.
   *
   * @return array
   *   A render array as expected by the renderer.
   */
  public function serviceList() {
    $headers = [
      $this
        ->t('ID'),
      $this
        ->t('Class'),
      $this
        ->t('Alias'),
      $this
        ->t('Operations'),
    ];
    $rows = [];
    if ($container = $this->kernel
      ->getCachedContainerDefinition()) {
      foreach ($container['services'] as $service_id => $definition) {
        $service = unserialize($definition);
        $row['id'] = [
          'data' => $service_id,
          'class' => 'table-filter-text-source',
        ];
        $row['class'] = [
          'data' => isset($service['class']) ? $service['class'] : '',
          'class' => 'table-filter-text-source',
        ];
        $row['alias'] = [
          'data' => array_search($service_id, $container['aliases']) ?: '',
          'class' => 'table-filter-text-source',
        ];
        $row['operations']['data'] = [
          '#type' => 'operations',
          '#links' => [
            'devel' => [
              'title' => $this
                ->t('Devel'),
              'url' => Url::fromRoute('devel.container_info.service.detail', [
                'service_id' => $service_id,
              ]),
            ],
          ],
        ];
        $rows[$service_id] = $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 service id, alias or class'),
      '#attributes' => [
        'class' => [
          'table-filter-text',
        ],
        'data-table' => '.devel-filter-text',
        'autocomplete' => 'off',
        'title' => $this
          ->t('Enter a part of the service id, service alias or class to filter by.'),
      ],
    ];
    $output['services'] = [
      '#type' => 'table',
      '#header' => $headers,
      '#rows' => $rows,
      '#empty' => $this
        ->t('No services found.'),
      '#sticky' => TRUE,
      '#attributes' => [
        'class' => [
          'devel-service-list',
          'devel-filter-text',
        ],
      ],
    ];
    return $output;
  }

  /**
   * Returns a render array representation of the service.
   *
   * @param string $service_id
   *   The ID of the service to retrieve.
   *
   * @return array
   *   A render array containing the service detail.
   *
   * @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
   *   If the requested service is not defined.
   */
  public function serviceDetail($service_id) {
    $instance = $this->container
      ->get($service_id, ContainerInterface::NULL_ON_INVALID_REFERENCE);
    if ($instance === NULL) {
      throw new NotFoundHttpException();
    }
    $output = [];
    if ($cached_definitions = $this->kernel
      ->getCachedContainerDefinition()) {

      // Tries to retrieve the service definition from the kernel's cached
      // container definition.
      if (isset($cached_definitions['services'][$service_id])) {
        $definition = unserialize($cached_definitions['services'][$service_id]);

        // If the service has an alias add it to the definition.
        if ($alias = array_search($service_id, $cached_definitions['aliases'])) {
          $definition['alias'] = $alias;
        }
        $output['definition'] = $this->dumper
          ->exportAsRenderable($definition, $this
          ->t('Computed Definition'));
      }
    }
    $output['instance'] = $this->dumper
      ->exportAsRenderable($instance, $this
      ->t('Instance'));
    return $output;
  }

  /**
   * Builds the parameters overview page.
   *
   * @return array
   *   A render array as expected by the renderer.
   */
  public function parameterList() {
    $headers = [
      $this
        ->t('Name'),
      $this
        ->t('Operations'),
    ];
    $rows = [];
    if ($container = $this->kernel
      ->getCachedContainerDefinition()) {
      foreach ($container['parameters'] as $parameter_name => $definition) {
        $row['name'] = [
          'data' => $parameter_name,
          'class' => 'table-filter-text-source',
        ];
        $row['operations']['data'] = [
          '#type' => 'operations',
          '#links' => [
            'devel' => [
              'title' => $this
                ->t('Devel'),
              'url' => Url::fromRoute('devel.container_info.parameter.detail', [
                'parameter_name' => $parameter_name,
              ]),
            ],
          ],
        ];
        $rows[$parameter_name] = $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 parameter name'),
      '#attributes' => [
        'class' => [
          'table-filter-text',
        ],
        'data-table' => '.devel-filter-text',
        'autocomplete' => 'off',
        'title' => $this
          ->t('Enter a part of the parameter name to filter by.'),
      ],
    ];
    $output['parameters'] = [
      '#type' => 'table',
      '#header' => $headers,
      '#rows' => $rows,
      '#empty' => $this
        ->t('No parameters found.'),
      '#sticky' => TRUE,
      '#attributes' => [
        'class' => [
          'devel-parameter-list',
          'devel-filter-text',
        ],
      ],
    ];
    return $output;
  }

  /**
   * Returns a render array representation of the parameter value.
   *
   * @param string $parameter_name
   *   The name of the parameter to retrieve.
   *
   * @return array
   *   A render array containing the parameter value.
   *
   * @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
   *   If the requested parameter is not defined.
   */
  public function parameterDetail($parameter_name) {
    try {
      $parameter = $this->container
        ->getParameter($parameter_name);
    } catch (ParameterNotFoundException $e) {
      throw new NotFoundHttpException();
    }
    return $this->dumper
      ->exportAsRenderable($parameter);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ContainerInfoController::$dumper	protected	property	The dumper manager service.
ContainerInfoController::$kernel	protected	property	The drupal kernel.
ContainerInfoController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
ContainerInfoController::parameterDetail	public	function	Returns a render array representation of the parameter value.
ContainerInfoController::parameterList	public	function	Builds the parameters overview page.
ContainerInfoController::serviceDetail	public	function	Returns a render array representation of the service.
ContainerInfoController::serviceList	public	function	Builds the services overview page.
ContainerInfoController::__construct	public	function	ServiceInfoController constructor.
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.
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.

You are here

class ContainerInfoController in Devel 8

Hierarchy

File

Namespace

Members

API Navigation