You are here

Home » API reference » Metatag 8 » MetatagController.php

class MetatagController in Metatag 8

Returns responses for Metatag routes.

Hierarchy

Expanded class hierarchy of MetatagController

File

src/Controller/MetatagController.php, line 14

Namespace

Drupal\metatag\Controller
View source 
class MetatagController extends ControllerBase {
  use StringTranslationTrait;

  /**
   * Metatag tag plugin manager.
   *
   * @var \Drupal\metatag\MetatagTagPluginManager
   */
  protected $tagManager;

  /**
   * Metatag group plugin manager.
   *
   * @var \Drupal\metatag\MetatagGroupPluginManager
   */
  protected $groupManager;

  /**
   * Constructs a new \Drupal\views_ui\Controller\ViewsUIController object.
   *
   * @param \Drupal\metatag\MetatagTagPluginManager $tag_manaager
   *   The tag manager object.
   * @param \Drupal\metatag\MetatagGroupPluginManager $group_manager
   *   The group manager object.
   */
  public function __construct(MetatagTagPluginManager $tag_manaager, MetatagGroupPluginManager $group_manager) {
    $this->tagManager = $tag_manaager;
    $this->groupManager = $group_manager;
  }

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

  /**
   * Lists all plugins.
   *
   * @return array
   *   The Metatag plugins report page.
   */
  public function reportPlugins() {

    // Get tags.
    $tag_definitions = $this->tagManager
      ->getDefinitions();
    uasort($tag_definitions, [
      'Drupal\\Component\\Utility\\SortArray',
      'sortByWeightElement',
    ]);
    $tags = [];
    foreach ($tag_definitions as $tag_name => $tag_definition) {
      $tags[$tag_definition['group']][$tag_name] = $tag_definition;
    }

    // Get groups.
    $group_definitions = $this->groupManager
      ->getDefinitions();
    uasort($group_definitions, [
      'Drupal\\Component\\Utility\\SortArray',
      'sortByWeightElement',
    ]);

    // Build plugin by group.
    $build = [];
    foreach ($group_definitions as $group_name => $group_definition) {
      $build[$group_name] = [];

      // Group title.
      $build[$group_name]['title'] = [
        '#markup' => $group_definition['label'] . ' (' . $group_name . ')',
        '#prefix' => '<h2>',
        '#suffix' => '</h2>',
      ];

      // Group description.
      $build[$group_name]['description'] = [
        '#markup' => $group_definition['description'],
        '#prefix' => '<p>',
        '#suffix' => '</p>',
      ];
      $rows = [];
      foreach ($tags[$group_name] as $definition) {
        $row = [];
        $row['label'] = [
          'data' => [
            'label' => [
              '#markup' => $definition['label'],
              '#prefix' => '<h3>',
              '#suffix' => '</h3>',
            ],
          ],
        ];
        $row['name'] = [
          'data' => $definition['name'],
          'nowrap' => 'nowrap',
        ];
        $row['id'] = $definition['id'];
        $row['type'] = $definition['type'];
        $row['weight'] = $definition['weight'];
        $row['secure'] = $definition['secure'] ? $this
          ->t('Yes') : $this
          ->t('No');
        $row['multiple'] = $definition['multiple'] ? $this
          ->t('Yes') : $this
          ->t('No');
        $row['provider'] = $definition['provider'];
        $key = $definition['group'] . '.' . $definition['id'];
        $rows[$key] = $row;
        $row = [];
        $row['description'] = [
          'data' => [
            '#markup' => $definition['description'],
          ],
          'colspan' => 8,
        ];
        $rows[$key . '_desc'] = $row;
      }
      ksort($rows);
      $build[$group_name]['tags'] = [
        '#type' => 'table',
        '#header' => [
          [
            'data' => $this
              ->t('Label / Description'),
          ],
          [
            'data' => $this
              ->t('Name'),
          ],
          [
            'data' => $this
              ->t('ID'),
            'class' => [
              RESPONSIVE_PRIORITY_LOW,
            ],
          ],
          [
            'data' => $this
              ->t('Type'),
            'class' => [
              RESPONSIVE_PRIORITY_LOW,
            ],
          ],
          [
            'data' => $this
              ->t('Weight'),
            'class' => [
              RESPONSIVE_PRIORITY_LOW,
            ],
          ],
          [
            'data' => $this
              ->t('Secure'),
            'class' => [
              RESPONSIVE_PRIORITY_LOW,
            ],
          ],
          [
            'data' => $this
              ->t('Multiple'),
            'class' => [
              RESPONSIVE_PRIORITY_LOW,
            ],
          ],
          [
            'data' => $this
              ->t('Provided by'),
          ],
        ],
        '#rows' => $rows,
        '#suffix' => '<br /><br />',
        '#caption' => $this
          ->t('All meta tags in the "@group" group.', [
          '@group' => $group_definition['label'],
        ]),
        '#sticky' => TRUE,
      ];
    }
    return $build;
  }

}

Members

Namesort descending 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.
MetatagController::$groupManager protected property Metatag group plugin manager.
MetatagController::$tagManager protected property Metatag tag plugin manager.
MetatagController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
MetatagController::reportPlugins public function Lists all plugins.
MetatagController::__construct public function Constructs a new \Drupal\views_ui\Controller\ViewsUIController object.
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.