interface FilterFormatInterface in Zircon Profile 8
Same name and namespace in other branches
- 8.0 core/modules/filter/src/FilterFormatInterface.php \Drupal\filter\FilterFormatInterface
Provides an interface defining a filter format entity.
Hierarchy
- interface \Drupal\Core\Entity\EntityInterface; interface \Drupal\Core\Config\Entity\ThirdPartySettingsInterface
- interface \Drupal\Core\Config\Entity\ConfigEntityInterface
- interface \Drupal\filter\FilterFormatInterface
- interface \Drupal\Core\Config\Entity\ConfigEntityInterface
Expanded class hierarchy of FilterFormatInterface
All classes that implement FilterFormatInterface
12 files declare their use of FilterFormatInterface
- CKEditorAdminTest.php in core/
modules/ ckeditor/ src/ Tests/ CKEditorAdminTest.php - Contains \Drupal\ckeditor\Tests\CKEditorAdminTest.
- editor.api.php in core/
modules/ editor/ editor.api.php - Documentation for Text Editor API.
- editor.module in core/
modules/ editor/ editor.module - Adds bindings for client-side "text editors" to text formats.
- EditorController.php in core/
modules/ editor/ src/ EditorController.php - Contains \Drupal\editor\EditorController.
- EditorXssFilterInterface.php in core/
modules/ editor/ src/ EditorXssFilterInterface.php - Contains \Drupal\editor\EditorXssFilterInterface.
File
- core/
modules/ filter/ src/ FilterFormatInterface.php, line 15 - Contains \Drupal\filter\FilterFormatInterface.
Namespace
Drupal\filterView source
interface FilterFormatInterface extends ConfigEntityInterface {
/**
* Returns the ordered collection of filter plugin instances or an individual plugin instance.
*
* @param string $instance_id
* (optional) The ID of a filter plugin instance to return.
*
* @return \Drupal\filter\FilterPluginCollection|\Drupal\filter\Plugin\FilterInterface
* Either the filter collection or a specific filter plugin instance.
*/
public function filters($instance_id = NULL);
/**
* Sets the configuration for a filter plugin instance.
*
* Sets or replaces the configuration of a filter plugin in $this->filters,
* and if instantiated already, also ensures that the actual filter plugin on
* the FilterPluginCollection contains the identical configuration.
*
* @param string $instance_id
* The ID of a filter plugin to set the configuration for.
* @param array $configuration
* The filter plugin configuration to set.
*/
public function setFilterConfig($instance_id, array $configuration);
/**
* Returns if this format is the fallback format.
*
* The fallback format can never be disabled. It must always be available.
*
* @return bool
* TRUE if this format is the fallback format, FALSE otherwise.
*/
public function isFallbackFormat();
/**
* Returns the machine-readable permission name for the text format.
*
* @return string|bool
* The machine-readable permission name, or FALSE if the text format is
* malformed or is the fallback format (which is available to all users).
*/
public function getPermissionName();
/**
* Retrieves all filter types that are used in the text format.
*
* @return array
* All filter types used by filters of the text format.
*/
public function getFilterTypes();
/**
* Retrieve all HTML restrictions (tags and attributes) for the text format.
*
* Note that restrictions applied to the "*" tag (the wildcard tag, i.e. all
* tags) are treated just like any other HTML tag. That means that any
* restrictions applied to it are not automatically applied to all other tags.
* It is up to the caller to handle this in whatever way it sees fit; this way
* no information granularity is lost.
*
* @return array|FALSE
* A structured array as returned by FilterInterface::getHTMLRestrictions(),
* but with the intersection of all filters in this text format.
* Will either indicate blacklisting of tags or whitelisting of tags. In
* the latter case, it's possible that restrictions on attributes are also
* stored. FALSE means there are no HTML restrictions.
*/
public function getHtmlRestrictions();
/**
* Removes a filter.
*
* @param string $instance_id
* The ID of a filter plugin to be removed.
*/
public function removeFilter($instance_id);
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AccessibleInterface:: |
public | function | Checks data value access. | 5 |
CacheableDependencyInterface:: |
public | function | The cache contexts associated with this object. | 26 |
CacheableDependencyInterface:: |
public | function | The maximum age for which this object may be cached. | 26 |
CacheableDependencyInterface:: |
public | function | The cache tags associated with this object. | 19 |
ConfigEntityInterface:: |
public | function | Calculates dependencies and stores them in the dependency property. | 2 |
ConfigEntityInterface:: |
public | function | Disables the configuration entity. | 2 |
ConfigEntityInterface:: |
public | function | Enables the configuration entity. | 2 |
ConfigEntityInterface:: |
public | function | Returns the value of a property. | 2 |
ConfigEntityInterface:: |
public | function | Gets the configuration dependencies. | 2 |
ConfigEntityInterface:: |
public | function | Gets whether on not the data is trusted. | 2 |
ConfigEntityInterface:: |
public | function | Checks whether this entity is installable. | 2 |
ConfigEntityInterface:: |
public | function | Returns whether this entity is being changed as part of an import process. | 2 |
ConfigEntityInterface:: |
public | function | Returns whether this entity is being changed during the uninstall process. | 2 |
ConfigEntityInterface:: |
public | function | Informs the entity that entities it depends on will be deleted. | 2 |
ConfigEntityInterface:: |
public | function | Sets the value of a property. | 2 |
ConfigEntityInterface:: |
public | function | Sets the status of the configuration entity. | 3 |
ConfigEntityInterface:: |
public | function | Sets the status of the isSyncing flag. | 2 |
ConfigEntityInterface:: |
public | function | Returns whether the configuration entity is enabled. | 2 |
ConfigEntityInterface:: |
public | function | Sets that the data should be trusted. | 2 |
EntityInterface:: |
public | function | Gets the bundle of the entity. | 2 |
EntityInterface:: |
public static | function | Constructs a new entity object, without permanently saving it. | 2 |
EntityInterface:: |
public | function | Creates a duplicate of the entity. | 2 |
EntityInterface:: |
public | function | Deletes an entity permanently. | 2 |
EntityInterface:: |
public | function | Enforces an entity to be new. | 2 |
EntityInterface:: |
public | function | Returns the cache tags that should be used to invalidate caches. | 2 |
EntityInterface:: |
public | function | Gets the key that is used to store configuration dependencies. | 2 |
EntityInterface:: |
public | function | Gets the configuration dependency name. | 2 |
EntityInterface:: |
public | function | Gets the configuration target identifier for the entity. | 2 |
EntityInterface:: |
public | function | Gets the entity type definition. | 2 |
EntityInterface:: |
public | function | Gets the ID of the type of the entity. | 2 |
EntityInterface:: |
public | function | Gets the original ID. | 2 |
EntityInterface:: |
public | function | Gets a typed data object for this entity object. | 2 |
EntityInterface:: |
public | function | Indicates if a link template exists for a given key. | 2 |
EntityInterface:: |
public | function | Gets the identifier. | 2 |
EntityInterface:: |
public | function | Determines whether the entity is new. | 2 |
EntityInterface:: |
public | function | Gets the label of the entity. | 2 |
EntityInterface:: |
public | function | Gets the language of the entity. | 2 |
EntityInterface:: |
public | function | Deprecated way of generating a link to the entity. See toLink(). | 2 |
EntityInterface:: |
public static | function | Loads an entity. | 2 |
EntityInterface:: |
public static | function | Loads one or more entities. | 2 |
EntityInterface:: |
public | function | Acts on an entity after it is created but before hooks are invoked. | 2 |
EntityInterface:: |
public static | function | Acts on deleted entities before the delete hook is invoked. | 2 |
EntityInterface:: |
public static | function | Acts on loaded entities. | 3 |
EntityInterface:: |
public | function | Acts on a saved entity before the insert or update hook is invoked. | 2 |
EntityInterface:: |
public static | function | Changes the values of an entity before it is created. | 2 |
EntityInterface:: |
public static | function | Acts on entities before they are deleted and before hooks are invoked. | 2 |
EntityInterface:: |
public | function | Acts on an entity before the presave hook is invoked. | 2 |
EntityInterface:: |
public | function | Gets a list of entities referenced by this entity. | 2 |
EntityInterface:: |
public | function | Saves an entity permanently. | 2 |
EntityInterface:: |
public | function | Sets the original ID. | 2 |
EntityInterface:: |
public | function | Gets an array of all property values. | 3 |
EntityInterface:: |
public | function | Generates the HTML for a link to this entity. | 2 |
EntityInterface:: |
public | function | Gets the URL object for the entity. | 2 |
EntityInterface:: |
public | function | Gets a list of URI relationships supported by this entity. | 2 |
EntityInterface:: |
public | function | Gets the public URL for this entity. | 2 |
EntityInterface:: |
public | function | Gets the URL object for the entity. | 2 |
EntityInterface:: |
public | function | Gets the entity UUID (Universally Unique Identifier). | 2 |
FilterFormatInterface:: |
public | function | Returns the ordered collection of filter plugin instances or an individual plugin instance. | 1 |
FilterFormatInterface:: |
public | function | Retrieves all filter types that are used in the text format. | 1 |
FilterFormatInterface:: |
public | function | Retrieve all HTML restrictions (tags and attributes) for the text format. | 1 |
FilterFormatInterface:: |
public | function | Returns the machine-readable permission name for the text format. | 1 |
FilterFormatInterface:: |
public | function | Returns if this format is the fallback format. | 1 |
FilterFormatInterface:: |
public | function | Removes a filter. | 1 |
FilterFormatInterface:: |
public | function | Sets the configuration for a filter plugin instance. | 1 |
RefinableCacheableDependencyInterface:: |
public | function | Adds a dependency on an object: merges its cacheability metadata. | 1 |
RefinableCacheableDependencyInterface:: |
public | function | Adds cache contexts. | 1 |
RefinableCacheableDependencyInterface:: |
public | function | Adds cache tags. | 1 |
RefinableCacheableDependencyInterface:: |
public | function | Merges the maximum age (in seconds) with the existing maximum age. | 1 |
ThirdPartySettingsInterface:: |
public | function | Gets the list of third parties that store information. | 3 |
ThirdPartySettingsInterface:: |
public | function | Gets the value of a third-party setting. | 3 |
ThirdPartySettingsInterface:: |
public | function | Gets all third-party settings of a given module. | 3 |
ThirdPartySettingsInterface:: |
public | function | Sets the value of a third-party setting. | 3 |
ThirdPartySettingsInterface:: |
public | function | Unsets a third-party setting. | 3 |