silvershop / silvershop-core

src/Extension/ProductImageExtension.php

<?php

namespace SilverShop\Extension;

use SilverStripe\Assets\Image;
use SilverStripe\Core\Config\Configurable;
use SilverStripe\ORM\DataExtension;

/**
 * Adds some image size functions to the Image DataObject.
 *
 * @package shop
 */
class ProductImageExtension extends DataExtension
{
    use Configurable;

    /**
     * @var Image
     */
    protected $owner;

    /**
     * @param bool $upscale [optional]
     * @return Image
     */
    public function getThumbnail($upscale = false)
    {
        $width = self::config()->thumbnail_width;
        $height = self::config()->thumbnail_height;

        return $this->getImageAt($width, $height, $upscale);
    }

    /**
     * @param bool $upscale [optional]
     * @return Image
     */
    public function getContentImage($upscale = false)
    {
        $width = self::config()->content_image_width;
        $height = self::config()->content_image_height;

        return $this->getImageAt($width, $height, $upscale);
    }

    /**
     * @param bool $upscale [optional]
     * @return Image
     */
    public function getLargeImage($upscale = false)
    {
        $width = self::config()->large_image_width;
        $height = self::config()->large_image_height;

        return $this->getImageAt($width, $height, $upscale);
    }

    /**
     * Resizes image by width or height only if the source image is bigger than the given width/height.
     * This prevents ugly upscaling.
     *
     * @param int  $width   [optional]
     * @param int  $height  [optional]
     * @param bool $upscale [optional]
     *
     * @return Image
     */
    public function getImageAt($width = null, $height = null, $upscale = false)
    {
        if (!$this->owner->exists()) {
            return $this->owner;
        }

        $realWidth = $this->owner->getWidth();
        $realHeight = $this->owner->getHeight();

        if ($width && $height) {

The expression $width of type integer|null is loosely compared to true; this is ambiguous if the integer can be 0. You might want to explicitly use !== null instead.

The expression $height of type integer|null is loosely compared to true; this is ambiguous if the integer can be 0. You might want to explicitly use !== null instead.

            return $realWidth < $width && $realHeight < $height && !$upscale

The expression return $realWidth < $width && $realHeight < $height && ! $upscale ? $this->owner : $this->owner->Fit($width, $height) also could return the type SilverStripe\Assets\Storage\DBFile which is incompatible with the documented return type SilverStripe\Assets\Image.

                ? $this->owner
                : $this->owner->Fit($width, $height);
        } else {
            if ($width) {

The expression $width of type integer|null is loosely compared to true; this is ambiguous if the integer can be 0. You might want to explicitly use !== null instead.

                return $realWidth < $width && !$upscale

The expression return $realWidth < $width && ! $upscale ? $this->owner : $this->owner->ScaleWidth($width) also could return the type SilverStripe\Assets\Storage\DBFile which is incompatible with the documented return type SilverStripe\Assets\Image.

                    ? $this->owner
                    : $this->owner->ScaleWidth($width);
            } else {
                return $realHeight < $height && !$upscale

The expression return $realHeight < $height && ! $upscale ? $this->owner : $this->owner->ScaleHeight($height) also could return the type SilverStripe\Assets\Storage\DBFile which is incompatible with the documented return type SilverStripe\Assets\Image.

                    ? $this->owner
                    : $this->owner->ScaleHeight($height);
            }
        }
    }

    /**
     * @return bool - is the image large enough that a "large" image makes sense?
     */
    public function HasLargeImage()
    {
        $imageWidth = intval($this->owner->getWidth());
        return $imageWidth > self::config()->content_image_width;
    }
}