Sitemap of sitemaps

Sitemap.php

<?php

namespace Drupal\mymodule\Plugin\simple_sitemap\SitemapGenerator;

use Drupal\simple_sitemap\Plugin\simple_sitemap\SitemapGenerator\SitemapGeneratorBase;

/**
 * Class Sitemap.
 *
 * @package Drupal\mymodule\Plugin\simple_sitemap\SitemapGenerator
 *
 * @SitemapGenerator(
 *   id = "mymodule_sitemap",
 *   label = @Translation("Sitemap index"),
 *   description = @Translation("Generates a sitemap index of all sitemaps."),
 * )
 */
class Sitemap extends SitemapGeneratorBase {

  /**
   * Generates and returns a sitemap chunk.
   *
   * @param array $links
   *   All links with their multilingual versions and settings.
   *
   * @return string
   *   Sitemap chunk.
   */
  protected function getXml(array $links) {
    $this->writer->openMemory();
    $this->writer->setIndent(TRUE);
    $this->writer->startSitemapDocument();
    $this->writer->writeGeneratedBy();
    $this->writer->startElement('sitemapindex');

    // Add attributes to document.
    $attributes = self::$indexAttributes;
    foreach ($attributes as $name => $value) {
      $this->writer->writeAttribute($name, $value);
    }

    // Add all of the variant links.
    foreach ($links as $link) {
      $this->writer->startElement('sitemap');
      $this->writer->writeElement('loc', $link['url']);
      $this->writer->endElement();
    }

    $this->writer->endElement();
    $this->writer->endDocument();

    return $this->writer->outputMemory();
  }

}

SitemapOfSitemapsType.php

<?php

namespace Drupal\mymodule\Plugin\simple_sitemap\SitemapType;

/**
 * Class SitemapOfSitemapsType.
 *
 * @package Drupal\mymodule\Plugin\simple_sitemap\SitemapType
 *
 * @SitemapType(
 *   id = "mymodule_sitemap_of_sitemaps",
 *   label = @Translation("Sitemap of Sitemaps"),
 *   description = @Translation("The sitemap of sitemaps type."),
 *   sitemapGenerator = "mymodule_sitemap",
 *   urlGenerators = {
 *     "mymodule_variant_url_generator"
 *   },
 * )
 */
class SitemapOfSitemapsType extends SitemapTypeBase {
}

VariantUrlGenerator.php

<?php

namespace Drupal\mymodule\Plugin\simple_sitemap\UrlGenerator;

use Drupal\simple_sitemap\Plugin\simple_sitemap\UrlGenerator\EntityUrlGeneratorBase;
use Drupal\Core\Url;
use Drupal\simple_sitemap\Annotation\UrlGenerator;
use Drupal\simple_sitemap\EntityHelper;
use Drupal\simple_sitemap\Logger;
use Drupal\simple_sitemap\Simplesitemap;
use Drupal\Core\Language\LanguageManagerInterface;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Path\PathValidator;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Class VariantUrlGenerator.
 *
 * @package Drupal\mymodule\Plugin\simple_sitemap\UrlGenerator
 *
 * @UrlGenerator(
 *   id = "mymodule_variant_url_generator",
 *   label = @Translation("DU Variant URL generator"),
 *   description = @Translation("Generates URLs for variants."),
 * )
 */
class VariantUrlGenerator extends EntityUrlGeneratorBase {

  /**
   * Path validator.
   *
   * @var \Drupal\Core\Path\PathValidator
   */
  protected $pathValidator;

  /**
   * {@inheritdoc}
   */
  public function __construct(
    array $configuration,
    $plugin_id,
    $plugin_definition,
    Simplesitemap $generator,
    Logger $logger,
    LanguageManagerInterface $language_manager,
    EntityTypeManagerInterface $entity_type_manager,
    EntityHelper $entityHelper,
    PathValidator $path_validator) {
    parent::__construct(
      $configuration,
      $plugin_id,
      $plugin_definition,
      $generator,
      $logger,
      $language_manager,
      $entity_type_manager,
      $entityHelper
    );
    $this->pathValidator = $path_validator;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(
    ContainerInterface $container,
    array $configuration,
    $plugin_id,
    $plugin_definition) {
    return new static(
      $configuration,
      $plugin_id,
      $plugin_definition,
      $container->get('simple_sitemap.generator'),
      $container->get('simple_sitemap.logger'),
      $container->get('language_manager'),
      $container->get('entity_type.manager'),
      $container->get('simple_sitemap.entity_helper'),
      $container->get('path.validator')
    );
  }

  /**
   * {@inheritdoc}
   */
  public function getDataSets() {
    $variants = $this->generator->getSitemapManager()->getSitemapVariants();
    foreach ($variants as $key => &$variant) {
      $variant['path'] = '/' . $key . '/sitemap.xml';

      // Don't include sitemap of sitemaps.
      if ($variant['type'] == 'mymodule_sitemap_of_sitemaps') {
        unset($variants[$key]);
      }
    }
    return $variants;
  }

  /**
   * {@inheritdoc}
   */
  protected function processDataSet($data_set) {
    if (!(bool) $this->pathValidator->getUrlIfValidWithoutAccessCheck($data_set['path'])) {
      $this->logger->m(self::PATH_DOES_NOT_EXIST_MESSAGE,
        ['@path' => $data_set['path'], '@custom_paths_url' => $GLOBALS['base_url'] . '/admin/config/search/simplesitemap/custom'])
        ->display('warning', 'administer sitemap settings')
        ->log('warning');
      return FALSE;
    }

    $url_object = Url::fromUserInput($data_set['path'], ['absolute' => TRUE]);
    $path = $url_object->getInternalPath();

    $path_data = [
      'url' => $url_object,
      'lastmod' => NULL,
      'priority' => isset($data_set['priority']) ? $data_set['priority'] : NULL,
      'changefreq' => !empty($data_set['changefreq']) ? $data_set['changefreq'] : NULL,
      'images' => [],
      'meta' => [
        'path' => $path,
      ],
    ];

    return $path_data;
  }

}