class RepositoryHandler in Workspace 8.2

Defines a RepositoryHandler annotation object.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\workspace\Annotation\RepositoryHandler

See also

\Drupal\workspace\RepositoryHandlerInterface

\Drupal\workspace\RepositoryHandlerBase

\Drupal\workspace\RepositoryHandlerManager

Plugin API

2 classes are annotated with RepositoryHandler

LiveRepositoryHandler in src/Plugin/RepositoryHandler/LiveRepositoryHandler.php

Defines a plugin which replicates content to the default (Live) workspace.

NullRepositoryHandler in src/Plugin/RepositoryHandler/NullRepositoryHandler.php

Defines a fallback repository handler plugin.

File

src/Annotation/RepositoryHandler.php, line 17

Namespace

Drupal\workspace\Annotation

class RepositoryHandler extends Plugin {

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

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

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

  /**
   * The human-readable category.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $category = '';

}

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
RepositoryHandler::$category	public	property	The human-readable category.
RepositoryHandler::$description	public	property	A short description of the repository handler plugin.
RepositoryHandler::$id	public	property	The plugin ID.
RepositoryHandler::$label	public	property	The human-readable name of the repository handler plugin.