You are here

Home » API reference » ImageCache Reflect 8 » ReflectImageEffect.php

class ReflectImageEffect in ImageCache Reflect 8

Creates a reflection-like effect on an image resource.

Plugin annotation


@ImageEffect(
  id = "imagecache reflect",
  label = @Translation("Reflect"),
  description = @Translation("Creates a reflection-like image effect.")
)

Hierarchy

Expanded class hierarchy of ReflectImageEffect

File

lib/Drupal/imagecache_reflect/Plugin/ImageEffect/ReflectImageEffect.php, line 26
Contains \Drupal\imagecache_reflect\Plugin\ImageEffect\ReflectImageEffect.

Namespace

Drupal\imagecache_reflect\Plugin\ImageEffect
View source 
class ReflectImageEffect extends ImageEffectBase implements ConfigurableImageEffectInterface {

  /**
   * {@inheritdoc}
   */
  public function applyEffect(ImageInterface $image) {

    // Apply operation.
    // @todo: Convert this operation to a toolkit plugin.
    // @todo: Add support for imagemagick.
    if (!GDToolkitReflect::reflect($image, $this->configuration)) {
      watchdog('image', 'Image reflect failed using the %toolkit toolkit on %path (%mimetype, %configuration)', array(
        '%toolkit' => $image
          ->getToolkitId(),
        '%path' => $image
          ->getSource(),
        '%mimetype' => $image
          ->getMimeType(),
        '%configuration' => 'Size: ' . $this->configuration['size'] . ', Position: ' . $this->configuration['position'],
      ), WATCHDOG_ERROR);
      return FALSE;
    }
    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public function getSummary() {
    return array(
      '#theme' => 'imagecache_reflect_summary',
      '#data' => $this->configuration,
    );
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return array(
      'bgcolor' => '#FFFFFF',
      'position' => 'bottom',
      'transparency' => FALSE,
      'size' => '50%',
    );
  }

  /**
   * {@inheritdoc}
   */
  public function getForm() {
    $form['bgcolor'] = array(
      '#type' => 'textfield',
      '#title' => t('Color'),
      '#description' => t('The color to use for the reflection background. Use web-style hex colors. e.g.) #FF6633. May be blank.'),
      '#default_value' => $this->configuration['bgcolor'],
      '#size' => 7,
      '#max_length' => 7,
      '#element_validate' => array(
        array(
          $this,
          'validateColor',
        ),
      ),
    );
    $form['transparency'] = array(
      '#type' => 'checkbox',
      '#title' => t('transparency source image'),
      '#default_value' => $this->configuration['transparency'],
      '#description' => t('If the image that you are reflecting uses alpha transparency, optionally use a much slower algorithm for creating the images, but one that will preserve the transparency.'),
    );
    $form['position'] = array(
      '#type' => 'radios',
      '#title' => t('Position'),
      '#default_value' => $this->configuration['position'],
      '#options' => array(
        'top' => t('Top'),
        'right' => t('Right'),
        'bottom' => t('Bottom'),
        'left' => t('Left'),
      ),
      '#description' => t('The position of the image reflection. Default is bottom.'),
      '#required' => TRUE,
    );
    $form['size'] = array(
      '#type' => 'textfield',
      '#title' => t('Size'),
      '#default_value' => $this->configuration['size'],
      '#description' => t('The size of the reflection in pixels. You may append % to the integer to represent percentages.'),
      '#required' => TRUE,
      '#element_validate' => array(
        array(
          $this,
          'validateSize',
        ),
      ),
    );
    return $form;
  }

  /**
   * Validates to ensure a hexadecimal color value or empty.
   *
   * @todo Use drupal 8 validation API? Symfony has regex validator.
   */
  public static function validateColor(array $element, array &$form_state) {
    if (!preg_match('/^#[0-9A-F]{3}([0-9A-F]{3})?$|^$/', $element['#value'])) {
      \Drupal::formBuilder()
        ->setError($element, \t('!name must be a hexadecimal color value or empty.', array(
        '!name' => $element['#title'],
      )));
    }
  }

  /**
   * Validates to ensure a percentage or positive integer.
   *
   * @todo Use drupal 8 validation API? Symfony has regex validator.
   */
  public static function validateSize(array $element, array &$form_state) {
    if (!preg_match('/^([0-9]{1,2}|100)%$|^([0-9]{1,3})$/', $element['#value'])) {
      \Drupal::formBuilder()
        ->setError($element, \t('!name must be a percentage from 1 to 100 or a positive integer 3 digits or less.', array(
        '!name' => $element['#title'],
      )));
    }
  }

}

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
ImageEffectBase::$logger protected property A logger instance.
ImageEffectBase::$uuid protected property The image effect ID.
ImageEffectBase::$weight protected property The weight of the image effect.
ImageEffectBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
ImageEffectBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
ImageEffectBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ImageEffectBase::getDerivativeExtension public function Returns the extension of the derivative after applying this image effect. Overrides ImageEffectInterface::getDerivativeExtension 1
ImageEffectBase::getUuid public function Returns the unique ID representing the image effect. Overrides ImageEffectInterface::getUuid
ImageEffectBase::getWeight public function Returns the weight of the image effect. Overrides ImageEffectInterface::getWeight
ImageEffectBase::label public function Returns the image effect label. Overrides ImageEffectInterface::label
ImageEffectBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
ImageEffectBase::setWeight public function Sets the weight for this image effect. Overrides ImageEffectInterface::setWeight
ImageEffectBase::transformDimensions public function Determines the dimensions of the styled image. Overrides ImageEffectInterface::transformDimensions 4
ImageEffectBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__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.
PluginFormInterface::buildConfigurationForm public function Form constructor. 36
PluginFormInterface::submitConfigurationForm public function Form submission handler. 32
PluginFormInterface::validateConfigurationForm public function Form validation handler. 18
ReflectImageEffect::applyEffect public function Applies an image effect to the image object. Overrides ImageEffectInterface::applyEffect
ReflectImageEffect::defaultConfiguration public function Gets default configuration for this plugin. Overrides ImageEffectBase::defaultConfiguration
ReflectImageEffect::getForm public function
ReflectImageEffect::getSummary public function Returns a render array summarizing the configuration of the image effect. Overrides ImageEffectBase::getSummary
ReflectImageEffect::validateColor public static function Validates to ensure a hexadecimal color value or empty.
ReflectImageEffect::validateSize public static function Validates to ensure a percentage or positive integer.
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.