class Menu in Sitemap 8.2

Provides a sitemap for an individual menu.

Plugin annotation

@Sitemap(
  id = "menu",
  title = @Translation("Menu name"),
  description = @Translation("Menu description"),
  settings = {
    "title" = "",
    "show_disabled" = FALSE,
  },
  deriver = "Drupal\sitemap\Plugin\Derivative\MenuSitemapDeriver",
  enabled = FALSE,
  menu = "",
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\sitemap\SitemapBase implements SitemapInterface uses StringTranslationTrait
    • class \Drupal\sitemap\Plugin\Sitemap\Menu

File

src/Plugin/Sitemap/Menu.php, line 26

Namespace

Drupal\sitemap\Plugin\Sitemap

class Menu extends SitemapBase {

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $form = parent::settingsForm($form, $form_state);

    // Provide the menu name as the default title.
    $menu_name = $this
      ->getPluginDefinition()['menu'];
    $menu = \Drupal::entityTypeManager()
      ->getStorage('menu')
      ->load($menu_name);
    $form['title']['#default_value'] = $this->settings['title'] ?: $menu
      ->label();
    $form['show_disabled'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Show disabled menu items'),
      '#default_value' => isset($this->settings['show_disabled']) ? $this->settings['show_disabled'] : FALSE,
      '#description' => $this
        ->t('When selected, disabled menu links will also be shown.'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function view() {
    $menuLinkTree = \Drupal::service('sitemap.menu.link_tree');
    $menu_id = $this->pluginDefinition['menu'];
    $menu = MenuEntity::load($menu_id);

    // Retrieve the expanded tree.
    $parameters = new MenuTreeParameters();
    if (!$this->settings['show_disabled']) {
      $parameters
        ->onlyEnabledLinks();
    }
    $tree = $menuLinkTree
      ->load($menu_id, $parameters);
    $manipulators = [
      [
        'callable' => 'menu.default_tree_manipulators:checkAccess',
      ],
      [
        'callable' => 'menu.default_tree_manipulators:generateIndexAndSort',
      ],
    ];
    $tree = $menuLinkTree
      ->transform($tree, $manipulators);

    // Add an alter hook so that other modules can manipulate the
    // menu tree prior to rendering.
    // @TODO: Document
    $alter_mid = preg_replace('/[^a-z0-9_]+/', '_', $menu_id);
    \Drupal::moduleHandler()
      ->alter([
      'sitemap_menu_tree',
      'sitemap_menu_tree_' . $alter_mid,
    ], $tree, $menu);
    $menu_display = $menuLinkTree
      ->build($tree);
    return [
      '#theme' => 'sitemap_item',
      '#title' => $this->settings['title'],
      '#content' => $menu_display,
      '#sitemap' => $this,
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Menu::settingsForm	public	function	Returns a form to configure settings for the mapping. Overrides SitemapBase::settingsForm
Menu::view	public	function	Builds a renderable array for a sitemap item. Overrides SitemapInterface::view
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	3
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.
SitemapBase::$enabled	public	property	A Boolean indicating whether this mapping is enabled.
SitemapBase::$provider	public	property	The name of the provider that owns this mapping.
SitemapBase::$settings	public	property	An associative array containing the configured settings of the sitemap_map.
SitemapBase::$sitemapConfig	protected	property	The global sitemap config.
SitemapBase::$weight	public	property	The weight of this mapping compared to others in the sitemap.
SitemapBase::baseConfigurationDefaults	protected	function	Returns generic default configuration for sitemap plugins.
SitemapBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
SitemapBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration
SitemapBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
SitemapBase::getDescription	public	function	Returns the administrative description for this mapping plugin. Overrides SitemapInterface::getDescription
SitemapBase::getLabel	public	function	Returns the administrative label for this mapping plugin. Overrides SitemapInterface::getLabel
SitemapBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
SitemapBase::settingsSummary	public	function	Returns a short summary for the current mapping settings. Overrides SitemapInterface::settingsSummary
SitemapBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct
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.