class ArbitraryUrlGenerator in Simple XML sitemap 8.3

Class ArbitraryUrlGenerator @package Drupal\simple_sitemap\Plugin\simple_sitemap\UrlGenerator

Plugin annotation

@UrlGenerator(
  id = "arbitrary",
  label = @Translation("Arbitrary URL generator"),
  description = @Translation("Generates URLs from data sets collected in the hook_arbitrary_links_alter hook."),
)

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

File

src/Plugin/simple_sitemap/UrlGenerator/ArbitraryUrlGenerator.php, line 20

Namespace

Drupal\simple_sitemap\Plugin\simple_sitemap\UrlGenerator

class ArbitraryUrlGenerator extends UrlGeneratorBase {
  protected $moduleHandler;

  /**
   * ArbitraryUrlGenerator constructor.
   * @param array $configuration
   * @param $plugin_id
   * @param $plugin_definition
   * @param \Drupal\simple_sitemap\Simplesitemap $generator
   * @param \Drupal\simple_sitemap\Logger $logger
   * @param \Drupal\Core\Extension\ModuleHandler $module_handler
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, Simplesitemap $generator, Logger $logger, ModuleHandler $module_handler) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $generator, $logger);
    $this->moduleHandler = $module_handler;
  }
  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('module_handler'));
  }

  /**
   * @inheritdoc
   */
  public function getDataSets() {
    $arbitrary_links = [];
    $sitemap_variant = $this->sitemapVariant;
    $this->moduleHandler
      ->alter('simple_sitemap_arbitrary_links', $arbitrary_links, $sitemap_variant);
    return array_values($arbitrary_links);
  }

  /**
   * @inheritdoc
   */
  protected function processDataSet($data_set) {
    return $data_set;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ArbitraryUrlGenerator::$moduleHandler	protected	property
ArbitraryUrlGenerator::create	public static	function	Creates an instance of the plugin. Overrides UrlGeneratorBase::create
ArbitraryUrlGenerator::getDataSets	public	function	@inheritdoc Overrides UrlGeneratorBase::getDataSets
ArbitraryUrlGenerator::processDataSet	protected	function	@inheritdoc Overrides UrlGeneratorBase::processDataSet
ArbitraryUrlGenerator::__construct	public	function	ArbitraryUrlGenerator constructor. Overrides UrlGeneratorBase::__construct
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.
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.
UrlGeneratorBase::$generator	protected	property
UrlGeneratorBase::$logger	protected	property
UrlGeneratorBase::$settings	protected	property
UrlGeneratorBase::$sitemapVariant	protected	property
UrlGeneratorBase::generate	public	function	Overrides UrlGeneratorInterface::generate	1
UrlGeneratorBase::replaceBaseUrlWithCustom	protected	function
UrlGeneratorBase::setSettings	public	function	Overrides UrlGeneratorInterface::setSettings
UrlGeneratorBase::setSitemapVariant	public	function	Overrides UrlGeneratorInterface::setSitemapVariant