class ImageFormatterBase

Same name in other branches
  1. 8.9.x core/modules/image/src/Plugin/Field/FieldFormatter/ImageFormatterBase.php \Drupal\image\Plugin\Field\FieldFormatter\ImageFormatterBase
  2. 10 core/modules/image/src/Plugin/Field/FieldFormatter/ImageFormatterBase.php \Drupal\image\Plugin\Field\FieldFormatter\ImageFormatterBase
  3. 11.x core/modules/image/src/Plugin/Field/FieldFormatter/ImageFormatterBase.php \Drupal\image\Plugin\Field\FieldFormatter\ImageFormatterBase

Base class for image file formatters.

Hierarchy

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\FieldFormatter
View 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
EntityReferenceFormatterBase::prepareView public function Loads the entities referenced in that field across all the entities being
viewed.
Overrides FormatterBase::prepareView
EntityReferenceFormatterBase::view public function Overrides FormatterBase::view
FileFormatterBase::checkAccess protected function Checks access to the given entity. Overrides EntityReferenceFormatterBase::checkAccess 1
FileFormatterBase::needsEntityLoad protected function Returns whether the entity referenced by an item needs to be loaded. Overrides EntityReferenceFormatterBase::needsEntityLoad 1
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::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 13
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 14
FormatterBase::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterInterface::settingsForm 25
FormatterBase::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterInterface::settingsSummary 23
FormatterBase::__construct public function Constructs a FormatterBase object. 13
FormatterInterface::viewElements public function Builds a renderable array for a field value. 48
ImageFormatterBase::getEntitiesToView protected function Returns the referenced entities for display. Overrides EntityReferenceFormatterBase::getEntitiesToView
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
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 6
PluginSettingsBase::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsInterface::defaultSettings 43
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 3
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

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.