class UrlGenerator in Simple XML sitemap 8.2

Defines a UrlGenerator item annotation object.

@package Drupal\simple_sitemap\Annotation

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\simple_sitemap\Annotation\UrlGenerator

See also

\Drupal\simple_sitemap\Plugin\simple_sitemap\UrlGenerator\UrlGeneratorManager

Plugin API

1 file declares its use of UrlGenerator

CustomUrlGenerator.php in src/Plugin/simple_sitemap/UrlGenerator/CustomUrlGenerator.php

4 classes are annotated with UrlGenerator

ArbitraryUrlGenerator in src/Plugin/simple_sitemap/UrlGenerator/ArbitraryUrlGenerator.php

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

CustomUrlGenerator in src/Plugin/simple_sitemap/UrlGenerator/CustomUrlGenerator.php

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

EntityMenuLinkContentUrlGenerator in src/Plugin/simple_sitemap/UrlGenerator/EntityMenuLinkContentUrlGenerator.php

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

EntityUrlGenerator in src/Plugin/simple_sitemap/UrlGenerator/EntityUrlGenerator.php

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

File

src/Annotation/UrlGenerator.php, line 17

Namespace

Drupal\simple_sitemap\Annotation

class UrlGenerator extends Plugin {

  /**
   * The generator ID.
   *
   * @var string
   */
  public $id;

  /**
   * The human-readable name of the generator.
   *
   * @ingroup plugin_translatable
   *
   * @var \Drupal\Core\Annotation\Translation
   */
  public $title;

  /**
   * A short description of the generator.
   *
   * @ingroup plugin_translatable
   *
   * @var \Drupal\Core\Annotation\Translation
   */
  public $description;

  /**
   * An integer to determine the weight of this generator relative to others.
   *
   * @var int
   */
  public $weight = 0;

  /**
   * Whether the generator is enabled by default.
   *
   * @var bool
   */
  public $enabled = TRUE;

  /**
   * Default generator settings.
   *
   * @var array
   */
  public $settings = [
    'instantiate_for_each_data_set' => FALSE,
  ];

}

Members

Name	Modifiers	Type	Description	Overrides
Plugin::$definition	protected	property	The plugin definition read from the class annotation.	1
Plugin::get	public	function	Gets the value of an annotation. Overrides AnnotationInterface::get	5
Plugin::getClass	public	function	Gets the class of the annotated class. Overrides AnnotationInterface::getClass
Plugin::getId	public	function	Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider	public	function	Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider
Plugin::parse	protected	function	Parses an annotation into its definition.
Plugin::setClass	public	function	Sets the class of the annotated class. Overrides AnnotationInterface::setClass
Plugin::setProvider	public	function	Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct	public	function	Constructs a Plugin object.	2
UrlGenerator::$description	public	property	A short description of the generator.
UrlGenerator::$enabled	public	property	Whether the generator is enabled by default.
UrlGenerator::$id	public	property	The generator ID.
UrlGenerator::$settings	public	property	Default generator settings.
UrlGenerator::$title	public	property	The human-readable name of the generator.
UrlGenerator::$weight	public	property	An integer to determine the weight of this generator relative to others.