class InPlaceEditor in Zircon Profile 8

Defines an InPlaceEditor annotation object.

Plugin Namespace: Plugin\InPlaceEditor

For a working example, see \Drupal\quickedit\Plugin\InPlaceEditor\PlainTextEditor

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\quickedit\Annotation\InPlaceEditor

See also

\Drupal\quickedit\Plugin\InPlaceEditorBase

\Drupal\quickedit\Plugin\InPlaceEditorInterface

\Drupal\quickedit\Plugin\InPlaceEditorManager

Plugin API

Related topics

Annotations

Annotations for class discovery and metadata description.

4 classes are annotated with InPlaceEditor

Editor in core/modules/editor/src/Plugin/InPlaceEditor/Editor.php

Defines the formatted text in-place editor.

FormEditor in core/modules/quickedit/src/Plugin/InPlaceEditor/FormEditor.php

Defines the form in-place editor.

PlainTextEditor in core/modules/quickedit/src/Plugin/InPlaceEditor/PlainTextEditor.php

Defines the plain text in-place editor.

WysiwygEditor in core/modules/quickedit/tests/modules/src/Plugin/InPlaceEditor/WysiwygEditor.php

Defines the 'wysiwyg' in-place editor.

File

core/modules/quickedit/src/Annotation/InPlaceEditor.php, line 26

Contains \Drupal\quickedit\Annotation\InPlaceEditor.

Namespace

Drupal\quickedit\Annotation

class InPlaceEditor extends Plugin {

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

  /**
   * An array of in-place editors plugin IDs that have registered themselves as
   * alternatives to this in-place editor.
   *
   * @var array
   */
  public $alternativeTo;

  /**
   * The name of the module providing the in-place editor plugin.
   *
   * @var string
   */
  public $module;

}

Members

Name	Modifiers	Type	Description	Overrides
InPlaceEditor::$alternativeTo	public	property	An array of in-place editors plugin IDs that have registered themselves as alternatives to this in-place editor.
InPlaceEditor::$id	public	property	The plugin ID.
InPlaceEditor::$module	public	property	The name of the module providing the in-place editor plugin.
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	2
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.	1