www.aleph1.co.uk Git - yaffs-website/blob - web/modules/contrib/simple_sitemap/src/Annotation/UrlGenerator.php

   1 <?php
   2
   3 namespace Drupal\simple_sitemap\Annotation;
   4
   5 use Drupal\Component\Annotation\Plugin;
   6
   7 /**
   8  * Defines a UrlGenerator item annotation object.
   9  *
  10  * @package Drupal\simple_sitemap\Annotation
  11  *
  12  * @see \Drupal\simple_sitemap\Plugin\simple_sitemap\UrlGenerator\UrlGeneratorManager
  13  * @see plugin_api
  14  *
  15  * @Annotation
  16  */
  17 class UrlGenerator extends Plugin {
  18
  19   /**
  20    * The generator ID.
  21    *
  22    * @var string
  23    */
  24   public $id;
  25
  26   /**
  27    * The human-readable name of the generator.
  28    *
  29    * @ingroup plugin_translatable
  30    *
  31    * @var \Drupal\Core\Annotation\Translation
  32    */
  33   public $title;
  34
  35   /**
  36    * A short description of the generator.
  37    *
  38    * @ingroup plugin_translatable
  39    *
  40    * @var \Drupal\Core\Annotation\Translation
  41    */
  42   public $description;
  43
  44   /**
  45    * An integer to determine the weight of this generator relative to others.
  46    *
  47    * @var int
  48    */
  49   public $weight = 0;
  50
  51   /**
  52    * Whether the generator is enabled by default.
  53    *
  54    * @var bool
  55    */
  56   public $enabled = TRUE;
  57
  58   /**
  59    * Default generator settings.
  60    *
  61    * @var array
  62    */
  63   public $settings = [
  64     'instantiate_for_each_data_set' => FALSE,
  65   ];
  66 }