class ImageFormatterBase
Same name and namespace in other branches
- 11.x core/modules/image/src/Plugin/Field/FieldFormatter/ImageFormatterBase.php \Drupal\image\Plugin\Field\FieldFormatter\ImageFormatterBase
- 10 core/modules/image/src/Plugin/Field/FieldFormatter/ImageFormatterBase.php \Drupal\image\Plugin\Field\FieldFormatter\ImageFormatterBase
- 9 core/modules/image/src/Plugin/Field/FieldFormatter/ImageFormatterBase.php \Drupal\image\Plugin\Field\FieldFormatter\ImageFormatterBase
Base class for image file formatters.
Hierarchy
- class \Drupal\file\Plugin\Field\FieldFormatter\FileFormatterBase extends \Drupal\Core\Field\Plugin\Field\FieldFormatter\EntityReferenceFormatterBase
- class \Drupal\image\Plugin\Field\FieldFormatter\ImageFormatterBase extends \Drupal\file\Plugin\Field\FieldFormatter\FileFormatterBase
Expanded class hierarchy of ImageFormatterBase
1 file declares its use of ImageFormatterBase
- ResponsiveImageFormatter.php in core/
modules/ responsive_image/ src/ Plugin/ Field/ FieldFormatter/ ResponsiveImageFormatter.php
File
-
core/
modules/ image/ src/ Plugin/ Field/ FieldFormatter/ ImageFormatterBase.php, line 12
Namespace
Drupal\image\Plugin\Field\FieldFormatterView source
abstract class ImageFormatterBase extends FileFormatterBase {
/**
* {@inheritdoc}
*/
protected function getEntitiesToView(EntityReferenceFieldItemListInterface $items, $langcode) {
// Add the default image if needed.
if ($items->isEmpty()) {
$default_image = $this->getFieldSetting('default_image');
// If we are dealing with a configurable field, look in both
// instance-level and field-level settings.
if (empty($default_image['uuid']) && $this->fieldDefinition instanceof FieldConfigInterface) {
$default_image = $this->fieldDefinition
->getFieldStorageDefinition()
->getSetting('default_image');
}
if (!empty($default_image['uuid']) && $file = \Drupal::service('entity.repository')->loadEntityByUuid('file', $default_image['uuid'])) {
// Clone the FieldItemList into a runtime-only object for the formatter,
// so that the fallback image can be rendered without affecting the
// field values in the entity being rendered.
$items = clone $items;
$items->setValue([
'target_id' => $file->id(),
'alt' => $default_image['alt'],
'title' => $default_image['title'],
'width' => $default_image['width'],
'height' => $default_image['height'],
'entity' => $file,
'_loaded' => TRUE,
'_is_default' => TRUE,
]);
$file->_referringItem = $items[0];
}
}
return parent::getEntitiesToView($items, $langcode);
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
DependencySerializationTrait::$_entityStorages | protected | property | An array of entity type IDs keyed by the property name of their storages. | ||
DependencySerializationTrait::$_serviceIds | protected | property | An array of service IDs keyed by property name used for serialization. | ||
DependencySerializationTrait::__sleep | public | function | |||
DependencySerializationTrait::__wakeup | public | function | |||
EntityReferenceFormatterBase::prepareView | public | function | Loads the entities referenced in that field across all the entities being viewed. |
||
EntityReferenceFormatterBase::view | public | function | |||
FileFormatterBase::checkAccess | protected | function | |||
FileFormatterBase::needsEntityLoad | protected | function | |||
FormatterBase::$fieldDefinition | protected | property | The field definition. | ||
FormatterBase::$label | protected | property | The label display setting. | ||
FormatterBase::$settings | protected | property | The formatter settings. | ||
FormatterBase::$viewMode | protected | property | The view mode. | ||
FormatterBase::create | public static | function | |||
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 | |||
FormatterBase::settingsForm | public | function | 1 | ||
FormatterBase::settingsSummary | public | function | 1 | ||
FormatterBase::__construct | public | function | Constructs a FormatterBase object. | ||
FormatterInterface::viewElements | public | function | Builds a renderable array for a field value. | 2 | |
ImageFormatterBase::getEntitiesToView | protected | function | Returns the referenced entities for display. | Overrides EntityReferenceFormatterBase::getEntitiesToView | |
MessengerTrait::$messenger | protected | property | The messenger. | 3 | |
MessengerTrait::messenger | public | function | Gets the messenger. | 3 | |
MessengerTrait::setMessenger | public | function | Sets the messenger. | ||
PluginBase::$configuration | protected | property | Configuration information passed into the plugin. | 1 | |
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 | |||
PluginBase::getDerivativeId | public | function | |||
PluginBase::getPluginDefinition | public | function | 1 | ||
PluginBase::getPluginId | public | function | |||
PluginBase::isConfigurable | public | function | Determines if the plugin is configurable. | ||
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 | |||
PluginSettingsBase::defaultSettings | public static | function | 1 | ||
PluginSettingsBase::getSetting | public | function | |||
PluginSettingsBase::getSettings | public | function | |||
PluginSettingsBase::getThirdPartyProviders | public | function | |||
PluginSettingsBase::getThirdPartySetting | public | function | |||
PluginSettingsBase::getThirdPartySettings | public | function | |||
PluginSettingsBase::mergeDefaults | protected | function | Merges default settings values into $settings. | ||
PluginSettingsBase::onDependencyRemoval | public | function | |||
PluginSettingsBase::setSetting | public | function | |||
PluginSettingsBase::setSettings | public | function | |||
PluginSettingsBase::setThirdPartySetting | public | function | |||
PluginSettingsBase::unsetThirdPartySetting | public | function | |||
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. | 1 | |
StringTranslationTrait::t | protected | function | Translates a string to the current language or to a given language. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.