class PatternsLibraryController in UI Patterns 8

Class PatternLibraryController.

@package Drupal\ui_patterns\Controller

Hierarchy

class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\ui_patterns_library\Controller\PatternsLibraryController

Expanded class hierarchy of PatternsLibraryController

File

modules/ui_patterns_library/src/Controller/PatternsLibraryController.php, line 15

Namespace

Drupal\ui_patterns_library\Controller

View source

class PatternsLibraryController extends ControllerBase {

  /**
   * Patterns manager service.
   *
   * @var \Drupal\ui_patterns\UiPatternsManager
   */
  protected $patternsManager;

  /**
   * {@inheritdoc}
   */
  public function __construct(UiPatternsManager $ui_patterns_manager) {
    $this->patternsManager = $ui_patterns_manager;
  }

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

  /**
   * Title callback.
   *
   * @return string
   *   Pattern label.
   */
  public function title($name) {
    return $this->patternsManager
      ->getDefinition($name)
      ->getLabel();
  }

  /**
   * Render pattern library page.
   *
   * @param string $name
   *   Plugin ID.
   *
   * @return array
   *   Return render array.
   */
  public function single($name) {
    $definition = $this->patternsManager
      ->getDefinition($name);
    return [
      '#theme' => 'patterns_single_page',
      '#pattern' => [
        'meta' => [
          '#theme' => 'patterns_meta_information',
          '#pattern' => $definition
            ->toArray(),
        ],
        'rendered' => $this
          ->getPatternRenderArray($definition),
        'definition' => $definition
          ->toArray(),
      ],
    ];
  }

  /**
   * Render pattern library page.
   *
   * @return array
   *   Patterns overview page render array.
   */
  public function overview() {
    $patterns = [];
    foreach ($this->patternsManager
      ->getDefinitions() as $definition) {
      $patterns[$definition
        ->id()] = $definition
        ->toArray() + [
        'meta' => [
          '#theme' => 'patterns_meta_information',
          '#pattern' => $definition
            ->toArray(),
        ],
        'rendered' => $this
          ->getPatternRenderArray($definition),
        'definition' => $definition
          ->toArray(),
      ];
    }
    return [
      '#theme' => 'patterns_overview_page',
      '#patterns' => $patterns,
    ];
  }

  /**
   * Get pattern preview render array, handling variants.
   *
   * @param \Drupal\ui_patterns\Definition\PatternDefinition $definition
   *   Pattern definition object.
   *
   * @return array
   *   Render array.
   */
  protected function getPatternRenderArray(PatternDefinition $definition) {
    $render = [];

    // If pattern has variants then render them all adding meta information
    // on top of each one, or simply render pattern preview otherwise.
    if ($definition
      ->hasVariants()) {
      foreach ($definition
        ->getVariants() as $variant) {
        $render[$definition
          ->id() . '_' . $variant
          ->getName()] = [
          'meta' => [
            '#theme' => 'patterns_variant_meta_information',
            '#variant' => $variant
              ->toArray(),
          ],
          'pattern' => [
            '#type' => 'pattern_preview',
            '#id' => $definition
              ->id(),
            '#variant' => $variant
              ->getName(),
            '#theme_wrappers' => [
              'container' => [
                '#attributes' => [
                  'class' => 'pattern-preview__markup pattern-preview__markup--variant_' . $variant
                    ->getName(),
                ],
              ],
            ],
          ],
        ];
      }
    }
    else {
      $render[$definition
        ->id()] = [
        'pattern' => [
          '#type' => 'pattern_preview',
          '#id' => $definition
            ->id(),
          '#theme_wrappers' => [
            'container' => [
              '#attributes' => [
                'class' => 'pattern-preview__markup',
              ],
            ],
          ],
        ],
      ];
    }
    return $render;
  }

}

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.
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.
PatternsLibraryController::$patternsManager	protected	property	Patterns manager service.
PatternsLibraryController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
PatternsLibraryController::getPatternRenderArray	protected	function	Get pattern preview render array, handling variants.
PatternsLibraryController::overview	public	function	Render pattern library page.
PatternsLibraryController::single	public	function	Render pattern library page.
PatternsLibraryController::title	public	function	Title callback.
PatternsLibraryController::__construct	public	function
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 PatternsLibraryController in UI Patterns 8

Hierarchy

File

Namespace

Members

API Navigation