FilterCaption
class FilterCaption extends FilterBase implements ContainerFactoryPluginInterface (View source)
Provides a filter to caption elements.
When used in combination with the filter_align filter, this must run last.
Traits
Wrapper methods for \Drupal\Core\StringTranslation\TranslationInterface.
Provides dependency injection friendly methods for serialization.
Provides a trait for the messenger service.
Constants
| DERIVATIVE_SEPARATOR |
A string which is used to separate base plugin IDs from the derivative ID. |
Properties
| protected string | $pluginId | The plugin_id. |
from PluginBase |
| protected array | $pluginDefinition | The plugin implementation definition. |
from PluginBase |
| protected array | $configuration | Configuration information passed into the plugin. |
from PluginBase |
| protected TranslationInterface | $stringTranslation | The string translation service. |
from StringTranslationTrait |
| protected array | $_serviceIds | An array of service IDs keyed by property name used for serialization. |
from DependencySerializationTrait |
| protected array | $_entityStorages | An array of entity type IDs keyed by the property name of their storages. |
from DependencySerializationTrait |
| protected MessengerInterface | $messenger | The messenger. |
from MessengerTrait |
| string | $provider | The name of the provider that owns this filter. |
from FilterBase |
| bool | $status | A Boolean indicating whether this filter is enabled. |
from FilterBase |
| int | $weight | The weight of this filter compared to others in a filter collection. |
from FilterBase |
| array | $settings | An associative array containing the configured settings of this filter. |
from FilterBase |
| protected FilterPluginManager | $filterManager | Filter manager. |
Methods
Constructs a new FilterCaption.
Translates a string to the current language or to a given language.
Formats a string containing a count of items.
Returns the number of plurals supported by a given language.
Gets the string translation service.
Sets the configuration for this plugin instance.
Returns the administrative description for this filter plugin.
Returns HTML allowed by this filter's configuration.
Generates a filter's tip.
Creates an instance of the plugin.
Performs the filter processing.
Details
__construct(array $configuration, string $plugin_id, mixed $plugin_definition, FilterPluginManager $filter_manager = NULL)
Constructs a new FilterCaption.
string
getPluginId()
Gets the plugin_id of the plugin instance.
string
getBaseId()
Gets the base_plugin_id of the plugin instance.
string|null
getDerivativeId()
Gets the derivative_id of the plugin instance.
array
getPluginDefinition()
Gets the definition of the plugin implementation.
bool
isConfigurable()
Determines if the plugin is configurable.
protected TranslatableMarkup
t(string $string, array $args = [], array $options = [])
Translates a string to the current language or to a given language.
See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for important security information and usage guidelines.
In order for strings to be localized, make them available in one of the ways supported by the
protected
formatPlural($count, $singular, $plural, array $args = [], array $options = [])
Formats a string containing a count of items.
protected
getNumberOfPlurals($langcode = NULL)
Returns the number of plurals supported by a given language.
protected TranslationInterface
getStringTranslation()
Gets the string translation service.
$this
setStringTranslation(TranslationInterface $translation)
Sets the string translation service to use.
__sleep()
{@inheritdoc}
__wakeup()
{@inheritdoc}
setMessenger(MessengerInterface $messenger)
Sets the messenger.
MessengerInterface
messenger()
Gets the messenger.
setConfiguration(array $configuration)
Sets the configuration for this plugin instance.
array
getConfiguration()
Gets this plugin's configuration.
array
defaultConfiguration()
Gets default configuration for this plugin.
array
calculateDependencies()
Calculates dependencies for the configured plugin.
Dependencies are saved in the plugin's configuration entity and are used to determine configuration synchronization order. For example, if the plugin integrates with specific user roles, this method should return an array of dependencies listing the specified roles.
int
getType()
Returns the processing type of this filter plugin.
string
getLabel()
Returns the administrative label for this filter plugin.
string
getDescription()
Returns the administrative description for this filter plugin.
array
settingsForm(array $form, FormStateInterface $form_state)
Generates a filter's settings form.
string
prepare(string $text, string $langcode)
Prepares the text for processing.
Filters should not use the prepare method for anything other than escaping, because that would short-circuit the control the user has over the order in which filters are applied.
array|false
getHTMLRestrictions()
Returns HTML allowed by this filter's configuration.
May be implemented by filters of the FilterInterface::TYPE_HTML_RESTRICTOR type, this won't be used for filters of other types; they should just return FALSE.
This callback function is only necessary for filters that strip away HTML tags (and possibly attributes) and allows other modules to gain insight in a generic manner into which HTML tags and attributes are allowed by a format.
string|null
tips(bool $long = FALSE)
Generates a filter's tip.
A filter's tips should be informative and to the point. Short tips are preferably one-liners.
static ContainerFactoryPluginInterface
create(ContainerInterface $container, array $configuration, string $plugin_id, mixed $plugin_definition)
Creates an instance of the plugin.
FilterProcessResult
process(string $text, string $langcode)
Performs the filter processing.