ImagecacheProportionsFormatter.php in Imagecache Proportions 8

Contains \Drupal\imagecache_proportions\Plugin\Field\FieldFormatter.

Namespace

Drupal\imagecache_proportions\Plugin\Field\FieldFormatter

File

src/Plugin/Field/FieldFormatter/ImagecacheProportionsFormatter.php

<?php

/**
 * @file
 * Contains \Drupal\imagecache_proportions\Plugin\Field\FieldFormatter.
 */
namespace Drupal\imagecache_proportions\Plugin\Field\FieldFormatter;

use Drupal\Core\Field\FieldItemListInterface;
use Drupal\image\Plugin\Field\FieldFormatter\ImageFormatter;

/**
 * Plugin implementation of the 'imagecache_proportions' formatter.
 *
 * @FieldFormatter(
 *   id = "imagecache_proportions",
 *   label = @Translation("Imagecache proportions"),
 *   field_types = {
 *     "image"
 *   }
 * )
 */
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';
    }
  }

}

Classes

Name	Description
ImagecacheProportionsFormatter	Plugin implementation of the 'imagecache_proportions' formatter.