You are here

Home » API reference » Imagecache Proportions 8 » ImagecacheProportionsFormatter.php

class ImagecacheProportionsFormatter in Imagecache Proportions 8

Plugin implementation of the 'imagecache_proportions' formatter.

Plugin annotation


@FieldFormatter(
  id = "imagecache_proportions",
  label = @Translation("Imagecache proportions"),
  field_types = {
    "image"
  }
)

Hierarchy

Expanded class hierarchy of ImagecacheProportionsFormatter

File

src/Plugin/Field/FieldFormatter/ImagecacheProportionsFormatter.php, line 24
Contains \Drupal\imagecache_proportions\Plugin\Field\FieldFormatter.

Namespace

Drupal\imagecache_proportions\Plugin\Field\FieldFormatter
View source 
class ImagecacheProportionsFormatter extends ImageFormatter {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return array(
      'image_style_portrait' => '',
      'image_style_landscape' => '',
      'looseness' => 0,
    ) + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, array &$form_state) {
    $element = parent::settingsForm($form, $form_state);
    $element['image_style']['#title'] = $this
      ->t('Select the squared style');
    $element['image_style']['#weight'] = -2;
    $image_styles = image_style_options(FALSE);
    $element['image_style_portrait'] = array(
      '#title' => $this
        ->t('Select the vertical style'),
      '#type' => 'select',
      '#default_value' => $this
        ->getSetting('image_style_portrait'),
      '#empty_option' => t('None (original image)'),
      '#options' => $image_styles,
      '#weight' => -4,
    );
    $element['image_style_landscape'] = array(
      '#title' => $this
        ->t('Select the horizontal style'),
      '#type' => 'select',
      '#default_value' => $this
        ->getSetting('image_style_landscape'),
      '#empty_option' => t('None (original image)'),
      '#options' => $image_styles,
      '#weight' => -3,
    );
    $element['looseness'] = array(
      '#type' => 'number',
      '#size' => 10,
      '#title' => $this
        ->t('Select the looseness to consider an image squared'),
      '#description' => $this
        ->t('Number of pixels that a image can be wider than higher (or viceversa) to be considered squared.'),
      '#default_value' => $this
        ->getSetting('looseness'),
      '#weight' => -1,
    );
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = array();
    $image_styles = image_style_options(FALSE);

    // Unset possible 'No defined styles' option.
    unset($image_styles['']);

    // Styles could be lost because of enabled/disabled modules that defines
    // their styles in code.
    $image_style_portrait_setting = $this
      ->getSetting('image_style_portrait');
    if (isset($image_styles[$image_style_portrait_setting])) {
      $summary[] = $this
        ->t('Portrait image style: @style', array(
        '@style' => $image_styles[$image_style_portrait_setting],
      ));
    }
    else {
      $summary[] = $this
        ->t('Original portrait image');
    }
    $image_style_landscape_setting = $this
      ->getSetting('image_style_landscape');
    if (isset($image_styles[$image_style_landscape_setting])) {
      $summary[] = $this
        ->t('Landscape image style: @style', array(
        '@style' => $image_styles[$image_style_landscape_setting],
      ));
    }
    else {
      $summary[] = $this
        ->t('Landscape horizontal image');
    }
    $image_style_setting = $this
      ->getSetting('image_style');
    if (isset($image_styles[$image_style_setting])) {
      $summary[] = $this
        ->t('Squared image style: @style', array(
        '@style' => $image_styles[$image_style_setting],
      ));
    }
    else {
      $summary[] = $this
        ->t('Original squared image');
    }
    $summary[] = $this
      ->t('Looseness: @number px.', array(
      '@number' => $this
        ->getSetting('looseness'),
    ));
    $parent_summary = parent::settingsSummary();
    $summary[] = $parent_summary[1];
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items) {
    $elements = array();
    $image_link_setting = $this
      ->getSetting('image_link');

    // Check if the formatter involves a link.
    if ($image_link_setting == 'content') {
      $entity = $items
        ->getEntity();
      if (!$entity
        ->isNew()) {

        // @todo Remove when theme_image_formatter() has support for route name.
        $uri['path'] = $entity
          ->getSystemPath();
        $uri['options'] = $entity
          ->urlInfo()
          ->getOptions();
      }
    }
    elseif ($image_link_setting == 'file') {
      $link_file = TRUE;
    }
    foreach ($items as $delta => $item) {
      $image_style = $this
        ->calculateImageStyle($item->entity
        ->getFileUri());
      if ($item->entity) {
        if (isset($link_file)) {
          $image_uri = $item->entity
            ->getFileUri();
          $uri = array(
            'path' => file_create_url($image_uri),
            'options' => array(),
          );
        }

        // 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_attributes = $item->_attributes;
        unset($item->_attributes);
        $elements[$delta] = array(
          '#theme' => 'image_formatter',
          '#item' => $item,
          '#item_attributes' => $item_attributes,
          '#image_style' => $this
            ->getSetting($image_style),
          '#path' => isset($uri) ? $uri : '',
        );
      }
    }
    return $elements;
  }

  /**
   * Decides which image style should be displayed depending on the image size.
   *
   * @param string $image_uri
   *   The URI to the image is going to be displayed.
   *
   * @return string
   *   The name of the image style to display.
   */
  protected function calculateImageStyle($image_uri) {
    $size = getimagesize($image_uri);
    if (abs($size[0] - $size[1]) <= $this
      ->getSetting('looseness')) {
      return 'image_style';
    }
    elseif ($size[0] > $size[1]) {
      return 'image_style_landscape';
    }
    else {
      return 'image_style_portrait';
    }
  }

}

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
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
ImagecacheProportionsFormatter::calculateImageStyle protected function Decides which image style should be displayed depending on the image size.
ImagecacheProportionsFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides ImageFormatter::defaultSettings
ImagecacheProportionsFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides ImageFormatter::settingsForm
ImagecacheProportionsFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides ImageFormatter::settingsSummary
ImagecacheProportionsFormatter::viewElements public function Builds a renderable array for a field value. Overrides ImageFormatter::viewElements
ImageFormatter::$currentUser protected property The current user.
ImageFormatter::$imageStyleStorage protected property The image style entity storage.
ImageFormatter::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides PluginSettingsBase::calculateDependencies
ImageFormatter::create public static function Creates an instance of the plugin. Overrides FormatterBase::create 1
ImageFormatter::onDependencyRemoval public function Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsBase::onDependencyRemoval
ImageFormatter::__construct public function Constructs an ImageFormatter object. Overrides FormatterBase::__construct 1
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::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.