class SitemapType in Simple XML sitemap 8.3

Defines a SitemapType item annotation object.

@package Drupal\simple_sitemap\Annotation

Hierarchy

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

See also

\Drupal\simple_sitemap\Plugin\simple_sitemap\SitemapType\SitemapTypeManager

Plugin API

1 class is annotated with SitemapType

DefaultHreflangSitemapType in src/Plugin/simple_sitemap/SitemapType/DefaultHreflangSitemapType.php

Class DefaultHreflangSitemapType @package Drupal\simple_sitemap\Plugin\simple_sitemap\SitemapType

File

src/Annotation/SitemapType.php, line 17

Namespace

Drupal\simple_sitemap\Annotation

class SitemapType extends Plugin {

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

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

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

  /**
   * The ID of the sitemap generator.
   *
   * @var string
   */
  public $sitemapGenerator;

  /**
   * The IDs of the URL generators.
   *
   * @var[] string
   */
  public $urlGenerators = [];

}

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
SitemapType::$description	public	property	A short description of the sitemap type.
SitemapType::$id	public	property	The sitemap type ID.
SitemapType::$label	public	property	The human-readable name of the sitemap type.
SitemapType::$sitemapGenerator	public	property	The ID of the sitemap generator.
SitemapType::$urlGenerators	public	property	The IDs of the URL generators.