class PurgeProcessor in Purge 8.3

Defines a PurgeProcessor annotation object.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\purge\Annotation\PurgeProcessor

9 classes are annotated with PurgeProcessor

AProcessor in tests/modules/purge_processor_test/src/Plugin/Purge/Processor/AProcessor.php

Test processor A.

BProcessor in tests/modules/purge_processor_test/src/Plugin/Purge/Processor/BProcessor.php

Test processor B.

CProcessor in tests/modules/purge_processor_test/src/Plugin/Purge/Processor/CProcessor.php

Test processor C.

CronProcessor in modules/purge_processor_cron/src/Plugin/Purge/Processor/CronProcessor.php

Cron processor.

DrushInvalidateProcessor in modules/purge_drush/src/Plugin/Purge/Processor/DrushInvalidateProcessor.php

Processor for the 'drush p:invalidate' command.

... See full list

File

src/Annotation/PurgeProcessor.php, line 12

Namespace

Drupal\purge\Annotation

class PurgeProcessor extends Plugin {

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

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

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

  /**
   * Whether the plugin needs to auto enable when first discovered.
   *
   * @var bool
   */
  public $enable_by_default = FALSE;

  // phpcs:ignore -- annotation property!

  /**
   * Class name of the configuration form of your processor.
   *
   * Full class name of the configuration form of your processor, with leading
   * backslash. Class must extend \Drupal\purge_ui\Form\ProcessorConfigFormBase.
   *
   * @var string
   */
  public $configform = '';

}

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
PurgeProcessor::$configform	public	property	Class name of the configuration form of your processor.
PurgeProcessor::$description	public	property	The description of the processor plugin.
PurgeProcessor::$enable_by_default	public	property	Whether the plugin needs to auto enable when first discovered.
PurgeProcessor::$id	public	property	The plugin ID of the processor plugin.
PurgeProcessor::$label	public	property	The human-readable name of the processor plugin.