Drupal 8  8.0.2
Editor Class Reference
Inheritance diagram for Editor:

Public Member Functions

 id ()
 
 __construct (array $values, $entity_type)
 
 label ()
 
 calculateDependencies ()
 
 hasAssociatedFilterFormat ()
 
 getFilterFormat ()
 
 getEditor ()
 
 setEditor ($editor)
 
 getSettings ()
 
 setSettings (array $settings)
 
 getImageUploadSettings ()
 
 setImageUploadSettings (array $image_upload_settings)
 
- Public Member Functions inherited from ConfigEntityBase
 __construct (array $values, $entity_type)
 
 getOriginalId ()
 
 setOriginalId ($id)
 
 isNew ()
 
 get ($property_name)
 
 set ($property_name, $value)
 
 enable ()
 
 disable ()
 
 setStatus ($status)
 
 status ()
 
 setSyncing ($syncing)
 
 isSyncing ()
 
 setUninstalling ($uninstalling)
 
 isUninstalling ()
 
 createDuplicate ()
 
 preSave (EntityStorageInterface $storage)
 
 calculateDependencies ()
 
 urlInfo ($rel= 'edit-form', array $options=[])
 
 url ($rel= 'edit-form', $options=array())
 
 link ($text=NULL, $rel= 'edit-form', array $options=[])
 
 toUrl ($rel= 'edit-form', array $options=[])
 
 getCacheTagsToInvalidate ()
 
 getDependencies ()
 
 getConfigDependencyName ()
 
 getConfigTarget ()
 
 onDependencyRemoval (array $dependencies)
 
 setThirdPartySetting ($module, $key, $value)
 
 getThirdPartySetting ($module, $key, $default=NULL)
 
 getThirdPartySettings ($module)
 
 unsetThirdPartySetting ($module, $key)
 
 getThirdPartyProviders ()
 
 isInstallable ()
 
 trustData ()
 
 hasTrustedData ()
 
 save ()
 
- Public Member Functions inherited from Entity
 __construct (array $values, $entity_type)
 
 id ()
 
 uuid ()
 
 isNew ()
 
 enforceIsNew ($value=TRUE)
 
 getEntityTypeId ()
 
 bundle ()
 
 label ()
 
 urlInfo ($rel= 'canonical', array $options=[])
 
 toUrl ($rel= 'canonical', array $options=[])
 
 hasLinkTemplate ($rel)
 
 link ($text=NULL, $rel= 'canonical', array $options=[])
 
 toLink ($text=NULL, $rel= 'canonical', array $options=[])
 
 url ($rel= 'canonical', $options=array())
 
 uriRelationships ()
 
 access ($operation, AccountInterface $account=NULL, $return_as_object=FALSE)
 
 language ()
 
 save ()
 
 delete ()
 
 createDuplicate ()
 
 getEntityType ()
 
 preSave (EntityStorageInterface $storage)
 
 postSave (EntityStorageInterface $storage, $update=TRUE)
 
 postCreate (EntityStorageInterface $storage)
 
 referencedEntities ()
 
 getCacheContexts ()
 
 getCacheTagsToInvalidate ()
 
 getCacheTags ()
 
 getCacheMaxAge ()
 
 getOriginalId ()
 
 setOriginalId ($id)
 
 toArray ()
 
 getTypedData ()
 
 __sleep ()
 
 getConfigDependencyKey ()
 
 getConfigDependencyName ()
 
 getConfigTarget ()
 
- Public Member Functions inherited from RefinableCacheableDependencyInterface
 addCacheContexts (array $cache_contexts)
 
 addCacheTags (array $cache_tags)
 
 mergeCacheMaxAge ($max_age)
 
 addCacheableDependency ($other_object)
 

Protected Member Functions

 editorPluginManager ()
 
- Protected Member Functions inherited from ConfigEntityBase
 getTypedConfig ()
 
 addDependency ($type, $name)
 
 invalidateTagsOnSave ($update)
 
- Protected Member Functions inherited from Entity
 entityManager ()
 
 entityTypeManager ()
 
 languageManager ()
 
 uuidGenerator ()
 
 linkTemplates ()
 
 urlRouteParameters ($rel)
 
 invalidateTagsOnSave ($update)
 

Protected Attributes

 $format
 
 $editor
 
 $settings = array()
 
 $image_upload = array()
 
 $filterFormat
 
 $editorPluginManager
 
- Protected Attributes inherited from ConfigEntityBase
 $originalId
 
 $pluginConfigKey
 
 $status = TRUE
 
 $uuid
 
 $langcode = 'en'
 
 $third_party_settings = array()
 
 $_core = []
 
 $trustedData = FALSE
 
- Protected Attributes inherited from Entity
 $entityTypeId
 
 $enforceIsNew
 
 $typedData
 

Additional Inherited Members

- Static Public Member Functions inherited from ConfigEntityBase
static sort (ConfigEntityInterface $a, ConfigEntityInterface $b)
 
- Static Public Member Functions inherited from Entity
static preCreate (EntityStorageInterface $storage, array &$values)
 
static preDelete (EntityStorageInterface $storage, array $entities)
 
static postDelete (EntityStorageInterface $storage, array $entities)
 
static postLoad (EntityStorageInterface $storage, array &$entities)
 
static load ($id)
 
static loadMultiple (array $ids=NULL)
 
static create (array $values=array())
 
- Static Protected Member Functions inherited from ConfigEntityBase
static invalidateTagsOnDelete (EntityTypeInterface $entity_type, array $entities)
 
static getConfigManager ()
 
- Static Protected Member Functions inherited from Entity
static invalidateTagsOnDelete (EntityTypeInterface $entity_type, array $entities)
 

Detailed Description

Defines the configured text editor entity.

( id = "editor", label = ("Text Editor"), entity_keys = { "id" = "format" }, config_export = { "format", "editor", "settings", "image_upload", } )

Constructor & Destructor Documentation

__construct ( array  $values,
  $entity_type 
)

{}

References Editor\editorPluginManager().

Here is the call graph for this function:

Member Function Documentation

calculateDependencies ( )

{Calculates dependencies and stores them in the dependency property.

Returns
$this
See Also
}

Implements ConfigEntityInterface.

References ConfigEntityBase\addDependency(), Editor\editorPluginManager(), ConfigEntityBase\getConfigDependencyName(), and Editor\getFilterFormat().

Here is the call graph for this function:

editorPluginManager ( )
protected

Returns the editor plugin manager.

Returns

References Drupal\service().

Referenced by Editor\__construct(), and Editor\calculateDependencies().

Here is the call graph for this function:

Here is the caller graph for this function:

getEditor ( )

{Returns the associated text editor plugin ID.

Returns
string The text editor plugin ID.
}

Implements EditorInterface.

getFilterFormat ( )

{Returns the filter format this text editor is associated with.This could be NULL if the associated filter format is still being created.

See Also
hasAssociatedFilterFormat()
Returns
|null
}

Implements EditorInterface.

References Drupal\entityManager().

Referenced by Editor\calculateDependencies(), Internal\generateACFSettings(), Internal\generateFormatTagsSetting(), DrupalImageCaption\getConfig(), DrupalImageCaption\isEnabled(), and Editor\label().

Here is the call graph for this function:

Here is the caller graph for this function:

getImageUploadSettings ( )

{Returns the image upload settings.

Returns
array A structured array containing image upload settings.
}

Implements EditorInterface.

getSettings ( )

{Returns the text editor plugin-specific settings.

Returns
array A structured array containing all text editor settings.
}

Implements EditorInterface.

Referenced by StylesCombo\getConfig(), Internal\getConfig(), CKEditorPluginManager\getEnabledPluginFiles(), LlamaContextual\isEnabled(), LlamaContextualAndButton\isEnabled(), DrupalImageCaption\isEnabled(), LlamaContextualAndButton\settingsForm(), and StylesCombo\settingsForm().

Here is the caller graph for this function:

hasAssociatedFilterFormat ( )

{Returns whether this text editor has an associated filter format.A text editor may be created at the same time as the filter format it's going to be associated with; in that case, no filter format object is available yet.

Returns
bool
}

Implements EditorInterface.

Referenced by Internal\generateACFSettings(), Internal\generateFormatTagsSetting(), and DrupalImageCaption\isEnabled().

Here is the caller graph for this function:

id ( )

{Gets the identifier.

Returns
string|int|null The entity identifier, or NULL if the object does not yet have an identifier.
}

Implements EntityInterface.

Referenced by Internal\generateFormatTagsSetting().

Here is the caller graph for this function:

label ( )

{Gets the label of the entity.

Returns
string|null The label of the entity, or NULL if there is no label defined.
}

Implements EntityInterface.

References Editor\getFilterFormat().

Here is the call graph for this function:

setEditor (   $editor)

{Set the text editor plugin ID.

Parameters
string$editorThe text editor plugin ID to set.
}

Implements EditorInterface.

setImageUploadSettings ( array  $image_upload_settings)

{Sets the image upload settings.

Parameters
array$image_uploadThe structured array containing image upload settings.
Returns
$this
}

Implements EditorInterface.

setSettings ( array  $settings)

{Sets the text editor plugin-specific settings.

Parameters
array$settingsThe structured array containing all text editor settings.
Returns
$this
}

Implements EditorInterface.


The documentation for this class was generated from the following file: