class UrlGenerator in Simple XML sitemap 4.x

Defines a UrlGenerator item annotation object.

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

2 files declare their use of UrlGenerator

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

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

3 classes are annotated with UrlGenerator

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

Class CustomUrlGenerator

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

Class EntityUrlGenerator

ViewsUrlGenerator in modules/simple_sitemap_views/src/Plugin/simple_sitemap/UrlGenerator/ViewsUrlGenerator.php

Views URL generator plugin.

File

src/Annotation/UrlGenerator.php, line 15

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 $label;

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

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

}

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	1
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::$id	public	property	The generator ID.
UrlGenerator::$label	public	property	The human-readable name of the generator.
UrlGenerator::$settings	public	property	Default generator settings.