Compolomus / Compomage

src/AbstractImage.php

<?php

namespace Compolomus\Compomage;

use Compolomus\Compomage\Interfaces\ImageInterface;
use Exception;
use InvalidArgumentException;
use LogicException;
use RuntimeException;
use SplFileObject;

abstract class AbstractImage implements ImageInterface
{
    protected const POSITIONS = [
        'NORTHWEST' => ['x' => 0, 'y' => 0, 'padX' => 10, 'padY' => 10],
        'NORTH' => ['x' => 1, 'y' => 0, 'padX' => 0, 'padY' => 10],
        'NORTHEAST' => ['x' => 2, 'y' => 0, 'padX' => -10, 'padY' => 10],
        'WEST' => ['x' => 0, 'y' => 1, 'padX' => 10, 'padY' => 0],
        'CENTER' => ['x' => 1, 'y' => 1, 'padX' => 0, 'padY' => 0],
        'EAST' => ['x' => 2, 'y' => 1, 'padX' => -10, 'padY' => 0],
        'SOUTHWEST' => ['x' => 0, 'y' => 2, 'padX' => 10, 'padY' => -10],
        'SOUTH' => ['x' => 1, 'y' => 2, 'padX' => 0, 'padY' => -10],
        'SOUTHEAST' => ['x' => 2, 'y' => 2, 'padX' => -10, 'padY' => -10]
    ];

    protected $image;

    protected $width;

    protected $height;

    protected $orientation;

    /**
     * @param int $value
     * @param int $range
     * @return bool
     */
    protected function compareRangeValue(int $value, int $range): bool
    {
        return in_array(abs($value), range(0, $range), true);
    }

    /**
     * @param int $width
     * @param int $height
     * @param Image $background
     * @return ImageInterface
     */
    protected function setBackground(int $width, int $height, Image $background): ImageInterface
    {
        $this->orientation === 'vertical'
            ? $this->resizeByHeight($height)
            : $this->resizeByWidth($width);

        $background->watermark($this, 'CENTER');

        $this->setImage($background->getImage());
        $this->setSizes();

        return $this;
    }

    protected function setOrientation(): void
    {
        $this->orientation = $this->getWidth() < $this->getHeight() ? 'vertical' : 'horizontal';
    }

    public function getOrientation(): string
    {
        return $this->orientation;
    }

    /**
     * @param string $mode
     * @param int $param
     * @return ImageInterface
     * @throws InvalidArgumentException
     */
    public function resizeBy(string $mode, int $param): ImageInterface
    {
        switch ($mode) {
            case 'width':
                return $this->resizeByWidth($param);
            case 'height':
                return $this->resizeByHeight($param);
            case 'percent':
                return $this->resizeByPercent($param);
            default:
                throw new InvalidArgumentException('Unsupported mode type by resize');
        }
    }

    /**
     * @param int $width
     * @return ImageInterface
     */
    public function resizeByWidth(int $width): ImageInterface
    {
        return $this->resize($width, (int) ($this->getHeight() * ($width / $this->getWidth())));
    }

    /**
     * @return int
     */
    public function getHeight(): int
    {
        return $this->height;
    }

    /**
     * @param int $height
     */
    protected function setHeight(int $height): void
    {
        $this->height = $height;
    }

    /**
     * @return int
     */
    public function getWidth(): int
    {
        return $this->width;
    }

    /**
     * @param int $width
     */
    protected function setWidth(int $width): void
    {
        $this->width = $width;
    }

    /**
     * @param int $height
     * @return ImageInterface
     */
    public function resizeByHeight(int $height): ImageInterface
    {
        return $this->resize((int) ($this->getWidth() * ($height / $this->getHeight())), $height);
    }

    /**
     * @param int $percent
     * @return ImageInterface
     */
    public function resizeByPercent(int $percent): ImageInterface
    {
        return $this->resize(
            (int) ($this->getWidth() * ($percent / 100)),
            (int) ($this->getHeight() * ($percent / 100))
        );
    }

    abstract protected function newImage(int $width, int $height);

    /**
     * @param ImageInterface|Image $watermark
     * @param string $position
     * @return ImageInterface
     * @throws InvalidArgumentException
     */
    public function watermark($watermark, string $position): ImageInterface
    {
        if (!array_key_exists(strtoupper($position), self::POSITIONS)) {
            throw new InvalidArgumentException('Wrong position');
        }

        return $this->prepareWatermark(
            $watermark,
            (int) ((($this->getWidth() - $watermark->getWidth()) / 2) * self::POSITIONS[strtoupper($position)]['x']) + self::POSITIONS[strtoupper($position)]['padX'],

The method getWidth() does not exist on Compolomus\Compomage\Interfaces\ImageInterface. Since it exists in all sub-types, consider adding an abstract or default implementation to Compolomus\Compomage\Interfaces\ImageInterface.

            (int) ((($this->getHeight() - $watermark->getHeight()) / 2) * self::POSITIONS[strtoupper($position)]['y']) + self::POSITIONS[strtoupper($position)]['padY']

The method getHeight() does not exist on Compolomus\Compomage\Interfaces\ImageInterface. Since it exists in all sub-types, consider adding an abstract or default implementation to Compolomus\Compomage\Interfaces\ImageInterface.

        );
    }

    /**
     * @param ImageInterface|Image $watermark
     * @param int $x
     * @param int $y
     * @return ImageInterface
     */
    abstract protected function prepareWatermark($watermark, int $x, int $y): ImageInterface;

    /**
     * @param int $width
     * @param int $height
     * @return ImageInterface
     */
    public function thumbnail(int $width, int $height): ImageInterface
    {
        $newHeight = $height;
        $newWidth = $width;

        ($this->getWidth() / $this->getHeight()) >= ($width / $height)
            ? $newWidth = (int) ($this->getWidth() / ($this->getHeight() / $height))
            : $newHeight = (int) ($this->getHeight() / ($this->getWidth() / $width));

        return $this->prepareThumbnail($width, $height, $newWidth, $newHeight);

The call to Compolomus\Compomage\AbstractImage::prepareThumbnail() has too many arguments starting with $newWidth.

    }

    /**
     * @param int $width
     * @param int $height
     * @return ImageInterface
     */
    abstract protected function prepareThumbnail(int $width, int $height): ImageInterface;

    /**
     * @return string chunked base64
     */
    public function getBase64(): string
    {
        return base64_encode((string) $this);

    }

    /**
     * @param $image
     */
    protected function setImage($image): void
    {
        $this->image = $image;
    }

    public function getImage()
    {
        return $this->image;
    }

    /**
     * System method
     *
     * @param void
     */
    abstract protected function setSizes(): void;

    /**
     * @param string $image
     * @throws Exception
     */
    protected function init(string $image): void
    {
        switch ($image) {
            // base64
            case base64_encode(base64_decode($image, true)) === $image:
                $this->getImageByBase64($image);
                break;
            // URL
            case (0 === strpos($image, 'http')):
                $this->getImageByURL($image);
                break;
            // Local file
            default:
                $this->tmp(file_get_contents($image));
        }
    }

    /**
     * @param string $base64
     * @return void
     * @throws Exception
     */
    protected function getImageByBase64(string $base64): void
    {
        $this->tmp(base64_decode($base64));
    }

    /**
     * @param string $source
     * @return ImageInterface
     */
    abstract protected function tmp(string $source): ImageInterface;

    /**
     * @param string $url
     * @return InvalidArgumentException|null
     * @throws Exception
     * @throws InvalidArgumentException
     * @throws LogicException
     * @throws RuntimeException
     */
    protected function getImageByURL(string $url): ?InvalidArgumentException
    {
        if (@!getimagesize($url)) {
            throw new InvalidArgumentException('Unsupported image type');
        }
        $upload = new SplFileObject($url, 'rb');
        $image = '';
        while (!$upload->eof()) {
            $image .= $upload->fgets();
        }
        $this->tmp($image);

        return null;
    }
}