FilemimeFormatter
class FilemimeFormatter extends BaseFieldFileFormatterBase (View source)
Formatter to render the file MIME type, with an optional icon.
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 |
| protected array | $settings | The formatter settings. |
from FormatterBase |
| protected array | $thirdPartySettings | The plugin settings injected by third party modules. |
from PluginSettingsBase |
| protected bool | $defaultSettingsMerged | Whether default settings have been merged into the current $settings. |
from PluginSettingsBase |
| protected FieldDefinitionInterface | $fieldDefinition | The field definition. |
from FormatterBase |
| protected string | $label | The label display setting. |
from FormatterBase |
| protected string | $viewMode | The view mode. |
from FormatterBase |
| protected FileUrlGeneratorInterface | $fileUrlGenerator | The file URL generator. |
from BaseFieldFileFormatterBase |
Methods
Constructs a BaseFieldFileFormatterBase object.
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.
Defines the default settings for this plugin.
Returns the array of settings, including defaults for missing settings.
Returns the value of a setting, or its default value if absent.
Sets the value of a setting for the plugin.
Gets all third-party settings of a given module.
Gets the value of a third-party setting.
Sets the value of a third-party setting.
Unsets a third-party setting.
Gets the list of third parties that store information.
Calculates dependencies for the configured plugin.
Informs the plugin that some configuration it depends on will be deleted.
Creates an instance of the plugin.
Builds a renderable array for a fully themed field.
Returns a form to configure settings for the formatter.
Returns a short summary for the current formatter settings.
Allows formatters to load information for field values being displayed.
Returns the value of a field setting.
Returns if the formatter can be used for the provided field.
Builds a renderable array for a field value.
Details
__construct(string $plugin_id, mixed $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, string $label, string $view_mode, array $third_party_settings, FileUrlGeneratorInterface $file_url_generator = NULL)
Constructs a BaseFieldFileFormatterBase object.
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.
static array
defaultSettings()
Defines the default settings for this plugin.
array
getSettings()
Returns the array of settings, including defaults for missing settings.
mixed
getSetting(string $key)
Returns the value of a setting, or its default value if absent.
protected
mergeDefaults()
Merges default settings values into $settings.
$this
setSettings(array $settings)
Sets the settings for the plugin.
$this
setSetting(string $key, mixed $value)
Sets the value of a setting for the plugin.
array
getThirdPartySettings(string $module = NULL)
Gets all third-party settings of a given module.
mixed
getThirdPartySetting(string $module, string $key, mixed $default = NULL)
Gets the value of a third-party setting.
$this
setThirdPartySetting(string $module, string $key, mixed $value)
Sets the value of a third-party setting.
mixed
unsetThirdPartySetting(string $module, string $key)
Unsets a third-party setting.
array
getThirdPartyProviders()
Gets the list of third parties that store information.
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.
bool
onDependencyRemoval(array $dependencies)
Informs the plugin that some configuration it depends on will be deleted.
This method allows plugins to keep their configuration up-to-date when a dependency calculated with ::calculateDependencies() is removed. For example, an entity view display contains a formatter having a setting pointing to an arbitrary config entity. When that config entity is deleted, this method is called by the view display to react to the dependency removal by updating its configuration.
This method must return TRUE if the removal event updated the plugin configuration or FALSE otherwise.
static ContainerFactoryPluginInterface
create(ContainerInterface $container, array $configuration, string $plugin_id, mixed $plugin_definition)
Creates an instance of the plugin.
array
view(FieldItemListInterface $items, string $langcode = NULL)
Builds a renderable array for a fully themed field.
array
settingsForm(array $form, FormStateInterface $form_state)
Returns a form to configure settings for the formatter.
Invoked from \Drupal\field_ui\Form\EntityDisplayFormBase to allow administrators to configure the formatter. The field_ui module takes care of handling submitted form values.
string[]
settingsSummary()
Returns a short summary for the current formatter settings.
If an empty result is returned, a UI can still be provided to display a settings form in case the formatter has configurable settings.
prepareView(array $entities_items)
Allows formatters to load information for field values being displayed.
This should be used when a formatter needs to load additional information from the database in order to render a field, for example a reference field that displays properties of the referenced entities such as name or type.
This method operates on multiple entities. The $entities_items parameter is an array keyed by entity ID. For performance reasons, information for all involved entities should be loaded in a single query where possible.
Changes or additions to field values are done by directly altering the items.
protected array
getFieldSettings()
Returns the array of field settings.
protected mixed
getFieldSetting(string $setting_name)
Returns the value of a field setting.
static bool
isApplicable(FieldDefinitionInterface $field_definition)
Returns if the formatter can be used for the provided field.
array
viewElements(FieldItemListInterface $items, string $langcode)
Builds a renderable array for a field value.
protected mixed
viewValue(FieldItemInterface $item)
Generate the output appropriate for one field item.