vendor/contao/image/src/ResizeConfiguration.php line 105

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. /*
  6.  * This file is part of Contao.
  7.  *
  8.  * (c) Leo Feyer
  9.  *
  10.  * @license LGPL-3.0-or-later
  11.  */
  13. namespace Contao\Image;
  15. use Contao\Image\Exception\InvalidArgumentException;
  17. class ResizeConfiguration
  18. {
  19.     public const MODE_CROP = 'crop';
  20.     public const MODE_BOX = 'box';
  22.     /**
  23.      * @deprecated Deprecated since version 1.2, to be removed in version 2.0.
  24.      */
  25.     public const MODE_PROPORTIONAL = 'proportional';
  27.     /**
  28.      * @var int
  29.      */
  30.     private $width = 0;
  32.     /**
  33.      * @var int
  34.      */
  35.     private $height = 0;
  37.     /**
  38.      * @var string
  39.      */
  40.     private $mode = self::MODE_CROP;
  42.     /**
  43.      * @var int
  44.      */
  45.     private $zoomLevel = 0;
  47.     /**
  48.      * Returns true if the resize would have no effect.
  49.      */
  50.     public function isEmpty(): bool
  51.     {
  52.         return 0 === $this->width && 0 === $this->height && 0 === $this->zoomLevel;
  53.     }
  55.     public function getWidth(): int
  56.     {
  57.         return $this->width;
  58.     }
  60.     public function setWidth(int $width): self
  61.     {
  62.         if ($width < 0) {
  63.             throw new InvalidArgumentException('Width must not be negative');
  64.         }
  66.         $this->width = $width;
  68.         return $this;
  69.     }
  71.     public function getHeight(): int
  72.     {
  73.         return $this->height;
  74.     }
  76.     public function setHeight(int $height): self
  77.     {
  78.         if ($height < 0) {
  79.             throw new InvalidArgumentException('Height must not be negative');
  80.         }
  82.         $this->height = $height;
  84.         return $this;
  85.     }
  87.     /**
  88.      * @return string One of the ResizeConfiguration::MODE_* constants
  89.      */
  90.     public function getMode(): string
  91.     {
  92.         return $this->mode;
  93.     }
  95.     /**
  96.      * @param string $mode One of the ResizeConfiguration::MODE_* constants
  97.      */
  98.     public function setMode(string $mode): self
  99.     {
  100.         if (!\in_array($mode, [self::MODE_CROP, self::MODE_BOX, self::MODE_PROPORTIONAL], true)) {
  101.             throw new InvalidArgumentException('Mode must be one of the '.self::class.'::MODE_* constants');
  102.         }
  104.         if (self::MODE_PROPORTIONAL === $mode) {
  105.             trigger_deprecation('contao/image', '1.2', 'Using ResizeConfiguration::MODE_PROPORTIONAL has been deprecated and will no longer work in version 2.0. Use ResizeConfiguration::MODE_BOX instead.');
  106.         }
  108.         $this->mode = $mode;
  110.         return $this;
  111.     }
  113.     public function getZoomLevel(): int
  114.     {
  115.         return $this->zoomLevel;
  116.     }
  118.     public function setZoomLevel(int $zoomLevel): self
  119.     {
  120.         if ($zoomLevel < 0 || $zoomLevel > 100) {
  121.             throw new InvalidArgumentException('Zoom level must be between 0 and 100');
  122.         }
  124.         $this->zoomLevel = $zoomLevel;
  126.         return $this;
  127.     }
  128. }