class AmpImageFormatter in Accelerated Mobile Pages (AMP) 8.3
Same name and namespace in other branches
- 8 src/Plugin/Field/FieldFormatter/AmpImageFormatter.php \Drupal\amp\Plugin\Field\FieldFormatter\AmpImageFormatter
- 8.2 src/Plugin/Field/FieldFormatter/AmpImageFormatter.php \Drupal\amp\Plugin\Field\FieldFormatter\AmpImageFormatter
Plugin implementation of the 'amp_image' formatter.
Plugin annotation
@FieldFormatter(
id = "amp_image",
label = @Translation("AMP Image Formatter"),
description = @Translation("Display an image file as amp-image."),
field_types = {
"image"
}
)
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\image\Plugin\Field\FieldFormatter\ImageFormatterBase
- class \Drupal\image\Plugin\Field\FieldFormatter\ImageFormatter implements ContainerFactoryPluginInterface
- class \Drupal\amp\Plugin\Field\FieldFormatter\AmpImageFormatter uses AmpFormTrait
- class \Drupal\image\Plugin\Field\FieldFormatter\ImageFormatter implements ContainerFactoryPluginInterface
- class \Drupal\image\Plugin\Field\FieldFormatter\ImageFormatterBase
- 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 AmpImageFormatter
1 file declares its use of AmpImageFormatter
- AmpMediaImageFormatter.php in src/
Plugin/ Field/ FieldFormatter/ AmpMediaImageFormatter.php
File
- src/
Plugin/ Field/ FieldFormatter/ AmpImageFormatter.php, line 22
Namespace
Drupal\amp\Plugin\Field\FieldFormatterView source
class AmpImageFormatter extends ImageFormatter {
use AmpFormTrait;
/**
* AMP layouts
*
* Expected by AmpFormTrait.
*
* @return array
* Array of layout options allowed by this component.
*/
private function getLayouts() {
$options = $this
->allLayouts();
unset($options['container']);
return $options;
}
/**
* AMP libraries
*
* Expected by AmpFormTrait.
*
* @return array
* The names of the AMP libraries used by this formatter.
*/
private function getLibraries() {
return [
'amp/amp.image',
];
}
/**
* {@inheritdoc}
*/
public static function defaultSettings() {
return [
'layout' => 'responsive',
'width' => '',
'height' => '',
] + parent::defaultSettings();
}
/**
* {@inheritdoc}
*/
public function settingsForm(array $form, FormStateInterface $form_state) {
$form = parent::settingsForm($form, $form_state);
$form['layout'] = $this
->layoutElement();
$form['width'] = $this
->widthElement();
$form['height'] = $this
->heightElement();
$form['#prefix'] = '<div class="description">' . $this
->libraryDescription() . '</div>';
return $form;
}
/**
* {@inheritdoc}
*/
public function settingsSummary() {
$summary = parent::settingsSummary();
$summary = $this
->addToSummary($summary);
return [
implode('; ', $summary),
];
}
/**
* {@inheritdoc}
*/
public function viewElements(FieldItemListInterface $items, $langcode) {
$elements = parent::viewElements($items, $langcode);
$layout = $this
->getSetting('layout');
$width = $this
->validWidth($this
->getSetting('width'), $this
->getSetting('layout'));
$height = $this
->validHeight($this
->getSetting('height'), $this
->getSetting('layout'));
foreach ($elements as $delta => $element) {
$elements[$delta]['#item_attributes']['layout'] = $layout;
$elements[$delta]['#item_attributes']['width'] = $width;
$elements[$delta]['#item_attributes']['height'] = $height;
$elements[$delta]['#item_attributes'] = array_filter($elements[$delta]['#item_attributes']);
$elements[$delta]['#item_attributes']['loading'] = FALSE;
}
$elements['#attached']['library'] = $this
->getLibraries();
return $elements;
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AmpFormTrait:: |
public | function | Update the summary. | |
AmpFormTrait:: |
public | function | AMP Layouts. | |
AmpFormTrait:: |
public | function | All settings. | |
AmpFormTrait:: |
public | function | The autoplay form element. | |
AmpFormTrait:: |
public | function | The controls form element. | |
AmpFormTrait:: |
public | function | The height form element. | |
AmpFormTrait:: |
public | function | See if selected height is invalid based on the selected layout. | |
AmpFormTrait:: |
public | function | The layout form element. | |
AmpFormTrait:: |
public | function | The #states layout selector. | |
AmpFormTrait:: |
public | function | LibraryDescription. | |
AmpFormTrait:: |
public | function | The loop form element. | |
AmpFormTrait:: |
public | function | The autoplay setting, taking into account user permissions. | |
AmpFormTrait:: |
public | function | Limit the height based on the layout. | |
AmpFormTrait:: |
public | function | Limit the width based on the layout. | |
AmpFormTrait:: |
public | function | The width form element. | |
AmpFormTrait:: |
public | function | See if selected width is invalid based on the selected layout. | |
AmpImageFormatter:: |
public static | function |
Defines the default settings for this plugin. Overrides ImageFormatter:: |
|
AmpImageFormatter:: |
private | function | AMP layouts | |
AmpImageFormatter:: |
private | function | AMP libraries | |
AmpImageFormatter:: |
public | function |
Returns a form to configure settings for the formatter. Overrides ImageFormatter:: |
|
AmpImageFormatter:: |
public | function |
Returns a short summary for the current formatter settings. Overrides ImageFormatter:: |
|
AmpImageFormatter:: |
public | function |
Builds a renderable array for a field value. Overrides ImageFormatter:: |
|
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:: |
|
FileFormatterBase:: |
protected | function |
Returns whether the entity referenced by an item needs to be loaded. Overrides EntityReferenceFormatterBase:: |
1 |
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 |
ImageFormatter:: |
protected | property | The current user. | |
ImageFormatter:: |
protected | property | The image style entity storage. | |
ImageFormatter:: |
public | function |
Calculates dependencies for the configured plugin. Overrides PluginSettingsBase:: |
|
ImageFormatter:: |
public static | function |
Creates an instance of the plugin. Overrides FormatterBase:: |
1 |
ImageFormatter:: |
public | function |
Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsBase:: |
|
ImageFormatter:: |
public | function |
Constructs an ImageFormatter object. Overrides FormatterBase:: |
1 |
ImageFormatterBase:: |
protected | function |
Returns the referenced entities for display. Overrides EntityReferenceFormatterBase:: |
|
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. |