abstract class UrlGeneratorBase in Simple XML sitemap 4.x

Class UrlGeneratorBase

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 SimpleSitemapPluginInterface
      • class \Drupal\simple_sitemap\Plugin\simple_sitemap\UrlGenerator\UrlGeneratorBase implements UrlGeneratorInterface

File

src/Plugin/simple_sitemap/UrlGenerator/UrlGeneratorBase.php, line 15

Namespace

Drupal\simple_sitemap\Plugin\simple_sitemap\UrlGenerator

abstract class UrlGeneratorBase extends SimpleSitemapPluginBase implements UrlGeneratorInterface {

  /**
   * @var \Drupal\simple_sitemap\Logger
   */
  protected $logger;

  /**
   * @var \Drupal\simple_sitemap\Settings
   */
  protected $settings;

  /**
   * @var \Drupal\simple_sitemap\Entity\SimpleSitemapInterface
   */
  protected $sitemapVariant;

  /**
   * UrlGeneratorBase constructor.
   *
   * @param array $configuration
   * @param $plugin_id
   * @param $plugin_definition
   * @param \Drupal\simple_sitemap\Logger $logger
   * @param \Drupal\simple_sitemap\Settings $settings
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, Logger $logger, Settings $settings) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->logger = $logger;
    $this->settings = $settings;
  }
  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'));
  }

  /**
   * @param \Drupal\simple_sitemap\Entity\SimpleSitemapInterface $sitemap_variant
   *
   * @return $this
   */
  public function setSitemapVariant(SimpleSitemapInterface $sitemap_variant) : UrlGeneratorInterface {
    $this->sitemapVariant = $sitemap_variant;
    return $this;
  }

  /**
   * @param string $url
   *
   * @return string
   */
  protected function replaceBaseUrlWithCustom(string $url) : string {
    return !empty($base_url = $this->settings
      ->get('base_url')) ? str_replace($GLOBALS['base_url'], $base_url, $url) : $url;
  }

  /**
   * @return mixed
   *
   * @todo Throw and catch SkipElementException here and children.
   */
  public abstract function getDataSets() : array;

  /**
   * @param $data_set
   * @return mixed
   */
  protected abstract function processDataSet($data_set) : array;

  /**
   * @param $data_set
   * @return array
   *
   * @todo catch SkipElementException here and children.
   */
  public function generate($data_set) : array {
    try {
      return [
        $this
          ->processDataSet($data_set),
      ];
    } catch (SkipElementException $e) {
      return [];
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
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::create	public static	function	Creates an instance of the plugin. Overrides SimpleSitemapPluginBase::create	1
UrlGeneratorBase::generate	public	function	@todo catch SkipElementException here and children. Overrides UrlGeneratorInterface::generate	1
UrlGeneratorBase::getDataSets	abstract public	function	@todo Throw and catch SkipElementException here and children. Overrides UrlGeneratorInterface::getDataSets	4
UrlGeneratorBase::processDataSet	abstract protected	function		4
UrlGeneratorBase::replaceBaseUrlWithCustom	protected	function
UrlGeneratorBase::setSitemapVariant	public	function	Overrides UrlGeneratorInterface::setSitemapVariant
UrlGeneratorBase::__construct	public	function	UrlGeneratorBase constructor. Overrides PluginBase::__construct	1