You are here

Home » API reference » Simple XML sitemap 8.2 » UrlGeneratorPluginBase.php

abstract class UrlGeneratorPluginBase in Simple XML sitemap 8.2

Class UrlGeneratorPluginBase @package Drupal\simple_sitemap\Plugin\simple_sitemap

Hierarchy

Expanded class hierarchy of UrlGeneratorPluginBase

1 file declares its use of UrlGeneratorPluginBase
UrlGeneratorBase.php in src/Plugin/simple_sitemap/UrlGenerator/UrlGeneratorBase.php

File

src/Plugin/simple_sitemap/UrlGeneratorPluginBase.php, line 12

Namespace

Drupal\simple_sitemap\Plugin\simple_sitemap
View source 
abstract class UrlGeneratorPluginBase extends SimplesitemapPluginBase implements ConfigurablePluginInterface {

  /**
   * @var array
   */
  public $settings = [];

  /**
   * @var bool
   */
  public $enabled = TRUE;

  /**
   * @var int
   */
  public $weight = 0;

  /**
   * @var string
   */
  public $provider;

  /**
   * UrlGeneratorPluginBase constructor.
   * @param array $configuration
   * @param string $plugin_id
   * @param mixed $plugin_definition
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
  }
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition);
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    return [
      'module' => 'simple_sitemap',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getConfiguration() {
    return [
      'id' => $this
        ->getPluginId(),
      'provider' => $this->pluginDefinition['provider'],
      'status' => $this->enabled,
      'weight' => $this->weight,
      'settings' => $this->settings,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function setConfiguration(array $configuration) {
    if (isset($configuration['enabled'])) {
      $this->enabled = (bool) $configuration['enabled'];
    }
    if (isset($configuration['weight'])) {
      $this->weight = (int) $configuration['weight'];
    }
    if (isset($configuration['settings'])) {
      $this->settings = (array) $configuration['settings'];
    }
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'enabled' => $this->pluginDefinition['enabled'],
      'weight' => isset($this->pluginDefinition['weight']) ? $this->pluginDefinition['weight'] : 0,
      'settings' => isset($this->pluginDefinition['settings']) ? $this->pluginDefinition['settings'] : [],
    ];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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.
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::create public static function Creates an instance of the plugin. Overrides SimplesitemapPluginBase::create 1
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
UrlGeneratorPluginBase::__construct public function UrlGeneratorPluginBase constructor. Overrides SimplesitemapPluginBase::__construct 1