You are here

class Contrast in Image Effects 8.2

Same name in this branch
  1. 8.2 src/Plugin/ImageToolkit/Operation/gd/Contrast.php \Drupal\image_effects\Plugin\ImageToolkit\Operation\gd\Contrast
  2. 8.2 src/Plugin/ImageToolkit/Operation/imagemagick/Contrast.php \Drupal\image_effects\Plugin\ImageToolkit\Operation\imagemagick\Contrast
Same name and namespace in other branches
  1. 8.3 src/Plugin/ImageToolkit/Operation/gd/Contrast.php \Drupal\image_effects\Plugin\ImageToolkit\Operation\gd\Contrast
  2. 8 src/Plugin/ImageToolkit/Operation/gd/Contrast.php \Drupal\image_effects\Plugin\ImageToolkit\Operation\gd\Contrast

Defines GD Contrast operation.

Plugin annotation


@ImageToolkitOperation(
  id = "image_effects_gd_contrast",
  toolkit = "gd",
  operation = "contrast",
  label = @Translation("Contrast"),
  description = @Translation("Adjust image contrast.")
)

Hierarchy

Expanded class hierarchy of Contrast

1 string reference to 'Contrast'
ContrastImageEffect::buildConfigurationForm in src/Plugin/ImageEffect/ContrastImageEffect.php
Form constructor.

File

src/Plugin/ImageToolkit/Operation/gd/Contrast.php, line 19

Namespace

Drupal\image_effects\Plugin\ImageToolkit\Operation\gd
View source
class Contrast extends GDImageToolkitOperationBase {
  use ContrastTrait;

  /**
   * {@inheritdoc}
   */
  protected function execute(array $arguments) {
    if ($arguments['level']) {
      return imagefilter($this
        ->getToolkit()
        ->getResource(), IMG_FILTER_CONTRAST, $arguments['level'] * -1);
    }
    return TRUE;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
Contrast::execute protected function Performs the actual manipulation on the image. Overrides ImageToolkitOperationBase::execute
ContrastTrait::arguments protected function
ContrastTrait::validateArguments protected function
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
GDImageToolkitOperationBase::getToolkit protected function The correctly typed image toolkit for GD operations. Overrides ImageToolkitOperationBase::getToolkit
ImageToolkitOperationBase::$logger protected property A logger instance.
ImageToolkitOperationBase::$toolkit protected property The image toolkit.
ImageToolkitOperationBase::apply final public function Applies a toolkit specific operation to an image. Overrides ImageToolkitOperationInterface::apply
ImageToolkitOperationBase::prepareArguments protected function Checks if required arguments are passed in and adds defaults for non passed in optional arguments.
ImageToolkitOperationBase::__construct public function Constructs an image toolkit operation plugin. 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.
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.