You are here

class EntityMenuLinkContentUrlGenerator in Simple XML sitemap 4.x

Same name and namespace in other branches
  1. 8.3 src/Plugin/simple_sitemap/UrlGenerator/EntityMenuLinkContentUrlGenerator.php \Drupal\simple_sitemap\Plugin\simple_sitemap\UrlGenerator\EntityMenuLinkContentUrlGenerator
  2. 8.2 src/Plugin/simple_sitemap/UrlGenerator/EntityMenuLinkContentUrlGenerator.php \Drupal\simple_sitemap\Plugin\simple_sitemap\UrlGenerator\EntityMenuLinkContentUrlGenerator

Class EntityMenuLinkContentUrlGenerator

@UrlGenerator( id = "entity_menu_link_content", label = @Translation("Menu link URL generator"), description = @Translation("Generates menu link URLs by overriding the 'entity' URL generator."), settings = { "overrides_entity_type" = "menu_link_content", }, )

@todo Find way of adding just a menu link item pointer to the queue instead of whole object.

Hierarchy

Expanded class hierarchy of EntityMenuLinkContentUrlGenerator

File

src/Plugin/simple_sitemap/UrlGenerator/EntityMenuLinkContentUrlGenerator.php, line 32

Namespace

Drupal\simple_sitemap\Plugin\simple_sitemap\UrlGenerator
View source
class EntityMenuLinkContentUrlGenerator extends EntityUrlGeneratorBase {

  /**
   * @var \Drupal\Core\Menu\MenuLinkTree
   */
  protected $menuLinkTree;

  /**
   * @var \Drupal\simple_sitemap\Manager\EntityManager
   */
  protected $entitiesManager;

  /**
   * EntityMenuLinkContentUrlGenerator constructor.
   *
   * @param array $configuration
   * @param $plugin_id
   * @param $plugin_definition
   * @param \Drupal\simple_sitemap\Logger $logger
   * @param \Drupal\simple_sitemap\Settings $settings
   * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   * @param \Drupal\simple_sitemap\Entity\EntityHelper $entity_helper
   * @param \Drupal\simple_sitemap\Manager\EntityManager $entities_manager
   * @param \Drupal\Core\Menu\MenuLinkTreeInterface $menu_link_tree
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, Logger $logger, Settings $settings, LanguageManagerInterface $language_manager, EntityTypeManagerInterface $entity_type_manager, EntityHelper $entity_helper, EntityManager $entities_manager, MenuLinkTreeInterface $menu_link_tree) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $logger, $settings, $language_manager, $entity_type_manager, $entity_helper);
    $this->entitiesManager = $entities_manager;
    $this->menuLinkTree = $menu_link_tree;
  }
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) : SimpleSitemapPluginBase {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('simple_sitemap.logger'), $container
      ->get('simple_sitemap.settings'), $container
      ->get('language_manager'), $container
      ->get('entity_type.manager'), $container
      ->get('simple_sitemap.entity_helper'), $container
      ->get('simple_sitemap.entity_manager'), $container
      ->get('menu.link_tree'));
  }

  /**
   * @inheritdoc
   */
  public function getDataSets() : array {
    $data_sets = [];
    $bundle_settings = $this->entitiesManager
      ->setVariants($this->sitemapVariant
      ->id())
      ->getBundleSettings();
    if (!empty($bundle_settings['menu_link_content'])) {
      foreach ($bundle_settings['menu_link_content'] as $bundle_name => $bundle_settings) {
        if ($bundle_settings['index']) {

          // Retrieve the expanded tree.
          $tree = $this->menuLinkTree
            ->load($bundle_name, new MenuTreeParameters());
          $tree = $this->menuLinkTree
            ->transform($tree, [
            [
              'callable' => 'menu.default_tree_manipulators:generateIndexAndSort',
            ],
            [
              'callable' => 'menu.default_tree_manipulators:flatten',
            ],
          ]);
          foreach ($tree as $item) {
            $data_sets[] = $item->link;
          }
        }
      }
    }
    return $data_sets;
  }

  /**
   * @inheritdoc
   *
   * @todo Find a way to be able to check if a menu link still exists. This is difficult as we don't operate on MenuLinkContent entities, but on Link entities directly (as some menu links are not MenuLinkContent entities).
   */
  protected function processDataSet($data_set) : array {

    /** @var  MenuLinkBase $data_set */
    if (!$data_set
      ->isEnabled()) {
      throw new SkipElementException();
    }
    $url_object = $data_set
      ->getUrlObject()
      ->setAbsolute();

    // Do not include external paths.
    if ($url_object
      ->isExternal()) {
      throw new SkipElementException();
    }

    // If not a menu_link_content link, use bundle settings.
    $meta_data = $data_set
      ->getMetaData();
    if (empty($meta_data['entity_id'])) {
      $entity_settings = $this->entitiesManager
        ->setVariants($this->sitemapVariant
        ->id())
        ->getBundleSettings('menu_link_content', $data_set
        ->getMenuName());
    }
    else {
      $entity_settings = $this->entitiesManager
        ->setVariants($this->sitemapVariant
        ->id())
        ->getEntityInstanceSettings('menu_link_content', $meta_data['entity_id']);
      if (empty($entity_settings['index'])) {
        throw new SkipElementException();
      }
    }
    if ($url_object
      ->isRouted()) {

      // Do not include paths that have no URL.
      if (in_array($url_object
        ->getRouteName(), [
        '<nolink>',
        '<none>',
      ])) {
        throw new SkipElementException();
      }
      $path = $url_object
        ->getInternalPath();
    }
    else {

      // Handle base scheme.
      if (strpos($uri = $url_object
        ->toUriString(), 'base:/') === 0) {
        $path = $uri[6] === '/' ? substr($uri, 7) : substr($uri, 6);
      }
      else {

        // Handle unforeseen schemes.
        $path = $uri;
      }
    }
    $entity = $this->entityHelper
      ->getEntityFromUrlObject($url_object);
    $path_data = [
      'url' => $url_object,
      'lastmod' => !empty($entity) && method_exists($entity, 'getChangedTime') ? date('c', $entity
        ->getChangedTime()) : NULL,
      'priority' => $entity_settings['priority'] ?? NULL,
      'changefreq' => !empty($entity_settings['changefreq']) ? $entity_settings['changefreq'] : NULL,
      'images' => !empty($entity_settings['include_images']) && !empty($entity) ? $this
        ->getEntityImageData($entity) : [],
      // Additional info useful in hooks.
      'meta' => [
        'path' => $path,
      ],
    ];
    if (!empty($entity)) {
      $path_data['meta']['entity_info'] = [
        'entity_type' => $entity
          ->getEntityTypeId(),
        'id' => $entity
          ->id(),
      ];
    }
    return $path_data;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
EntityMenuLinkContentUrlGenerator::$entitiesManager protected property
EntityMenuLinkContentUrlGenerator::$menuLinkTree protected property
EntityMenuLinkContentUrlGenerator::create public static function Creates an instance of the plugin. Overrides EntityUrlGeneratorBase::create
EntityMenuLinkContentUrlGenerator::getDataSets public function @inheritdoc Overrides UrlGeneratorBase::getDataSets
EntityMenuLinkContentUrlGenerator::processDataSet protected function @inheritdoc Overrides UrlGeneratorBase::processDataSet
EntityMenuLinkContentUrlGenerator::__construct public function EntityMenuLinkContentUrlGenerator constructor. Overrides EntityUrlGeneratorBase::__construct
EntityUrlGeneratorBase::$anonUser protected property
EntityUrlGeneratorBase::$defaultLanguageId protected property
EntityUrlGeneratorBase::$entityHelper protected property
EntityUrlGeneratorBase::$entityTypeManager protected property
EntityUrlGeneratorBase::$languages protected property
EntityUrlGeneratorBase::generate public function Overrides UrlGeneratorBase::generate 1
EntityUrlGeneratorBase::getAlternateUrlsForAllLanguages protected function
EntityUrlGeneratorBase::getAlternateUrlsForDefaultLanguage protected function
EntityUrlGeneratorBase::getAlternateUrlsForTranslatedLanguages protected function
EntityUrlGeneratorBase::getEntityImageData protected function
EntityUrlGeneratorBase::getUrlVariants protected function
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.
SimpleSitemapPluginBase::description public function Overrides SimpleSitemapPluginInterface::description
SimpleSitemapPluginBase::label public function Overrides SimpleSitemapPluginInterface::label
SimpleSitemapPluginBase::settings public function Overrides SimpleSitemapPluginInterface::settings
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.
UrlGeneratorBase::$logger protected property
UrlGeneratorBase::$settings protected property
UrlGeneratorBase::$sitemapVariant protected property
UrlGeneratorBase::replaceBaseUrlWithCustom protected function
UrlGeneratorBase::setSitemapVariant public function Overrides UrlGeneratorInterface::setSitemapVariant