class WordfilterConfiguration in Wordfilter 8.2
Defines the Wordfilter configuration entity.
Plugin annotation
@ConfigEntityType(
id = "wordfilter_configuration",
label = @Translation("Wordfilter configuration"),
admin_permission = "administer wordfilter configurations",
handlers = {
"list_builder" = "Drupal\wordfilter\WordfilterConfigurationListBuilder",
"form" = {
"add" = "Drupal\wordfilter\Form\WordfilterConfigurationForm",
"edit" = "Drupal\wordfilter\Form\WordfilterConfigurationForm",
"delete" = "Drupal\wordfilter\Form\WordfilterConfigurationDeleteForm"
},
"route_provider" = {
"html" = "Drupal\wordfilter\WordfilterConfigurationHtmlRouteProvider",
},
"access" = "Drupal\wordfilter\WordfilterConfigurationAccessControlHandler",
},
config_prefix = "wordfilter_configuration",
entity_keys = {
"id" = "id",
"label" = "label",
"uuid" = "uuid",
},
config_export = {
"id",
"label",
"uuid",
"process_id",
"items",
},
links = {
"canonical" = "/admin/config/wordfilter_configuration/{wordfilter_configuration}",
"add-form" = "/admin/config/wordfilter_configuration/add",
"edit-form" = "/admin/config/wordfilter_configuration/{wordfilter_configuration}/edit",
"delete-form" = "/admin/config/wordfilter_configuration/{wordfilter_configuration}/delete",
"collection" = "/admin/config/wordfilter_configuration"
}
)
Hierarchy
- class \Drupal\Core\Entity\EntityBase implements EntityInterface uses RefinableCacheableDependencyTrait, DependencySerializationTrait
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses SynchronizableEntityTrait, PluginDependencyTrait
- class \Drupal\wordfilter\Entity\WordfilterConfiguration implements WordfilterConfigurationInterface
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses SynchronizableEntityTrait, PluginDependencyTrait
Expanded class hierarchy of WordfilterConfiguration
3 files declare their use of WordfilterConfiguration
- DefaultWordfilterProcessUnitTest.php in tests/
src/ Unit/ DefaultWordfilterProcessUnitTest.php - TokenWordfilterProcessUnitTest.php in tests/
src/ Unit/ TokenWordfilterProcessUnitTest.php - WordfilterConfigurationUnitTest.php in tests/
src/ Unit/ WordfilterConfigurationUnitTest.php
File
- src/
Entity/ WordfilterConfiguration.php, line 50
Namespace
Drupal\wordfilter\EntityView source
class WordfilterConfiguration extends ConfigEntityBase implements WordfilterConfigurationInterface {
/**
* The Wordfilter configuration ID.
*
* @var string
*/
protected $id;
/**
* The Wordfilter configuration label.
*
* @var string
*/
protected $label;
/**
* The assigned Wordfilter process id.
*
* @var string
*/
protected $process_id = 'default';
/**
* The assigned Wordfilter process object.
*
* @see ::getProcess().
*
* @var \Drupal\wordfilter\Plugin\WordfilterProcessInterface
*/
protected $process = NULL;
/**
* The filtering items as arrays.
*
* @var array
*/
protected $items = [
[
'delta' => 0,
'substitute' => '',
'filter_words' => '',
],
];
/**
* The filtering items as cached objects.
*
* @var \Drupal\wordfilter\WordfilterItem[]
*/
protected $item_objects = NULL;
/**
* {@inheritdoc}
*/
public function getProcess() {
if (isset($this->process) && $this->process
->getPluginId() == $this->process_id) {
return $this->process;
}
/**
* @var \Drupal\wordfilter\Plugin\WordfilterProcessManager
*/
$manager = \Drupal::service('plugin.manager.wordfilter_process');
$this
->setProcess($manager
->createInstance($this->process_id));
return $this
->getProcess();
}
/**
* {@inheritdoc}
*/
public function setProcess(WordfilterProcessInterface $process) {
$this
->set('process_id', $process
->getPluginId());
$this->process = $process;
}
/**
* {@inheritdoc}
*/
public function getItems() {
if (isset($this->item_objects)) {
return $this->item_objects;
}
$item_objects = [];
foreach ($this->items as &$item) {
$item_objects[$item['delta']] = new WordfilterItem($this, $item);
}
ksort($item_objects);
$this->item_objects = $item_objects;
return $this
->getItems();
}
/**
* {@inheritdoc}
*/
public function newItem($delta = NULL) {
if (!isset($delta)) {
$delta = 0;
foreach ($this->items as $item) {
if ($delta <= $item['delta']) {
$delta = $item['delta'] + 1;
}
}
}
$this->items[$delta] = [
'delta' => $delta,
'substitute' => '',
'filter_words' => '',
];
$this->item_objects[$delta] = new WordfilterItem($this, $this->items[$delta]);
return $this->item_objects[$delta];
}
/**
* {@inheritdoc}
*/
public function removeItem(WordfilterItem $item_object) {
if ($item_object
->getParent()
->id() !== $this
->id()) {
return FALSE;
}
$delta = $item_object
->getDelta();
foreach ($this->items as $key => $item) {
if ($item['delta'] === $delta) {
unset($this->items[$key]);
unset($this->item_objects[$delta]);
if (!count($this->items)) {
// Fallback: At least one empty item must be present.
$this
->newItem(0);
}
return TRUE;
}
}
return FALSE;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
CacheableDependencyTrait:: |
protected | property | Cache contexts. | |
CacheableDependencyTrait:: |
protected | property | Cache max-age. | |
CacheableDependencyTrait:: |
protected | property | Cache tags. | |
CacheableDependencyTrait:: |
protected | function | Sets cacheability; useful for value object constructors. | |
ConfigEntityBase:: |
private | property | Whether the config is being deleted by the uninstall process. | |
ConfigEntityBase:: |
protected | property | The language code of the entity's default language. | |
ConfigEntityBase:: |
protected | property | The original ID of the configuration entity. | |
ConfigEntityBase:: |
protected | property | The enabled/disabled status of the configuration entity. | 4 |
ConfigEntityBase:: |
protected | property | Third party entity settings. | |
ConfigEntityBase:: |
protected | property | Trust supplied data and not use configuration schema on save. | |
ConfigEntityBase:: |
protected | property | The UUID for this entity. | |
ConfigEntityBase:: |
protected | property | Information maintained by Drupal core about configuration. | |
ConfigEntityBase:: |
protected | function | Overrides \Drupal\Core\Entity\DependencyTrait:addDependency(). | |
ConfigEntityBase:: |
public | function |
Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityInterface:: |
13 |
ConfigEntityBase:: |
public | function |
Creates a duplicate of the entity. Overrides EntityBase:: |
1 |
ConfigEntityBase:: |
public | function |
Disables the configuration entity. Overrides ConfigEntityInterface:: |
1 |
ConfigEntityBase:: |
public | function |
Enables the configuration entity. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Returns the value of a property. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Returns the cache tags that should be used to invalidate caches. Overrides EntityBase:: |
1 |
ConfigEntityBase:: |
public | function |
Gets the configuration dependency name. Overrides EntityBase:: |
|
ConfigEntityBase:: |
protected static | function | Gets the configuration manager. | |
ConfigEntityBase:: |
public | function |
Gets the configuration target identifier for the entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Gets the configuration dependencies. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the original ID. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
protected | function | Gets the typed config manager. | |
ConfigEntityBase:: |
public | function |
Gets whether on not the data is trusted. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
protected static | function |
Override to never invalidate the individual entities' cache tags; the
config system already invalidates them. Overrides EntityBase:: |
|
ConfigEntityBase:: |
protected | function |
Override to never invalidate the entity's cache tag; the config system
already invalidates it. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Checks whether this entity is installable. Overrides ConfigEntityInterface:: |
2 |
ConfigEntityBase:: |
public | function |
Overrides Entity::isNew(). Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Deprecated way of generating a link to the entity. See toLink(). Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface:: |
7 |
ConfigEntityBase:: |
public static | function |
Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase:: |
8 |
ConfigEntityBase:: |
public | function |
Acts on an entity before the presave hook is invoked. Overrides EntityBase:: |
13 |
ConfigEntityBase:: |
public | function |
Saves an entity permanently. Overrides EntityBase:: |
1 |
ConfigEntityBase:: |
public | function |
Sets the value of a property. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Sets the original ID. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Sets the status of the configuration entity. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function | ||
ConfigEntityBase:: |
public static | function | Helper callback for uasort() to sort configuration entities by weight and label. | 6 |
ConfigEntityBase:: |
public | function |
Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface:: |
4 |
ConfigEntityBase:: |
public | function |
Gets an array of all property values. Overrides EntityBase:: |
2 |
ConfigEntityBase:: |
public | function |
Gets the URL object for the entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Sets that the data should be trusted. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Unsets a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the public URL for this entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Gets the URL object for the entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Constructs an Entity object. Overrides EntityBase:: |
10 |
ConfigEntityBase:: |
public | function |
Overrides EntityBase:: |
4 |
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | Aliased as: traitSleep | 1 |
DependencySerializationTrait:: |
public | function | 2 | |
DependencyTrait:: |
protected | property | The object's dependencies. | |
DependencyTrait:: |
protected | function | Adds multiple dependencies. | |
DependencyTrait:: |
protected | function | Adds a dependency. Aliased as: addDependencyTrait | |
EntityBase:: |
protected | property | Boolean indicating whether the entity should be forced to be new. | |
EntityBase:: |
protected | property | The entity type. | |
EntityBase:: |
protected | property | A typed data object wrapping this entity. | |
EntityBase:: |
public | function |
Checks data value access. Overrides AccessibleInterface:: |
1 |
EntityBase:: |
public | function |
Gets the bundle of the entity. Overrides EntityInterface:: |
1 |
EntityBase:: |
public static | function |
Constructs a new entity object, without permanently saving it. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Deletes an entity permanently. Overrides EntityInterface:: |
2 |
EntityBase:: |
public | function |
Enforces an entity to be new. Overrides EntityInterface:: |
|
EntityBase:: |
protected | function | Gets the entity manager. | |
EntityBase:: |
protected | function | Gets the entity type bundle info service. | |
EntityBase:: |
protected | function | Gets the entity type manager. | |
EntityBase:: |
public | function |
The cache contexts associated with this object. Overrides CacheableDependencyTrait:: |
|
EntityBase:: |
public | function |
The maximum age for which this object may be cached. Overrides CacheableDependencyTrait:: |
|
EntityBase:: |
public | function |
The cache tags associated with this object. Overrides CacheableDependencyTrait:: |
|
EntityBase:: |
public | function |
Gets the key that is used to store configuration dependencies. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the entity type definition. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the ID of the type of the entity. Overrides EntityInterface:: |
|
EntityBase:: |
protected | function | The list cache tags to invalidate for this entity. | |
EntityBase:: |
public | function |
Gets a typed data object for this entity object. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Indicates if a link template exists for a given key. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the identifier. Overrides EntityInterface:: |
11 |
EntityBase:: |
public | function |
Gets the label of the entity. Overrides EntityInterface:: |
6 |
EntityBase:: |
public | function |
Gets the language of the entity. Overrides EntityInterface:: |
1 |
EntityBase:: |
protected | function | Gets the language manager. | |
EntityBase:: |
protected | function | Gets an array link templates. | 1 |
EntityBase:: |
public static | function |
Loads an entity. Overrides EntityInterface:: |
|
EntityBase:: |
public static | function |
Loads one or more entities. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Acts on a created entity before hooks are invoked. Overrides EntityInterface:: |
4 |
EntityBase:: |
public static | function |
Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface:: |
16 |
EntityBase:: |
public static | function |
Acts on loaded entities. Overrides EntityInterface:: |
2 |
EntityBase:: |
public | function |
Acts on a saved entity before the insert or update hook is invoked. Overrides EntityInterface:: |
14 |
EntityBase:: |
public static | function |
Changes the values of an entity before it is created. Overrides EntityInterface:: |
5 |
EntityBase:: |
public | function |
Gets a list of entities referenced by this entity. Overrides EntityInterface:: |
1 |
EntityBase:: |
public | function |
Generates the HTML for a link to this entity. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets a list of URI relationships supported by this entity. Overrides EntityInterface:: |
|
EntityBase:: |
protected | function | Gets an array of placeholders for this entity. | 2 |
EntityBase:: |
public | function |
Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface:: |
1 |
EntityBase:: |
protected | function | Gets the UUID generator. | |
PluginDependencyTrait:: |
protected | function | Calculates and adds dependencies of a specific plugin instance. | 1 |
PluginDependencyTrait:: |
protected | function | Calculates and returns dependencies of a specific plugin instance. | |
PluginDependencyTrait:: |
protected | function | Wraps the module handler. | 1 |
PluginDependencyTrait:: |
protected | function | Wraps the theme handler. | 1 |
RefinableCacheableDependencyTrait:: |
public | function | 1 | |
RefinableCacheableDependencyTrait:: |
public | function | ||
RefinableCacheableDependencyTrait:: |
public | function | ||
RefinableCacheableDependencyTrait:: |
public | function | ||
SynchronizableEntityTrait:: |
protected | property | Whether this entity is being created, updated or deleted through a synchronization process. | |
SynchronizableEntityTrait:: |
public | function | ||
SynchronizableEntityTrait:: |
public | function | ||
WordfilterConfiguration:: |
protected | property | The Wordfilter configuration ID. | |
WordfilterConfiguration:: |
protected | property | The filtering items as arrays. | |
WordfilterConfiguration:: |
protected | property | The filtering items as cached objects. | |
WordfilterConfiguration:: |
protected | property | The Wordfilter configuration label. | |
WordfilterConfiguration:: |
protected | property | The assigned Wordfilter process object. | |
WordfilterConfiguration:: |
protected | property | The assigned Wordfilter process id. | |
WordfilterConfiguration:: |
public | function |
Get the filtering items. Overrides WordfilterConfigurationInterface:: |
|
WordfilterConfiguration:: |
public | function |
Get the assigned filtering process. Overrides WordfilterConfigurationInterface:: |
|
WordfilterConfiguration:: |
public | function |
Creates a new item, which is part of this configuration. Overrides WordfilterConfigurationInterface:: |
|
WordfilterConfiguration:: |
public | function |
Remove the filtering item from this configuration. Overrides WordfilterConfigurationInterface:: |
|
WordfilterConfiguration:: |
public | function |
Assign the filtering process. Overrides WordfilterConfigurationInterface:: |