class LayoutStyleguide in Style Guide 2.x

Same name and namespace in other branches

8 src/Plugin/Styleguide/LayoutStyleguide.php \Drupal\styleguide\Plugin\Styleguide\LayoutStyleguide

Renders all found layouts from core Layout Discovery module.

Plugin annotation


@Plugin(
  id = "layout_styleguide",
  label = @Translation("Layouts Styleguide elements")
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\styleguide\Plugin\StyleguidePluginBase implements ContainerFactoryPluginInterface, StyleguideInterface
    class \Drupal\styleguide\Plugin\Styleguide\LayoutStyleguide

Expanded class hierarchy of LayoutStyleguide

File

src/Plugin/Styleguide/LayoutStyleguide.php, line 19

Namespace

Drupal\styleguide\Plugin\Styleguide

View source

class LayoutStyleguide extends StyleguidePluginBase {

  /**
   * The styleguide generator service.
   *
   * @var \Drupal\styleguide\Generator
   */
  protected $generator;

  /**
   * The module handler service.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * The layout plugin manager.
   *
   * @var \Drupal\Core\Layout\LayoutPluginManagerInterface
   */
  protected $layoutPluginManager;

  /**
   * Constructs a new LayoutStyleguide object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\styleguide\GeneratorInterface $styleguide_generator
   *   The styleguide generator service.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler service.
   * @param \Drupal\Core\Layout\LayoutPluginManagerInterface|null $layout_plugin_manager
   *   The layout plugin manager.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, GeneratorInterface $styleguide_generator, ModuleHandlerInterface $module_handler, LayoutPluginManagerInterface $layout_plugin_manager = NULL) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->generator = $styleguide_generator;
    $this->moduleHandler = $module_handler;
    $this->layoutPluginManager = $layout_plugin_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('styleguide.generator'), $container
      ->get('module_handler'), $container
      ->has('plugin.manager.core.layout') ? $container
      ->get('plugin.manager.core.layout') : NULL);
  }

  /**
   * {@inheritdoc}
   */
  public function items() {
    if (!$this->layoutPluginManager) {
      return [];
    }
    $items = [];
    foreach ($this->layoutPluginManager
      ->getGroupedDefinitions() as $group => $layouts) {
      $items[$group] = [
        'title' => $group,
        'content' => [],
        'group' => $this
          ->t('Layouts'),
      ];

      /** @var \Drupal\Core\Layout\LayoutDefinition $definition */
      foreach ($layouts as $layout => $definition) {
        $details = [];
        if ($property = $definition
          ->id()) {
          $details[] = $this
            ->t('ID: %property', [
            '%property' => $property,
          ]);
        }
        if ($property = $definition
          ->getDescription()) {
          $details[] = $this
            ->t('Description: %property', [
            '%property' => $property,
          ]);
        }
        if ($property = $definition
          ->getProvider()) {
          $details[] = $this
            ->t('Provider: %property', [
            '%property' => $property,
          ]);
        }
        if ($property = $definition
          ->getDefaultRegion()) {
          $details[] = $this
            ->t('Default region: %property', [
            '%property' => $property,
          ]);
        }
        if ($property = $definition
          ->getLibrary()) {
          $details[] = $this
            ->t('Library: %property', [
            '%property' => $property,
          ]);
        }
        $build = [];
        if ($region_labels = $definition
          ->getRegionLabels()) {
          $regions = [];
          foreach ($region_labels as $id => $label) {
            $regions[$id] = [
              '#type' => 'inline_template',
              '#template' => '<span class="block-region demo-block">{{ label }} ({{ id }})</span>',
              '#context' => [
                'id' => $id,
                'label' => $label,
              ],
            ];
          }
          $layoutInstance = $this->layoutPluginManager
            ->createInstance($definition
            ->id());
          $build = $layoutInstance
            ->build($regions);
        }
        $items[$group]['content'][$layout] = [
          '#type' => 'details',
          '#title' => $definition
            ->getLabel(),
          '#open' => FALSE,
          '#description' => [
            'info' => [
              '#type' => 'container',
              '#attributes' => [
                'class' => 'styleguide__layout-info',
              ],
              'icon' => $definition
                ->getIcon(60, 80, 1, 3),
              'details' => [
                '#theme' => 'item_list',
                '#items' => $details,
              ],
            ],
            'body' => [
              'build' => $build,
            ],
          ],
        ];
      }
    }
    return $items;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
LayoutStyleguide::$generator	protected	property	The styleguide generator service.
LayoutStyleguide::$layoutPluginManager	protected	property	The layout plugin manager.
LayoutStyleguide::$moduleHandler	protected	property	The module handler service.
LayoutStyleguide::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
LayoutStyleguide::items	public	function	Styleguide elements implementation. Overrides StyleguideInterface::items
LayoutStyleguide::__construct	public	function	Constructs a new LayoutStyleguide object. Overrides PluginBase::__construct
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	2
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
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.
StyleguidePluginBase::buildLink	public	function	Build a link.
StyleguidePluginBase::buildLinkFromRoute	public	function	Build a link from a given route name and parameters.

You are here

class LayoutStyleguide in Style Guide 2.x

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation