class DefaultSitemapGenerator in Simple XML sitemap 8.3

Same name and namespace in other branches

4.x src/Plugin/simple_sitemap/SitemapGenerator/DefaultSitemapGenerator.php \Drupal\simple_sitemap\Plugin\simple_sitemap\SitemapGenerator\DefaultSitemapGenerator

Class DefaultSitemapGenerator @package Drupal\simple_sitemap\Plugin\simple_sitemap\SitemapGenerator

Plugin annotation


@SitemapGenerator(
  id = "default",
  label = @Translation("Default sitemap generator"),
  description = @Translation("Generates a standard conform hreflang sitemap of your content."),
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\simple_sitemap\Plugin\simple_sitemap\SimplesitemapPluginBase implements PluginInspectionInterface, ContainerFactoryPluginInterface
    class \Drupal\simple_sitemap\Plugin\simple_sitemap\SitemapGenerator\SitemapGeneratorBase implements SitemapGeneratorInterface
    class \Drupal\simple_sitemap\Plugin\simple_sitemap\SitemapGenerator\DefaultSitemapGenerator

Expanded class hierarchy of DefaultSitemapGenerator

File

src/Plugin/simple_sitemap/SitemapGenerator/DefaultSitemapGenerator.php, line 15

Namespace

Drupal\simple_sitemap\Plugin\simple_sitemap\SitemapGenerator

View source

class DefaultSitemapGenerator extends SitemapGeneratorBase {
  const XMLNS_XHTML = 'http://www.w3.org/1999/xhtml';
  const XMLNS_IMAGE = 'http://www.google.com/schemas/sitemap-image/1.1';

  /**
   * @var bool
   */
  protected $isHreflangSitemap;

  /**
   * @var array
   */
  protected static $attributes = [
    'xmlns' => self::XMLNS,
    'xmlns:xhtml' => self::XMLNS_XHTML,
    'xmlns:image' => self::XMLNS_IMAGE,
  ];

  /**
   * 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();

    // Add the XML stylesheet to document if enabled.
    if ($this->settings['xsl']) {
      $this->writer
        ->writeXsl();
    }
    $this->writer
      ->writeGeneratedBy();
    $this->writer
      ->startElement('urlset');
    $this
      ->addSitemapAttributes();
    $this
      ->addLinks($links);
    $this->writer
      ->endElement();
    $this->writer
      ->endDocument();
    return $this->writer
      ->outputMemory();
  }

  /**
   * Adds attributes to the sitemap.
   */
  protected function addSitemapAttributes() {
    $attributes = self::$attributes;
    if (!$this
      ->isHreflangSitemap()) {
      unset($attributes['xmlns:xhtml']);
    }
    $sitemap_variant = $this->sitemapVariant;
    $this->moduleHandler
      ->alter('simple_sitemap_attributes', $attributes, $sitemap_variant);
    foreach ($attributes as $name => $value) {
      $this->writer
        ->writeAttribute($name, $value);
    }
  }

  /**
   * Adds URL elements to the sitemap.
   *
   * @param array $links
   */
  protected function addLinks(array $links) {
    foreach ($links as $url_data) {
      $this->writer
        ->startElement('url');
      $this
        ->addUrl($url_data);
      $this->writer
        ->endElement();
    }
  }

  /**
   * Adds a URL element to the sitemap.
   *
   * @param array $url_data
   *   The array of properties for this URL.
   */
  protected function addUrl(array $url_data) {
    $this->writer
      ->writeElement('loc', $url_data['url']);

    // If more than one language is enabled, add all translation variant URLs
    // as alternate links to this link turning the sitemap into a hreflang
    // sitemap.
    if (isset($url_data['alternate_urls']) && $this
      ->isHreflangSitemap()) {
      $this
        ->addAlternateUrls($url_data['alternate_urls']);
    }

    // Add lastmod if any.
    if (isset($url_data['lastmod'])) {
      $this->writer
        ->writeElement('lastmod', $url_data['lastmod']);
    }

    // Add changefreq if any.
    if (isset($url_data['changefreq'])) {
      $this->writer
        ->writeElement('changefreq', $url_data['changefreq']);
    }

    // Add priority if any.
    if (isset($url_data['priority'])) {
      $this->writer
        ->writeElement('priority', $url_data['priority']);
    }

    // Add images if any.
    if (!empty($url_data['images'])) {
      foreach ($url_data['images'] as $image) {
        $this->writer
          ->startElement('image:image');
        $this->writer
          ->writeElement('image:loc', $image['path']);
        if (strlen($image['title']) > 0) {
          $this->writer
            ->writeElement('image:title', $image['title']);
        }
        if (strlen($image['alt']) > 0) {
          $this->writer
            ->writeElement('image:caption', $image['alt']);
        }
        $this->writer
          ->endElement();
      }
    }
  }

  /**
   * Adds all translation variant URLs as alternate URLs to a URL.
   *
   * @param array $alternate_urls
   */
  protected function addAlternateUrls(array $alternate_urls) {
    foreach ($alternate_urls as $language_id => $alternate_url) {
      $this->writer
        ->startElement('xhtml:link');
      $this
        ->addAlternateUrl($language_id, $alternate_url);
      $this->writer
        ->endElement();
    }
  }

  /**
   * Adds a translation variant URL as alternate URL to a URL.
   *
   * @param $language_id
   * @param $alternate_url
   */
  protected function addAlternateUrl($language_id, $alternate_url) {
    $this->writer
      ->writeAttribute('rel', 'alternate');
    $this->writer
      ->writeAttribute('hreflang', $language_id);
    $this->writer
      ->writeAttribute('href', $alternate_url);
  }

  /**
   * Checks if sitemap is hreflang compliant.
   *
   * @return bool
   */
  protected function isHreflangSitemap() {
    return NULL !== $this->isHreflangSitemap ? $this->isHreflangSitemap : self::isMultilingualSitemap();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DefaultSitemapGenerator::$attributes	protected static	property
DefaultSitemapGenerator::$isHreflangSitemap	protected	property
DefaultSitemapGenerator::addAlternateUrl	protected	function	Adds a translation variant URL as alternate URL to a URL.
DefaultSitemapGenerator::addAlternateUrls	protected	function	Adds all translation variant URLs as alternate URLs to a URL.
DefaultSitemapGenerator::addLinks	protected	function	Adds URL elements to the sitemap.
DefaultSitemapGenerator::addSitemapAttributes	protected	function	Adds attributes to the sitemap.
DefaultSitemapGenerator::addUrl	protected	function	Adds a URL element to the sitemap.
DefaultSitemapGenerator::getXml	protected	function	Generates and returns a sitemap chunk. Overrides SitemapGeneratorBase::getXml
DefaultSitemapGenerator::isHreflangSitemap	protected	function	Checks if sitemap is hreflang compliant.
DefaultSitemapGenerator::XMLNS_IMAGE		constant
DefaultSitemapGenerator::XMLNS_XHTML		constant
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
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	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.
SitemapGeneratorBase::$db	protected	property
SitemapGeneratorBase::$indexAttributes	protected static	property
SitemapGeneratorBase::$languageManager	protected	property
SitemapGeneratorBase::$moduleHandler	protected	property
SitemapGeneratorBase::$settings	protected	property
SitemapGeneratorBase::$sitemapUrlSettings	protected	property
SitemapGeneratorBase::$sitemapVariant	protected	property
SitemapGeneratorBase::$time	protected	property
SitemapGeneratorBase::$writer	protected	property
SitemapGeneratorBase::create	public static	function	Creates an instance of the plugin. Overrides SimplesitemapPluginBase::create
SitemapGeneratorBase::FIRST_CHUNK_DELTA		constant
SitemapGeneratorBase::generate	public	function	Overrides SitemapGeneratorInterface::generate
SitemapGeneratorBase::generateIndex	public	function	Overrides SitemapGeneratorInterface::generateIndex
SitemapGeneratorBase::getChunkInfo	protected	function
SitemapGeneratorBase::getCustomBaseUrl	protected	function
SitemapGeneratorBase::getIndexXml	protected	function
SitemapGeneratorBase::getSitemapUrl	public	function	Overrides SitemapGeneratorInterface::getSitemapUrl
SitemapGeneratorBase::getSitemapUrlSettings	protected	function
SitemapGeneratorBase::INDEX_DELTA		constant
SitemapGeneratorBase::isDefaultVariant	protected	function
SitemapGeneratorBase::isMultilingualSitemap	public static	function	Determines if the sitemap is to be a multilingual sitemap based on several factors.
SitemapGeneratorBase::publish	public	function	Overrides SitemapGeneratorInterface::publish
SitemapGeneratorBase::purgeSitemapVariants	public static	function
SitemapGeneratorBase::remove	public	function	Overrides SitemapGeneratorInterface::remove
SitemapGeneratorBase::setSettings	public	function	Overrides SitemapGeneratorInterface::setSettings
SitemapGeneratorBase::setSitemapVariant	public	function	Overrides SitemapGeneratorInterface::setSitemapVariant
SitemapGeneratorBase::XMLNS		constant
SitemapGeneratorBase::__construct	public	function	SitemapGeneratorBase constructor. Overrides SimplesitemapPluginBase::__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.

You are here

class DefaultSitemapGenerator in Simple XML sitemap 8.3

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation