class Warmer in Warmer 8

Annotation class for the cache warmer plugins.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\warmer\Annotation\Warmer

1 file declares its use of Warmer

WarmerPluginManager.php in src/Plugin/WarmerPluginManager.php

2 string references to 'Warmer'

EnqueueForm::buildForm in src/Form/EnqueueForm.php

Form constructor.

warmer.info.yml in ./warmer.info.yml

warmer.info.yml

3 classes are annotated with Warmer

CdnWarmer in modules/warmer_cdn/src/Plugin/warmer/CdnWarmer.php

The cache warmer for the built-in entity cache.

EntityWarmer in modules/warmer_entity/src/Plugin/warmer/EntityWarmer.php

The cache warmer for the built-in entity cache.

SitemapWarmer in modules/warmer_cdn/src/Plugin/warmer/SitemapWarmer.php

The cache warmer for the built-in entity cache.

File

src/Annotation/Warmer.php, line 12

Namespace

Drupal\warmer\Annotation

class Warmer extends Plugin {

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

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

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

  /**
   * The name of the field formatter class.
   *
   * This is not provided manually, it will be added by the discovery mechanism.
   *
   * @var string
   */
  public $class;

}

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
Warmer::$class	public	property	The name of the field formatter class.
Warmer::$description	public	property	A short description of the formatter type.
Warmer::$id	public	property	The plugin ID.
Warmer::$label	public	property	The human-readable name of the formatter type.