Base class for 'Field formatter' plugin implementations.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, StringTranslationTrait
- class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
- class \Drupal\Core\Field\FormatterBase implements FormatterInterface
- class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, StringTranslationTrait
Related topics
- Field Formatter API
- Define Field API formatter types.
File
- core/lib/Drupal/Core/Field/FormatterBase.php, line 14
Namespace
Drupal\Core\Field
Members
| Name | Modifiers | Type | Description |
|---|---|---|---|
| DependencySerializationTrait::$_serviceIds | protected | property | An array of service IDs keyed by property name used for serialization. |
| DependencySerializationTrait::__sleep | public | function | |
| DependencySerializationTrait::__wakeup | public | function | |
| FormatterBase::$fieldDefinition | protected | property | The field definition. |
| FormatterBase::$label | protected | property | The label display setting. |
| FormatterBase::$settings | protected | property | The formatter settings. Overrides PluginSettingsBase::$settings |
| FormatterBase::$viewMode | protected | property | The view mode. |
| FormatterBase::getFieldSetting | protected | function | Returns the value of a field setting. |
| FormatterBase::getFieldSettings | protected | function | Returns the array of field settings. |
| FormatterBase::isApplicable | public static | function | Returns if the formatter can be used for the provided field. Overrides FormatterInterface::isApplicable |
| FormatterBase::prepareView | public | function | Allows formatters to load information for field values being displayed. Overrides FormatterInterface::prepareView |
| FormatterBase::settingsForm | public | function | Returns a form to configure settings for the formatter. Overrides FormatterInterface::settingsForm |
| FormatterBase::settingsSummary | public | function | Returns a short summary for the current formatter settings. Overrides FormatterInterface::settingsSummary |
| FormatterBase::view | public | function | Builds a renderable array for a fully themed field. Overrides FormatterInterface::view |
| FormatterBase::__construct | public | function | Constructs a FormatterBase object. Overrides PluginBase::__construct |
| FormatterInterface::viewElements | public | function | Builds a renderable array for a field value. |
| PluginBase::$configuration | protected | property | Configuration information passed into the plugin. |
| PluginBase::$pluginDefinition | protected | property | The plugin implementation definition. |
| PluginBase::$pluginId | protected | property | The plugin_id. |
| PluginBase::DERIVATIVE_SEPARATOR | constant | A string which is used to separate base plugin IDs from the derivative ID. | |
| PluginBase::getBaseId | public | function | Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId |
| PluginBase::getDerivativeId | public | function | Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId |
| PluginBase::getPluginDefinition | public | function | Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition |
| PluginBase::getPluginId | public | function | Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId |
| PluginSettingsBase::$defaultSettingsMerged | protected | property | Whether default settings have been merged into the current $settings. |
| PluginSettingsBase::$thirdPartySettings | protected | property | The plugin settings injected by third party modules. |
| PluginSettingsBase::calculateDependencies | public | function | Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies |
| PluginSettingsBase::defaultSettings | public static | function | Defines the default settings for this plugin. Overrides PluginSettingsInterface::defaultSettings |
| PluginSettingsBase::getSetting | public | function | Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting |
| PluginSettingsBase::getSettings | public | function | Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings |
| PluginSettingsBase::getThirdPartyProviders | public | function | Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders |
| PluginSettingsBase::getThirdPartySetting | public | function | Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting |
| PluginSettingsBase::getThirdPartySettings | public | function | Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings |
| PluginSettingsBase::mergeDefaults | protected | function | Merges default settings values into $settings. |
| PluginSettingsBase::onDependencyRemoval | public | function | Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval |
| PluginSettingsBase::setSetting | public | function | Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting |
| PluginSettingsBase::setSettings | public | function | Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings |
| PluginSettingsBase::setThirdPartySetting | public | function | Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting |
| PluginSettingsBase::unsetThirdPartySetting | public | function | Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting |
| StringTranslationTrait::$stringTranslation | protected | property | The string translation service. |
| StringTranslationTrait::formatPlural | protected | function | Formats a string containing a count of items. |
| StringTranslationTrait::getNumberOfPlurals | protected | function | Returns the number of plurals supported by a given language. |
| StringTranslationTrait::getStringTranslation | protected | function | Gets the string translation service. |
| StringTranslationTrait::setStringTranslation | public | function | Sets the string translation service to use. |
| StringTranslationTrait::t | protected | function | Translates a string to the current language or to a given language. |
Please login to continue.