class CKEditor5Plugin extends Plugin (View source)

Defines a CKEditor5Plugin annotation object.

Plugin Namespace: Plugin\CKEditor5Plugin.

Properties

protected array $definition

The plugin definition read from the class annotation.

from  Plugin
string $id

The plugin ID.

CKEditor5AspectsOfCKEditor5Plugin $ckeditor5

The CKEditor 5 aspects of the plugin definition.

DrupalAspectsOfCKEditor5Plugin $drupal

The Drupal aspects of the plugin definition.

Methods

__construct($values)

Constructs a Plugin object.

array
parse(array $values)

Parses an annotation into its definition.

from  Plugin
get()

Gets the value of an annotation.

string
getProvider()

Gets the name of the provider of the annotated class.

from  Plugin
setProvider(string $provider)

Sets the name of the provider of the annotated class.

from  Plugin
string
getId()

Gets the unique ID for this annotated class.

from  Plugin
string
getClass()

Gets the class of the annotated class.

setClass(string $class)

Sets the class of the annotated class.

Details

__construct($values)

Constructs a Plugin object.

Builds up the plugin definition and invokes the get() method for any classed annotations that were used.

Parameters

$values

See also

AnnotationBridgeDecorator::getDefinitions

protected array parse(array $values)

Parses an annotation into its definition.

Parameters

array $values

The annotation array.

Return Value

array

The parsed annotation as a definition.

get()

Gets the value of an annotation.

string getProvider()

Gets the name of the provider of the annotated class.

Return Value

string

setProvider(string $provider)

Sets the name of the provider of the annotated class.

Parameters

string $provider

The provider of the annotated class.

string getId()

Gets the unique ID for this annotated class.

Return Value

string

string getClass()

Gets the class of the annotated class.

Return Value

string

setClass(string $class)

Sets the class of the annotated class.

Parameters

string $class

The class of the annotated class.