[Summary view] [Print] [Text view]

   1  <?php
   2  
   3  /**
   4   * Joomla! Content Management System
   5   *
   6   * @copyright   (C) 2005 Open Source Matters, Inc. <https://www.joomla.org>
   7   * @license     GNU General Public License version 2 or later; see LICENSE
   8   */
   9  
  10  namespace Joomla\CMS\Image\Filter;
  11  
  12  use Joomla\CMS\Image\ImageFilter;
  13  
  14  // phpcs:disable PSR1.Files.SideEffects
  15  \defined('JPATH_PLATFORM') or die;
  16  // phpcs:enable PSR1.Files.SideEffects
  17  
  18  /**
  19   * Image Filter class adjust the contrast of an image.
  20   *
  21   * @since  2.5.0
  22   */
  23  class Contrast extends ImageFilter
  24  {
  25      /**
  26       * Method to apply a filter to an image resource.
  27       *
  28       * @param   array  $options  An array of options for the filter.
  29       *
  30       * @return  void
  31       *
  32       * @since   2.5.0
  33       * @throws  \InvalidArgumentException
  34       */
  35      public function execute(array $options = [])
  36      {
  37          // Validate that the contrast value exists and is an integer.
  38          if (!isset($options[IMG_FILTER_CONTRAST]) || !\is_int($options[IMG_FILTER_CONTRAST])) {
  39              throw new \InvalidArgumentException('No valid contrast value was given.  Expected integer.');
  40          }
  41  
  42          // Perform the contrast filter.
  43          imagefilter($this->handle, IMG_FILTER_CONTRAST, $options[IMG_FILTER_CONTRAST]);
  44      }
  45  }