You are here

class ArbitraryUrlGenerator in Simple XML sitemap 8.2

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

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

Plugin annotation


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

Hierarchy

Expanded class hierarchy of ArbitraryUrlGenerator

File

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

Namespace

Drupal\simple_sitemap\Plugin\simple_sitemap\UrlGenerator
View source
class ArbitraryUrlGenerator extends UrlGeneratorBase {
  protected $moduleHandler;

  /**
   * ArbitraryUrlGenerator constructor.
   * @param array $configuration
   * @param string $plugin_id
   * @param mixed $plugin_definition
   * @param \Drupal\simple_sitemap\Simplesitemap $generator
   * @param \Drupal\simple_sitemap\SitemapGenerator $sitemap_generator
   * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   * @param \Drupal\simple_sitemap\Logger $logger
   * @param \Drupal\simple_sitemap\EntityHelper $entityHelper
   * @param \Drupal\Core\Extension\ModuleHandler $module_handler
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, Simplesitemap $generator, SitemapGenerator $sitemap_generator, LanguageManagerInterface $language_manager, EntityTypeManagerInterface $entity_type_manager, Logger $logger, EntityHelper $entityHelper, ModuleHandler $module_handler) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $generator, $sitemap_generator, $language_manager, $entity_type_manager, $logger, $entityHelper);
    $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.sitemap_generator'), $container
      ->get('language_manager'), $container
      ->get('entity_type.manager'), $container
      ->get('simple_sitemap.logger'), $container
      ->get('simple_sitemap.entity_helper'), $container
      ->get('module_handler'));
  }

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

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

}

Members

Namesort descending 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::$anonUser protected property
UrlGeneratorBase::$batchSettings protected property
UrlGeneratorBase::$context protected property
UrlGeneratorBase::$defaultLanguageId protected property
UrlGeneratorBase::$entityHelper protected property
UrlGeneratorBase::$entityTypeManager protected property
UrlGeneratorBase::$generator protected property
UrlGeneratorBase::$languageManager protected property
UrlGeneratorBase::$languages protected property
UrlGeneratorBase::$logger protected property
UrlGeneratorBase::$sitemapGenerator protected property
UrlGeneratorBase::addBatchResult protected function
UrlGeneratorBase::addProcessedElement protected function
UrlGeneratorBase::addUrl protected function
UrlGeneratorBase::addUrlVariants protected function
UrlGeneratorBase::ANONYMOUS_USER_ID constant
UrlGeneratorBase::generate public function Called by batch. Overrides UrlGeneratorInterface::generate
UrlGeneratorBase::getAlternateUrlsForAllLanguages protected function
UrlGeneratorBase::getAlternateUrlsForDefaultLanguage protected function
UrlGeneratorBase::getAlternateUrlsForTranslatedLanguages protected function
UrlGeneratorBase::getBatchIterationElements protected function 2
UrlGeneratorBase::getBatchResults protected function
UrlGeneratorBase::getChunkCount protected function
UrlGeneratorBase::getImages protected function
UrlGeneratorBase::getProcessedElements protected function
UrlGeneratorBase::initializeBatch protected function
UrlGeneratorBase::isBatch protected function
UrlGeneratorBase::needsInitialization protected function
UrlGeneratorBase::pathProcessed protected function
UrlGeneratorBase::PROCESSING_PATH_MESSAGE constant
UrlGeneratorBase::processSegment protected function
UrlGeneratorBase::replaceBaseUrlWithCustom protected function
UrlGeneratorBase::setBatchResults protected function
UrlGeneratorBase::setBatchSettings public function
UrlGeneratorBase::setChunkCount protected function
UrlGeneratorBase::setContext public function
UrlGeneratorBase::setCurrentId protected function
UrlGeneratorBase::setProcessedElements protected function
UrlGeneratorBase::setProcessingBatchMessage protected function
UrlGeneratorBase::setProgressInfo protected function
UrlGeneratorPluginBase::$enabled public property
UrlGeneratorPluginBase::$provider public property
UrlGeneratorPluginBase::$settings public property
UrlGeneratorPluginBase::$weight public property
UrlGeneratorPluginBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
UrlGeneratorPluginBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurablePluginInterface::defaultConfiguration
UrlGeneratorPluginBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurablePluginInterface::getConfiguration
UrlGeneratorPluginBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurablePluginInterface::setConfiguration