abstract class UrlGeneratorBase in Simple XML sitemap 8.3
Same name and namespace in other branches
- 8.2 src/Plugin/simple_sitemap/UrlGenerator/UrlGeneratorBase.php \Drupal\simple_sitemap\Plugin\simple_sitemap\UrlGenerator\UrlGeneratorBase
- 4.x src/Plugin/simple_sitemap/UrlGenerator/UrlGeneratorBase.php \Drupal\simple_sitemap\Plugin\simple_sitemap\UrlGenerator\UrlGeneratorBase
Class UrlGeneratorBase @package Drupal\simple_sitemap\Plugin\simple_sitemap\UrlGenerator
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\SimplesitemapPluginBase implements PluginInspectionInterface, ContainerFactoryPluginInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of UrlGeneratorBase
1 file declares its use of UrlGeneratorBase
File
- src/
Plugin/ simple_sitemap/ UrlGenerator/ UrlGeneratorBase.php, line 14
Namespace
Drupal\simple_sitemap\Plugin\simple_sitemap\UrlGeneratorView source
abstract class UrlGeneratorBase extends SimplesitemapPluginBase implements UrlGeneratorInterface {
/**
* @var \Drupal\simple_sitemap\Simplesitemap
*/
protected $generator;
/**
* @var \Drupal\simple_sitemap\Logger
*/
protected $logger;
/**
* @var array
*/
protected $settings;
/**
* @var string
*/
protected $sitemapVariant;
/**
* UrlGeneratorBase constructor.
* @param array $configuration
* @param $plugin_id
* @param $plugin_definition
* @param \Drupal\simple_sitemap\Simplesitemap $generator
* @param \Drupal\simple_sitemap\Logger $logger
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition, Simplesitemap $generator, Logger $logger) {
parent::__construct($configuration, $plugin_id, $plugin_definition);
$this->generator = $generator;
$this->logger = $logger;
}
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'));
}
/**
* @param array $settings
* @return $this
*/
public function setSettings(array $settings) {
$this->settings = $settings;
return $this;
}
/**
* @param string $sitemap_variant
* @return $this
*/
public function setSitemapVariant($sitemap_variant) {
$this->sitemapVariant = $sitemap_variant;
return $this;
}
/**
* @param string $url
* @return string
*/
protected function replaceBaseUrlWithCustom($url) {
return !empty($this->settings['base_url']) ? str_replace($GLOBALS['base_url'], $this->settings['base_url'], $url) : $url;
}
/**
* @return mixed
*/
public abstract function getDataSets();
/**
* @param $data_set
* @return mixed
*/
protected abstract function processDataSet($data_set);
/**
* @param $data_set
* @return array
*/
public function generate($data_set) {
$path_data = $this
->processDataSet($data_set);
return FALSE !== $path_data ? [
$path_data,
] : [];
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
UrlGeneratorBase:: |
protected | property | ||
UrlGeneratorBase:: |
protected | property | ||
UrlGeneratorBase:: |
protected | property | ||
UrlGeneratorBase:: |
protected | property | ||
UrlGeneratorBase:: |
public static | function |
Creates an instance of the plugin. Overrides SimplesitemapPluginBase:: |
2 |
UrlGeneratorBase:: |
public | function |
Overrides UrlGeneratorInterface:: |
1 |
UrlGeneratorBase:: |
abstract public | function |
Overrides UrlGeneratorInterface:: |
5 |
UrlGeneratorBase:: |
abstract protected | function | 5 | |
UrlGeneratorBase:: |
protected | function | ||
UrlGeneratorBase:: |
public | function |
Overrides UrlGeneratorInterface:: |
|
UrlGeneratorBase:: |
public | function |
Overrides UrlGeneratorInterface:: |
|
UrlGeneratorBase:: |
public | function |
UrlGeneratorBase constructor. Overrides SimplesitemapPluginBase:: |
2 |