class AutoImageStyleResponsive in Auto image style 8

Plugin annotation


@FieldFormatter(
 id = "auto_image_style_responsive",
 label = @Translation("Responsive image auto orientation"),
 description = @Translation("Display responsive image fields as portrait or landscape style"),
 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\responsive_image\Plugin\Field\FieldFormatter\ResponsiveImageFormatter implements ContainerFactoryPluginInterface
    class \Drupal\auto_image_style\Plugin\Field\FieldFormatter\AutoImageStyleResponsive

Expanded class hierarchy of AutoImageStyleResponsive

File

src/Plugin/Field/FieldFormatter/AutoImageStyleResponsive.php, line 20

Namespace

Drupal\auto_image_style\Plugin\Field\FieldFormatter

View source

class AutoImageStyleResponsive extends ResponsiveImageFormatter {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'responsive_image_style_landscape' => '',
      'responsive_image_style_portrait' => '',
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $responsive_image_options = [];
    $responsive_image_styles = $this->responsiveImageStyleStorage
      ->loadMultiple();
    if ($responsive_image_styles && !empty($responsive_image_styles)) {
      foreach ($responsive_image_styles as $machine_name => $responsive_image_style) {
        if ($responsive_image_style
          ->hasImageStyleMappings()) {
          $responsive_image_options[$machine_name] = $responsive_image_style
            ->label();
        }
      }
    }
    $elements['responsive_image_style_landscape'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Responsive landscape image style'),
      '#options' => $responsive_image_options,
      '#empty_option' => $this
        ->t('None (original image)'),
      '#default_value' => $this
        ->getSetting('responsive_image_style_landscape'),
      '#description' => $this
        ->t('Select the responsive image style for landscape images'),
    ];
    $elements['responsive_image_style_portrait'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Responsive portrait image style'),
      '#options' => $responsive_image_options,
      '#empty_option' => $this
        ->t('None (original image)'),
      '#default_value' => $this
        ->getSetting('responsive_image_style_portrait'),
      '#description' => $this
        ->t('Select the responsive image style for portrait images'),
    ];
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];
    $responsive_landscape_image_style = $this->responsiveImageStyleStorage
      ->load($this
      ->getSetting('responsive_image_style_landscape'));
    if ($responsive_landscape_image_style) {
      $summary[] = $this
        ->t('Responsive landscape image style: @responsive_image_style', [
        '@responsive_image_style' => $responsive_landscape_image_style
          ->label(),
      ]);
    }
    else {
      $summary[] = $this
        ->t('Select a responsive landscape image style.');
    }
    $responsive_portrait_image_style = $this->responsiveImageStyleStorage
      ->load($this
      ->getSetting('responsive_image_style_portrait'));
    if ($responsive_portrait_image_style) {
      $summary[] = $this
        ->t('Responsive portrait image style: @responsive_image_style', [
        '@responsive_image_style' => $responsive_portrait_image_style
          ->label(),
      ]);
    }
    else {
      $summary[] = $this
        ->t('Select a responsive portrait image style.');
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];
    $files = $this
      ->getEntitiesToView($items, $langcode);

    // Early opt-out if the field is empty.
    if (empty($files)) {
      return $elements;
    }

    // Currently no link handling.
    $url = NULL;

    // Collect cache tags to be added for each item in the field.
    $cache_tags = [];
    $image_styles_to_load = [];
    $responsive_image_style_landscape = $this->responsiveImageStyleStorage
      ->load($this
      ->getSetting('responsive_image_style_landscape'));
    if ($responsive_image_style_landscape) {
      $cache_tags = Cache::mergeTags($cache_tags, $responsive_image_style_landscape
        ->getCacheTags());
      $image_styles_to_load = $responsive_image_style_landscape
        ->getImageStyleIds();
    }
    $image_styles = $this->imageStyleStorage
      ->loadMultiple($image_styles_to_load);
    foreach ($image_styles as $image_style) {
      $cache_tags = Cache::mergeTags($cache_tags, $image_style
        ->getCacheTags());
    }
    $responsive_image_style_portrait = $this->responsiveImageStyleStorage
      ->load($this
      ->getSetting('responsive_image_style_portrait'));
    if ($responsive_image_style_portrait) {
      $cache_tags = Cache::mergeTags($cache_tags, $responsive_image_style_portrait
        ->getCacheTags());
      $image_styles_to_load = $responsive_image_style_portrait
        ->getImageStyleIds();
    }
    $image_styles = $this->imageStyleStorage
      ->loadMultiple($image_styles_to_load);
    foreach ($image_styles as $image_style) {
      $cache_tags = Cache::mergeTags($cache_tags, $image_style
        ->getCacheTags());
    }
    foreach ($files as $delta => $file) {
      $cache_tags = Cache::mergeTags($cache_tags, $file
        ->getCacheTags());

      // Extract field item attributes for the theme function, and unset them
      // from the $item so that the field template does not re-render them.
      $item = $file->_referringItem;
      $responsive_image_style = $responsive_image_style_portrait;
      if ($item->height < $item->width) {
        $responsive_image_style = $responsive_image_style_landscape;
      }
      $item_attributes = $item->_attributes;
      unset($item->_attributes);
      $elements[$delta] = [
        '#theme' => 'responsive_image_formatter',
        '#item' => $item,
        '#item_attributes' => $item_attributes,
        '#responsive_image_style_id' => $responsive_image_style ? $responsive_image_style
          ->id() : '',
        '#url' => $url,
        '#cache' => [
          'tags' => $cache_tags,
        ],
      ];
    }
    return $elements;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AutoImageStyleResponsive::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides ResponsiveImageFormatter::defaultSettings
AutoImageStyleResponsive::settingsForm	public	function	Returns a form to configure settings for the formatter. Overrides ResponsiveImageFormatter::settingsForm
AutoImageStyleResponsive::settingsSummary	public	function	Returns a short summary for the current formatter settings. Overrides ResponsiveImageFormatter::settingsSummary
AutoImageStyleResponsive::viewElements	public	function	Builds a renderable array for a field value. Overrides ResponsiveImageFormatter::viewElements
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		1
DependencySerializationTrait::__wakeup	public	function		2
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
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::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
ImageFormatterBase::getEntitiesToView	protected	function	Returns the referenced entities for display. Overrides EntityReferenceFormatterBase::getEntitiesToView
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
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.	1
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	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
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::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
ResponsiveImageFormatter::$currentUser	protected	property	The current user.
ResponsiveImageFormatter::$imageStyleStorage	protected	property
ResponsiveImageFormatter::$linkGenerator	protected	property	The link generator.
ResponsiveImageFormatter::$responsiveImageStyleStorage	protected	property
ResponsiveImageFormatter::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides PluginSettingsBase::calculateDependencies
ResponsiveImageFormatter::create	public static	function	Creates an instance of the plugin. Overrides FormatterBase::create
ResponsiveImageFormatter::__construct	public	function	Constructs a ResponsiveImageFormatter object. Overrides FormatterBase::__construct
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
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.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.

You are here

class AutoImageStyleResponsive in Auto image style 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation