class Sitemap in Sitemap 8.2

Defines a Sitemap annotation object.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\sitemap\Annotation\Sitemap

See also

\Drupal\sitemap\SitemapManager

\Drupal\sitemap\SitemapInterface

5 string references to 'Sitemap'

sitemap.config_translation.yml in ./sitemap.config_translation.yml

sitemap.config_translation.yml

sitemap.info.yml in ./sitemap.info.yml

sitemap.info.yml

sitemap.links.menu.yml in ./sitemap.links.menu.yml

sitemap.links.menu.yml

sitemap.routing.yml in ./sitemap.routing.yml

sitemap.routing.yml

sitemap.settings.yml in config/install/sitemap.settings.yml

config/install/sitemap.settings.yml

4 classes are annotated with Sitemap

Book in src/Plugin/Sitemap/Book.php

Provides a sitemap for a book.

Frontpage in src/Plugin/Sitemap/Frontpage.php

Provides a link to the front page for the sitemap.

Menu in src/Plugin/Sitemap/Menu.php

Provides a sitemap for an individual menu.

Vocabulary in src/Plugin/Sitemap/Vocabulary.php

Provides a sitemap for an taxonomy vocabulary.

File

src/Annotation/Sitemap.php, line 17

Namespace

Drupal\sitemap\Annotation

class Sitemap extends Plugin {

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

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

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

  /**
   * Sets the weight of this item relative to other items in the sitemap.
   *
   * @var int
   */
  public $weight = NULL;

  /**
   * Whether this plugin is enabled or disabled by default.
   *
   * @var bool
   */
  public $enabled = FALSE;

  /**
   * The default settings for the plugin.
   *
   * @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
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
Sitemap::$description	public	property	A short description of the plugin.
Sitemap::$enabled	public	property	Whether this plugin is enabled or disabled by default.
Sitemap::$id	public	property	The plugin ID.
Sitemap::$settings	public	property	The default settings for the plugin.
Sitemap::$title	public	property	The human-readable name of the plugin.
Sitemap::$weight	public	property	Sets the weight of this item relative to other items in the sitemap.