class InPlaceEditor

Same name in other branches
  1. 8.9.x core/modules/quickedit/src/Annotation/InPlaceEditor.php \Drupal\quickedit\Annotation\InPlaceEditor

Defines an InPlaceEditor annotation object.

Plugin Namespace: Plugin\InPlaceEditor

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

Hierarchy

Expanded class hierarchy of 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.
7 classes are annotated with InPlaceEditor
Editor in core/modules/quickedit/src/Plugin/InPlaceEditor/Editor.php
Defines the formatted text in-place editor.
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.
Image in core/modules/quickedit/src/Plugin/InPlaceEditor/Image.php
Defines the image text in-place editor.
Image in core/modules/image/src/Plugin/InPlaceEditor/Image.php
Defines the image text in-place editor.

... See full list

File

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

Namespace

Drupal\quickedit\Annotation
View source 
class InPlaceEditor extends Plugin {
    
    /**
     * The plugin ID.
     *
     * @var string
     */
    public $id;
    
    /**
     * The name of the module providing the in-place editor plugin.
     *
     * @var string
     */
    public $module;

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
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 6
Plugin::getClass public function Gets the class of the annotated class. Overrides AnnotationInterface::getClass 1
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 1
Plugin::parse protected function Parses an annotation into its definition.
Plugin::setClass public function Sets the class of the annotated class. Overrides AnnotationInterface::setClass 1
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. 3

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.