class LayoutInfoController

Same name and namespace in other branches
  1. 5.x src/Controller/LayoutInfoController.php \Drupal\devel\Controller\LayoutInfoController

Returns response for Layout Info route.

Hierarchy

Expanded class hierarchy of LayoutInfoController

File

src/Controller/LayoutInfoController.php, line 12

Namespace

Drupal\devel\Controller
View source 
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() {
        $headers = [
            $this->t('Icon'),
            $this->t('Label'),
            $this->t('Description'),
            $this->t('Category'),
            $this->t('Regions'),
            $this->t('Provider'),
        ];
        $rows = [];
        foreach ($this->layoutPluginManager
            ->getDefinitions() as $layout) {
            $rows[] = [
                'icon' => [
                    'data' => $layout->getIcon(),
                ],
                'label' => $layout->getLabel(),
                'description' => $layout->getDescription(),
                'category' => $layout->getCategory(),
                'regions' => implode(', ', $layout->getRegionLabels()),
                'provider' => $layout->getProvider(),
            ];
        }
        $output['layouts'] = [
            '#type' => 'table',
            '#header' => $headers,
            '#rows' => $rows,
            '#empty' => $this->t('No layouts available.'),
            '#attributes' => [
                'class' => [
                    'devel-layout-list',
                ],
            ],
        ];
        return $output;
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 3
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 1
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 1
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. 3
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. 1
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. 1
ControllerBase::redirect protected function Returns a redirect response object for the specified route.
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.
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. 17
MessengerTrait::messenger public function Gets the messenger. 17
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. 3
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.