class UpdateRunner in Scheduled Updates 8

Defines an update runner annotation object.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\scheduled_updates\Annotation\UpdateRunner

See also

Plugin API

3 classes are annotated with UpdateRunner

EmbeddedUpdateRunner in src/Plugin/UpdateRunner/EmbeddedUpdateRunner.php

The default Embedded Update Runner.

IndependentUpdateRunner in src/Plugin/UpdateRunner/IndependentUpdateRunner.php

The default Embedded Update Runner.

LatestRevisionUpdateRunner in src/Plugin/UpdateRunner/LatestRevisionUpdateRunner.php

The Latest Revision Update Runner.

File

src/Annotation/UpdateRunner.php, line 19

Contains \Drupal\image\Annotation\ImageEffect.

Namespace

Drupal\scheduled_updates\Annotation

class UpdateRunner extends Plugin {

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

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

  /**
   * A brief description of the update runner.
   *
   * @ingroup plugin_translatable
   *
   * @var \Drupal\Core\Annotation\Translation (optional)
   */
  public $description = '';

  /**
   * Embedded or independent.
   *
   * @var array
   */
  public $update_types;

}

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
UpdateRunner::$description	public	property	A brief description of the update runner.
UpdateRunner::$id	public	property	The plugin ID.
UpdateRunner::$label	public	property	The human-readable name of the update runner.
UpdateRunner::$update_types	public	property	Embedded or independent.