class LayoutInfoController in Devel 8

Returns response for Layout Info route.

Hierarchy

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

File

src/Controller/LayoutInfoController.php, line 12

Namespace

Drupal\devel\Controller

class LayoutInfoController extends ControllerBase {

  /**
   * The Layout Plugin Manager.
   *
   * @var Drupal\Core\Layout\LayoutPluginManagerInterface
   */
  protected $layoutPluginManager;

  /**
   * LayoutInfoController constructor.
   *
   * @param \Drupal\Core\Layout\LayoutPluginManagerInterface $pluginManagerLayout
   *   The layout manager.
   */
  public function __construct(LayoutPluginManagerInterface $pluginManagerLayout) {
    $this->layoutPluginManager = $pluginManagerLayout;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('plugin.manager.core.layout'));
  }

  /**
   * Builds the Layout Info page.
   *
   * @return array
   *   Array of page elements to render.
   */
  public function layoutInfoPage() {
    $definedLayouts = [];
    $layouts = $this->layoutPluginManager
      ->getDefinitions();
    foreach ($layouts as $layout) {

      // @todo Revisit once https://www.drupal.org/node/2660124 gets in, getting
      // the image should be as simple as $layout->getIcon().
      $image = NULL;
      if ($layout
        ->getIconPath() != NULL) {
        $image = [
          'data' => [
            '#theme' => 'image',
            '#uri' => $layout
              ->getIconPath(),
            '#alt' => $layout
              ->getLabel(),
            '#height' => '65',
          ],
        ];
      }
      $definedLayouts[] = [
        $image,
        $layout
          ->getLabel(),
        $layout
          ->getDescription(),
        $layout
          ->getCategory(),
        implode(', ', $layout
          ->getRegionLabels()),
        $layout
          ->getProvider(),
      ];
    }
    return [
      '#theme' => 'table',
      '#header' => [
        $this
          ->t('Icon'),
        $this
          ->t('Label'),
        $this
          ->t('Description'),
        $this
          ->t('Category'),
        $this
          ->t('Regions'),
        $this
          ->t('Provider'),
      ],
      '#rows' => $definedLayouts,
      '#empty' => $this
        ->t('No layouts available.'),
      '#attributes' => [
        'class' => [
          'devel-layout-list',
        ],
      ],
    ];
  }

}

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::$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.
LayoutInfoController::$layoutPluginManager	protected	property	The Layout Plugin Manager.
LayoutInfoController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
LayoutInfoController::layoutInfoPage	public	function	Builds the Layout Info page.
LayoutInfoController::__construct	public	function	LayoutInfoController 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.