UrlGenerator.php 1.17 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11
<?php

namespace Drupal\simple_sitemap\Annotation;

use Drupal\Component\Annotation\Plugin;

/**
 * Defines a UrlGenerator item annotation object.
 *
 * @package Drupal\simple_sitemap\Annotation
 *
12
 * @see \Drupal\simple_sitemap\Plugin\simple_sitemap\UrlGenerator\UrlGeneratorManager
13 14 15 16 17 18 19
 * @see plugin_api
 *
 * @Annotation
 */
class UrlGenerator extends Plugin {

  /**
20
   * The generator ID.
21 22 23 24
   *
   * @var string
   */
  public $id;
25 26

  /**
27
   * The human-readable name of the generator.
28 29 30 31 32 33 34 35
   *
   * @ingroup plugin_translatable
   *
   * @var \Drupal\Core\Annotation\Translation
   */
  public $title;

  /**
36
   * A short description of the generator.
37 38 39 40 41 42 43 44 45 46
   *
   * @ingroup plugin_translatable
   *
   * @var \Drupal\Core\Annotation\Translation
   */
  public $description;

  /**
   * An integer to determine the weight of this generator relative to others.
   *
gbyte.co's avatar
gbyte.co committed
47
   * @var int
48
   */
gbyte.co's avatar
gbyte.co committed
49
  public $weight = 0;
50 51

  /**
52
   * Whether the generator is enabled by default.
53
   *
gbyte.co's avatar
gbyte.co committed
54
   * @var bool
55 56 57 58
   */
  public $enabled = TRUE;

  /**
59
   * Default generator settings.
60
   *
gbyte.co's avatar
gbyte.co committed
61
   * @var array
62
   */
63
  public $settings = [
64
    'default_sitemap_generator' => 'default',
65 66
    'instantiate_for_each_data_set' => FALSE,
  ];
67
}