abstract class BlazyFileFormatterBase in Blazy 8.2
Same name and namespace in other branches
- 8 src/Plugin/Field/FieldFormatter/BlazyFileFormatterBase.php \Drupal\blazy\Plugin\Field\FieldFormatter\BlazyFileFormatterBase
Base class for blazy/slick image, and file ER formatters.
Defines one base class to extend for both image and file ER formatters as otherwise different base classes: ImageFormatterBase or FileFormatterBase.
@todo remove no longer in use: ImageFactory at blazy:3.x.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
- class \Drupal\Core\Field\FormatterBase implements FormatterInterface, ContainerFactoryPluginInterface
- class \Drupal\Core\Field\Plugin\Field\FieldFormatter\EntityReferenceFormatterBase
- class \Drupal\file\Plugin\Field\FieldFormatter\FileFormatterBase
- class \Drupal\blazy\Plugin\Field\FieldFormatter\BlazyFileFormatterBase uses BlazyDependenciesTrait, BlazyFormatterTrait, BlazyFormatterViewTrait
- class \Drupal\file\Plugin\Field\FieldFormatter\FileFormatterBase
- class \Drupal\Core\Field\Plugin\Field\FieldFormatter\EntityReferenceFormatterBase
- class \Drupal\Core\Field\FormatterBase implements FormatterInterface, ContainerFactoryPluginInterface
- class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of BlazyFileFormatterBase
See also
Drupal\blazy\Plugin\Field\FieldFormatter\BlazyFormatter.
Drupal\blazy\Plugin\Field\FieldFormatter\BlazyFileFormatter.
Drupal\slick\Plugin\Field\FieldFormatter\SlickImageFormatter.
Drupal\slick\Plugin\Field\FieldFormatter\SlickFileFormatter.
File
- src/
Plugin/ Field/ FieldFormatter/ BlazyFileFormatterBase.php, line 27
Namespace
Drupal\blazy\Plugin\Field\FieldFormatterView source
abstract class BlazyFileFormatterBase extends FileFormatterBase {
use BlazyFormatterTrait;
use BlazyFormatterViewTrait;
use BlazyDependenciesTrait;
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
$instance = parent::create($container, $configuration, $plugin_id, $plugin_definition);
return self::injectServices($instance, $container, 'image');
}
/**
* {@inheritdoc}
*/
public static function defaultSettings() {
return BlazyDefault::imageSettings() + BlazyDefault::gridSettings();
}
/**
* Build individual item if so configured such as for file ER goodness.
*/
public function buildElement(array &$build, $entity) {
// Do nothing.
}
/**
* {@inheritdoc}
*/
public function settingsForm(array $form, FormStateInterface $form_state) {
$element = [];
$definition = $this
->getScopedFormElements();
$definition['_views'] = isset($form['field_api_classes']);
$this
->admin()
->buildSettingsForm($element, $definition);
return $element;
}
/**
* Defines the scope for the form elements.
*/
public function getScopedFormElements() {
$multiple = $this->fieldDefinition
->getFieldStorageDefinition()
->isMultiple();
$captions = [
'title' => $this
->t('Title'),
'alt' => $this
->t('Alt'),
];
return [
'background' => TRUE,
'box_captions' => TRUE,
'captions' => $captions,
'grid_form' => $multiple,
'image_style_form' => TRUE,
'media_switch_form' => TRUE,
'style' => $multiple,
'thumbnail_style' => TRUE,
] + $this
->getCommonScopedFormElements();
}
/**
* Overrides parent::needsEntityLoad().
*
* One step back to have both image and file ER plugins extend this, because
* EntityReferenceItem::isDisplayed() doesn't exist, except for ImageItem
* which is always TRUE anyway for type image and file ER.
*/
protected function needsEntityLoad(EntityReferenceItem $item) {
return !$item
->hasNewEntity();
}
/**
* {@inheritdoc}
*
* A clone of Drupal\image\Plugin\Field\FieldFormatter\ImageFormatterBase so
* to have one base class to extend for both image and file ER formatters.
*/
protected function getEntitiesToView(EntityReferenceFieldItemListInterface $items, $langcode) {
// Add the default image if the type is image.
if ($items
->isEmpty() && $this->fieldDefinition
->getType() === 'image') {
$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 = $this->formatter
->getEntityRepository()
->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
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
BlazyDependenciesTrait:: |
public | function | ||
BlazyDependenciesTrait:: |
public | function | ||
BlazyFileFormatterBase:: |
public | function | Build individual item if so configured such as for file ER goodness. | 1 |
BlazyFileFormatterBase:: |
public static | function |
Creates an instance of the plugin. Overrides FormatterBase:: |
1 |
BlazyFileFormatterBase:: |
public static | function |
Defines the default settings for this plugin. Overrides PluginSettingsBase:: |
|
BlazyFileFormatterBase:: |
protected | function |
A clone of Drupal\image\Plugin\Field\FieldFormatter\ImageFormatterBase so
to have one base class to extend for both image and file ER formatters. Overrides EntityReferenceFormatterBase:: |
|
BlazyFileFormatterBase:: |
public | function | Defines the scope for the form elements. | 1 |
BlazyFileFormatterBase:: |
protected | function |
Overrides parent::needsEntityLoad(). Overrides FileFormatterBase:: |
|
BlazyFileFormatterBase:: |
public | function |
Returns a form to configure settings for the formatter. Overrides FormatterBase:: |
|
BlazyFormatterTrait:: |
protected | property | The blazy manager service. | |
BlazyFormatterTrait:: |
protected | property | The blazy manager service. | |
BlazyFormatterTrait:: |
public | function | Returns the blazy admin service. | 1 |
BlazyFormatterTrait:: |
public | function | Returns the blazy manager. | |
BlazyFormatterTrait:: |
public | function | Builds the settings. | 1 |
BlazyFormatterTrait:: |
public | function | Returns the blazy formatter manager. | |
BlazyFormatterTrait:: |
public | function | Defines the common scope for both front and admin. | |
BlazyFormatterTrait:: |
public | function | Defines the common scope for the form elements. | |
BlazyFormatterTrait:: |
protected static | function | Injects DI services. | |
BlazyFormatterTrait:: |
public | function | ||
BlazyFormatterViewTrait:: |
public | function | Returns similar view elements. | |
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
EntityReferenceFormatterBase:: |
public | function |
Loads the entities referenced in that field across all the entities being
viewed. Overrides FormatterBase:: |
|
EntityReferenceFormatterBase:: |
public | function |
Overrides FormatterBase:: |
|
FileFormatterBase:: |
protected | function |
Checks access to the given entity. Overrides EntityReferenceFormatterBase:: |
|
FormatterBase:: |
protected | property | The field definition. | |
FormatterBase:: |
protected | property | The label display setting. | |
FormatterBase:: |
protected | property |
The formatter settings. Overrides PluginSettingsBase:: |
|
FormatterBase:: |
protected | property | The view mode. | |
FormatterBase:: |
protected | function | Returns the value of a field setting. | |
FormatterBase:: |
protected | function | Returns the array of field settings. | |
FormatterBase:: |
public static | function |
Returns if the formatter can be used for the provided field. Overrides FormatterInterface:: |
14 |
FormatterBase:: |
public | function |
Constructs a FormatterBase object. Overrides PluginBase:: |
11 |
FormatterInterface:: |
public | function | Builds a renderable array for a field value. | 47 |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginSettingsBase:: |
protected | property | Whether default settings have been merged into the current $settings. | |
PluginSettingsBase:: |
protected | property | The plugin settings injected by third party modules. | |
PluginSettingsBase:: |
public | function |
Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
protected | function | Merges default settings values into $settings. | |
PluginSettingsBase:: |
public | function |
Sets the value of a setting for the plugin. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Sets the settings for the plugin. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Unsets a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |