class ImageFilter in Image effect kit 8

Defines IEK - Filter operation.

Plugin annotation

@ImageToolkitOperation(
  id = "gd_iek_image_filter",
  toolkit = "gd",
  operation = "iek_image_filter",
  label = @Translation("IEK - Filter"),
  description = @Translation("Apply a filter to an image.")
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\Core\ImageToolkit\ImageToolkitOperationBase implements ImageToolkitOperationInterface
      • class \Drupal\system\Plugin\ImageToolkit\Operation\gd\GDImageToolkitOperationBase
        • class \Drupal\iek\Plugin\ImageToolkit\Operation\gd\ImageFilter

File

src/Plugin/ImageToolkit/Operation/gd/ImageFilter.php, line 23

Contains \Drupal\iek\Plugin\ImageToolkit\Operation\gd\ImageFilter.

Namespace

Drupal\iek\Plugin\ImageToolkit\Operation\gd

class ImageFilter extends GDImageToolkitOperationBase {

  /**
   * {@inheritdoc}
   */
  protected function arguments() {
    return [
      'filter_name' => [
        'description' => 'Filter name',
      ],
      'repeat' => [
        'description' => 'Repeat',
      ],
      'arg1' => [
        'description' => 'arg1',
      ],
      'arg2' => [
        'description' => 'arg2',
      ],
      'arg3' => [
        'description' => 'arg3',
      ],
      'arg4' => [
        'description' => 'arg4',
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  protected function validateArguments(array $arguments) {

    // Fail when filter name is empty.
    if (empty($arguments['filter_name'])) {
      throw new \InvalidArgumentException("Invalid filter name ('{$arguments['filter_name']}') specified for the image 'iek_image_filter' operation");
    }
    return $arguments;
  }

  /**
   * {@inheritdoc}
   */
  protected function execute(array $arguments = []) {
    $data = $arguments;
    $filter_name = $data['filter_name'];
    $repeat = isset($data['repeat']) ? $data['repeat'] : 1;
    $arg1 = $data['arg1'];
    $arg2 = $data['arg2'];
    $arg3 = $data['arg3'];
    $arg4 = $data['arg4'];
    switch ($filter_name) {
      case IMG_FILTER_BRIGHTNESS:
      case IMG_FILTER_CONTRAST:
      case IMG_FILTER_SMOOTH:
        for ($i = 0; $i < $repeat; $i++) {
          imagefilter($this
            ->getToolkit()
            ->getResource(), $filter_name, $arg1);
        }
        break;
      case IMG_FILTER_PIXELATE:
        for ($i = 0; $i < $repeat; $i++) {
          imagefilter($this
            ->getToolkit()
            ->getResource(), $filter_name, $arg1, $arg2);
        }
        break;
      case IMG_FILTER_COLORIZE:
        for ($i = 0; $i < $repeat; $i++) {
          imagefilter($this
            ->getToolkit()
            ->getResource(), $filter_name, $arg1, $arg2, $arg3, $arg4);
        }
        break;
      default:
        for ($i = 0; $i < $repeat; $i++) {
          imagefilter($this
            ->getToolkit()
            ->getResource(), $filter_name);
        }
        break;
    }
    return TRUE;
  }

}

Members

Name	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
GDImageToolkitOperationBase::getToolkit	protected	function	The correctly typed image toolkit for GD operations. Overrides ImageToolkitOperationBase::getToolkit
ImageFilter::arguments	protected	function	Returns the definition of the operation arguments. Overrides ImageToolkitOperationBase::arguments
ImageFilter::execute	protected	function	Performs the actual manipulation on the image. Overrides ImageToolkitOperationBase::execute
ImageFilter::validateArguments	protected	function	Validates the arguments. Overrides ImageToolkitOperationBase::validateArguments
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.