You are here

Home » API reference » Imagecache External 8 » ImagecacheExternalResponsiveImage.php

class ImagecacheExternalResponsiveImage in Imagecache External 8

Plugin implementation of the 'imagecache_external_image' formatter.

Plugin annotation


@FieldFormatter(
  id = "imagecache_external_responsive_image",
  module = "imagecache_external",
  label = @Translation("Imagecache External Responsive Image"),
  field_types = {
    "link",
    "text",
    "string",
  },
  quickedit = {
    "editor" = "disabled"
  }
)

Hierarchy

Expanded class hierarchy of ImagecacheExternalResponsiveImage

File

src/Plugin/Field/FieldFormatter/ImagecacheExternalResponsiveImage.php, line 35

Namespace

Drupal\imagecache_external\Plugin\Field\FieldFormatter
View source 
class ImagecacheExternalResponsiveImage extends FormatterBase implements ContainerFactoryPluginInterface {

  /**
   * The responsive image style storage.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $responsiveImageStyleStorage;

  /**
   * The image factory service.
   *
   * @var \Drupal\Core\Image\ImageFactory
   */
  protected $imageFactory;

  /**
   * The current user.
   *
   * @var \Drupal\Core\Session\AccountInterface
   */
  protected $currentUser;

  /**
   * The link generator.
   *
   * @var \Drupal\Core\Utility\LinkGeneratorInterface
   */
  protected $linkGenerator;

  /**
   * Constructs a ImagecacheExternalResponsiveImage object.
   *
   * @param string $plugin_id
   *   The plugin_id for the formatter.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
   *   The definition of the field to which the formatter is associated.
   * @param array $settings
   *   The formatter settings.
   * @param string $label
   *   The formatter label display setting.
   * @param string $view_mode
   *   The view mode.
   * @param array $third_party_settings
   *   Any third party settings.
   * @param \Drupal\Core\Image\ImageFactory
   *   The image factory service.
   * @param \Drupal\Core\Entity\EntityStorageInterface $responsive_image_style_storage
   *   The responsive image style storage.
   * @param \Drupal\Core\Utility\LinkGeneratorInterface $link_generator
   *   The link generator service.
   * @param \Drupal\Core\Session\AccountInterface $current_user
   *   The current user.
   */
  public function __construct($plugin_id, $plugin_definition, $field_definition, array $settings, $label, $view_mode, array $third_party_settings, ImageFactory $image_factory, EntityStorageInterface $responsive_image_style_storage, LinkGeneratorInterface $link_generator, AccountInterface $current_user) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
    $this->imageFactory = $image_factory;
    $this->responsiveImageStyleStorage = $responsive_image_style_storage;
    $this->linkGenerator = $link_generator;
    $this->currentUser = $current_user;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($plugin_id, $plugin_definition, $configuration['field_definition'], $configuration['settings'], $configuration['label'], $configuration['view_mode'], $configuration['third_party_settings'], $container
      ->get('image.factory'), $container
      ->get('entity_type.manager')
      ->getStorage('responsive_image_style'), $container
      ->get('link_generator'), $container
      ->get('current_user'));
  }

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

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $settings = $this
      ->getSettings();
    $elements = [];
    $responsive_image_options = [];
    $responsive_image_styles = $this->responsiveImageStyleStorage
      ->loadMultiple();
    if ($responsive_image_styles && !empty($responsive_image_styles)) {

      /** @var \Drupal\responsive_image\Entity\ResponsiveImageStyle $responsive_image_style */
      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['imagecache_external_responsive_style'] = [
      '#title' => t('Responsive image style'),
      '#type' => 'select',
      '#default_value' => $settings['imagecache_external_responsive_style'],
      '#required' => TRUE,
      '#options' => $responsive_image_options,
      '#description' => [
        '#markup' => $this->linkGenerator
          ->generate($this
          ->t('Configure Responsive Image Styles'), new Url('entity.responsive_image_style.collection')),
        '#access' => $this->currentUser
          ->hasPermission('administer responsive image styles'),
      ],
    ];
    $link_types = [
      'content' => t('Content'),
      'file' => t('File'),
    ];
    $elements['imagecache_external_link'] = [
      '#title' => t('Link image to'),
      '#type' => 'select',
      '#default_value' => $settings['imagecache_external_link'],
      '#empty_option' => t('Nothing'),
      '#options' => $link_types,
    ];
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];
    $responsive_image_style = $this->responsiveImageStyleStorage
      ->load($this
      ->getSetting('imagecache_external_responsive_style'));
    if ($responsive_image_style) {
      $summary[] = t('Responsive image style: @responsive_image_style', [
        '@responsive_image_style' => $responsive_image_style
          ->label(),
      ]);
      $link_types = [
        'content' => t('Linked to content'),
        'file' => t('Linked to file'),
      ];

      // Display this setting only if image is linked.
      if (isset($link_types[$this
        ->getSetting('imagecache_external_link')])) {
        $summary[] = $link_types[$this
          ->getSetting('imagecache_external_link')];
      }
    }
    else {
      $summary[] = t('Select a responsive image style.');
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];
    $field = $items
      ->getFieldDefinition();
    $field_settings = $this
      ->getFieldSettings();
    $url = NULL;
    $image_link_setting = $this
      ->getSetting('imagecache_external_responsive_style');

    // Check if the formatter involves a link.
    if ($image_link_setting == 'content') {
      $entity = $items
        ->getEntity();
      if (!$entity
        ->isNew()) {
        $url = $entity
          ->toUrl();
      }
    }
    elseif ($image_link_setting == 'file') {
      $link_file = TRUE;
    }

    // Check if the field provides a title.
    if ($field
      ->getType() == 'link') {
      if ($field_settings['title'] != DRUPAL_DISABLED) {
        $field_title = TRUE;
      }
    }
    foreach ($items as $delta => $item) {

      // Get field value.
      $values = $item
        ->toArray();
      $image_alt = '';
      if ($field
        ->getType() == 'link') {
        $image_path = imagecache_external_generate_path($values['uri']);

        // If present, use the Link field title to provide the alt text.
        if (isset($field_title)) {

          // The link field appends the url as title when the title is empty.
          // We don't want the url in the alt tag, so let's check this.
          if ($values['title'] != $values['uri']) {
            $image_alt = isset($field_title) ? $values['title'] : '';
          }
        }
      }
      else {
        $image_path = imagecache_external_generate_path($values['value']);
      }

      // Skip rendering this item if there is no image_path.
      if (!$image_path) {
        continue;
      }
      if (isset($link_file)) {
        $url = Url::fromUri(file_create_url($image_path));
      }
      $image = $this->imageFactory
        ->get($image_path);
      $style_settings = $this
        ->getSetting('imagecache_external_responsive_style');
      $image_build_base = [
        '#width' => $image
          ->getWidth(),
        '#height' => $image
          ->getHeight(),
        '#uri' => $image_path,
        '#alt' => $image_alt,
        '#title' => '',
      ];
      if (empty($style_settings)) {
        $image_build = [
          '#theme' => 'image',
        ] + $image_build_base;
      }
      else {
        $image_build = [
          '#theme' => 'imagecache_external_responsive',
          '#responsive_image_style_id' => $style_settings,
        ] + $image_build_base;
      }
      if ($url) {
        $rendered_image = render($image_build);
        $elements[$delta] = Link::fromTextAndUrl($rendered_image, $url)
          ->toRenderable();
      }
      else {
        $elements[$delta] = $image_build;
      }
    }
    return $elements;
  }

}

Members

Namesort descending Modifiers Type Description 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 1
DependencySerializationTrait::__wakeup public function 2
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
FormatterBase::prepareView public function Allows formatters to load information for field values being displayed. Overrides FormatterInterface::prepareView 2
FormatterBase::view public function Builds a renderable array for a fully themed field. Overrides FormatterInterface::view 1
ImagecacheExternalResponsiveImage::$currentUser protected property The current user.
ImagecacheExternalResponsiveImage::$imageFactory protected property The image factory service.
ImagecacheExternalResponsiveImage::$linkGenerator protected property The link generator.
ImagecacheExternalResponsiveImage::$responsiveImageStyleStorage protected property The responsive image style storage.
ImagecacheExternalResponsiveImage::create public static function Creates an instance of the plugin. Overrides FormatterBase::create
ImagecacheExternalResponsiveImage::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
ImagecacheExternalResponsiveImage::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
ImagecacheExternalResponsiveImage::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
ImagecacheExternalResponsiveImage::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
ImagecacheExternalResponsiveImage::__construct public function Constructs a ImagecacheExternalResponsiveImage object. Overrides FormatterBase::__construct
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::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 6
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
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.