PerfectCmsImageDataExtension::getImageLinkCachedIfExists() - Code Metrics - Inspection of "MAJOR: better image caching" - sunnysideup/silverstripe-perfect_cms_images - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( edcc7a...f020d6 )

by Nicolaas
created 2023-02-13 02:33 UTC
getImageLinkCachedIfExists() A

↳ Parent: PerfectCmsImageDataExtension
Complexity

Conditions	2
Paths	2
Size

Total Lines	15
Code Lines	11
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	2
eloc	11
c	1
b	0
f	0
nc	2
nop	2
dl	0
loc	15
rs	9.9
<?php

namespace Sunnysideup\PerfectCmsImages\Model\File;

use SilverStripe\Assets\Folder;
use SilverStripe\Assets\Image;
use SilverStripe\Assets\Storage\AssetStore;
use SilverStripe\Control\Director;
use SilverStripe\Core\Config\Config;
use SilverStripe\Core\Convert;
use SilverStripe\Core\Injector\Injector;
use SilverStripe\ORM\DataExtension;
use SilverStripe\ORM\DB;
use SilverStripe\ORM\FieldType\DBField;
use SilverStripe\ORM\FieldType\DBHTMLText;
use SilverStripe\View\ArrayData;
use Sunnysideup\PerfectCmsImages\Api\ImageManipulations;
use Sunnysideup\PerfectCmsImages\Api\PerfectCMSImages;
use Sunnysideup\PerfectCmsImages\Model\PerfectCMSImageCache;

/**
 * defines the image sizes
 * and default upload folder.
 */
class PerfectCmsImageDataExtension extends DataExtension
{
    /**
     * background image for padded images...
     *
     * @var string
     */
    private static $perfect_cms_images_background_padding_color = '#cccccc';

    /*
     * details of the images
     *     - width: 3200
     *     - height: 3200
     *     - folder: "myfolder"
     *     - filetype: "try jpg"
     *     - enforce_size: false
     *     - folder: my-image-folder-a
     *     - filetype: "jpg or a png with a transparant background"
     *     - use_retina: true
     *     - padding_bg_colour: '#dddddd'
     *     - crop: true
     *     - move_to_right_folder: true
     *     - loading_style: 'eager'
     *     - used_by:
     *       - MyClass.MyHasOne
     *       - MyOtherClass.MyHasManyMethod
     *       - MyOtherClass.MyManyManyRel
     * @var array
     */
    private static $perfect_cms_images_image_definitions = [];

    private static $casting = [
        'PerfectCMSImageTag' => 'HTMLText',
    ];

    private static $has_many = [
        'CachedImges' => PerfectCMSImageCache::class,
    ];

    private static $cascade_deletes = [
        'CachedImges',
    ];

    /**
     * you can provide as many arguments as needed here
     *
     * @param string $method
     * @param [mixed] $args- zero to many arguments
     * @return void
     */
    public function getImageLinkCachedIfExists($method, $args = null): string
    {
        $args = func_get_args();
        //remove the method argument
        array_shift($args);

        $image = $this->owner;
        $variant = $image->variantName($method, ...$args);
        $store = Injector::inst()->get(AssetStore::class);
        if ($store->exists($image->getFilename(), $image->getHash(), $variant)) {
            return $store->getAsURL($image->getFilename(), $image->getHash(), $variant);
        } else {
            return $image->$method(
                ...$args
            )->Link();
        }
    }
    /**
     * @param string $name       PerfectCMSImages name
     * @param bool   $inline     for use within existing image tag - optional
     * @param string $alt        alt tag for image -optional
     * @param string $attributes additional attributes
     *
     * @return string (HTML)
     */
    public function getPerfectCMSImageTag(string $name, $inline = false, ?string $alt = '', ?string $attributes = '')
    {
        return $this->PerfectCMSImageTag($name, $inline, $alt, $attributes);
    }

    /**
     * @param string $name       PerfectCMSImages name
     * @param bool   $inline     for use within existing image tag - optional. can be TRUE, "TRUE" or 1 also...
     * @param string $alt        alt tag for image -optional
     * @param string $attributes additional attributes
     *
     * @return string (HTML)
     */
    public function PerfectCMSImageTag(string $name, $inline = false, ?string $alt = '', ?string $attributes = '')
    {
        $arrayData = $this->getPerfectCMSImageTagArrayData($name, $inline, $alt, $attributes);
        $template = 'Includes/PerfectCMSImageTag';
        if (true === $inline || 1 === (int) $inline || 'true' === strtolower($inline)) {
        if (true === $inline || 1 === (int) $inline || 'true' === strtolower(/** @scrutinizer ignore-type */ $inline)) {
            $template .= 'Inline';
        }

        return DBField::create_field('HTMLText', $arrayData->renderWith($template));
    }

    /**
     * @param string $name       PerfectCMSImages name
     * @param bool   $inline     for use within existing image tag - optional. can be TRUE, "TRUE" or 1 also...
     * @param string $alt        alt tag for image -optional
     * @param string $attributes additional attributes
     *
     * @return ArrayData
     */
    public function PerfectCMSImageTagArrayData(string $name, $inline = false, ?string $alt = '', ?string $attributes = '')
    {
        return $this->getPerfectCMSImageTagArrayData($name, $inline, $alt, $attributes);
    }

    /**
     * @param string $name       PerfectCMSImages name
     * @param bool   $inline     for use within existing image tag - optional. can be TRUE, "TRUE" or 1 also...
     * @param string $alt        alt tag for image -optional
     * @param string $attributes additional attributes
     *
     * @return ArrayData
     */
    public function getPerfectCMSImageTagArrayData(string $name, $inline = false, ?string $alt = '', ?string $attributes = '')
    {
        $retinaLink = $this->PerfectCMSImageLinkRetina($name);
        $nonRetinaLink = $this->PerfectCMSImageLinkNonRetina($name);

        $width = PerfectCMSImages::get_width($name, true);
        $height = PerfectCMSImages::get_height($name, true);

        $hasWebP = (bool) Config::inst()->get(ImageManipulations::class, 'webp_enabled');
        $hasMobile = PerfectCMSImages::has_mobile($name);

        // mobile links
        $mobileRetinaLink = '';
        $mobileNonRetinaLink = '';

        // mobile media query
        $mobileMediaWidth = '';

        if ($hasMobile) {
            $mobileRetinaLink = $this->PerfectCMSImageLinkRetinaForMobile($name);
            $mobileNonRetinaLink = $this->PerfectCMSImageLinkNonRetinaForMobile($name);
        }
        if ($hasWebP) {
            $retinaLinkWebP = $this->PerfectCMSImageLinkRetinaWebP($name);
            $nonRetinaLinkWebP = $this->PerfectCMSImageLinkNonRetinaWebP($name);
            if ($hasMobile) {
                $mobileRetinaLinkWebP = $this->PerfectCMSImageLinkRetinaWebPForMobile($name);
                $mobileNonRetinaLinkWebP = $this->PerfectCMSImageLinkNonRetinaWebPForMobile($name);
            }
        }

        if ($hasMobile) {
            $mobileMediaWidth = PerfectCMSImages::get_mobile_media_width($name);
        }

        if (!$alt) {
            $alt = $this->getOwner()->Title;
        }

        return ArrayData::create(
            [
                'MobileMediaWidth' => $mobileMediaWidth,
                'Width' => $width,
                'Height' => $height,
                'Alt' => Convert::raw2att($alt),
                'MobileRetinaLink' => $mobileRetinaLink,
                'MobileNonRetinaLink' => $mobileNonRetinaLink,
                'RetinaLink' => $retinaLink,
                'NonRetinaLink' => $nonRetinaLink,
                'MobileRetinaLinkWebP' => $mobileRetinaLinkWebP,

                'MobileNonRetinaLinkWebP' => $mobileNonRetinaLinkWebP,

                'RetinaLinkWebP' => $retinaLinkWebP,

                'NonRetinaLinkWebP' => $nonRetinaLinkWebP,

                'Type' => $this->owner->getMimeType(),
                'HasWebP' => $hasWebP,
                'Attributes' => DBField::create_field('HTMLText', $attributes),
            ]
        );
    }

    /**
     * @param string $name of Image Field template
     *
     * @return string (link)
     */
    public function PerfectCMSImageLinkNonRetina(string $name): string
    {
        return $this->PerfectCMSImageLink($name);
    }

    /**
     * @param string $name of Image Field template
     *
     * @return string (link)
     */
    public function PerfectCMSImageLinkRetina(string $name): string
    {
        return $this->PerfectCMSImageLink($name, true);
    }

    /**
     * @param string $name of Image Field template
     *
     * @return string (link)
     */
    public function PerfectCMSImageLinkNonRetinaWebP(string $name): string
    {
        return $this->PerfectCMSImageLink($name, false, true);
    }

    /**
     * @param string $name of Image Field template
     *
     * @return string (link)
     */
    public function PerfectCMSImageLinkRetinaWebP(string $name): string
    {
        return $this->PerfectCMSImageLink($name, true, true);
    }

    /**
     * @param string $name of Image Field template
     *
     * @return string (link)
     */
    public function PerfectCMSImageLinkNonRetinaForMobile(string $name): string
    {
        return $this->PerfectCMSImageLink($name, false, false, true);
    }

    /**
     * @param string $name of Image Field template
     *
     * @return string (link)
     */
    public function PerfectCMSImageLinkRetinaForMobile(string $name): string
    {
        return $this->PerfectCMSImageLink($name, true, false, true);
    }

    /**
     * @param string $name of Image Field template
     *
     * @return string (link)
     */
    public function PerfectCMSImageLinkNonRetinaWebPForMobile(string $name): string
    {
        return $this->PerfectCMSImageLink($name, false, true, true);
    }

    /**
     * @param string $name of Image Field template
     *
     * @return string (link)
     */
    public function PerfectCMSImageLinkRetinaWebPForMobile(string $name): string
    {
        return $this->PerfectCMSImageLink($name, true, true, true);
    }

    /**
     * @return string (link)
     */
    public function getPerfectCMSImageAbsoluteLink(string $link): string
    {
        return Director::absoluteURL($link);
    }

    /**
     * returns image link (if any).
     */
    public function PerfectCMSImageLink(string $name, ?bool $useRetina = false, ?bool $isWebP = false, ?bool $forMobile = false): string
    {
        /** @var null|Image $image */
        $image = $this->owner;
        $allOk = false;
        if ($image && $image->exists() && $image instanceof Image) {
            $allOk = true;
            //we are all good ...
        } else {
            $image = ImageManipulations::get_backup_image($name);
            if ($image && $image->exists() && $image instanceof Image) {
                $allOk = true;
            }
        }

        if ($allOk) {
            // $backEndString = Image::get_backend();
            // $backend = Injector::inst()->get($backEndString);
            $link = ImageManipulations::get_image_link($image, $name, $useRetina, $forMobile);

            if ($isWebP) {
                $link = ImageManipulations::web_p_link($link);
            }

            return $link ? ImageManipulations::add_fake_parts($image, $link) : '';
        } else {
            // no image -> provide placeholder if in DEV MODE only!!!
            if (Director::isDev()) {
                return ImageManipulations::get_placeholder_image_tag($name);
            }
        }

        // no image -> provide placeholder if in DEV MODE only!!!
        if (Director::isDev()) {
            return ImageManipulations::get_placeholder_image_tag($name);
        }

        return '';
    }

    public function PerfectCMSImageFixFolder($name, ?string $folderName = ''): ?Folder
    {
        $folder = null;
        if (PerfectCMSImages::move_to_right_folder($name) || $folderName) {
            $image = $this->getOwner();
            if ($image) {

                if (!$folderName) {
                    $folderName = PerfectCMSImages::get_folder($name);
                }
                $folder = Folder::find_or_make($folderName);
                if (!$folder->ID) {
                    $folder->write();
                }
                if ($image->ParentID !== $folder->ID) {
                    $wasPublished = $image->isPublished() && !$image->isModifiedOnDraft();
                    $image->ParentID = $folder->ID;
                    $image->write();
                    if ($wasPublished) {
                        $image->publishRecursive();
                    }
                }
            }
            // user_error('could not find image');
        }

        return $folder;
    }

    public function getCMSThumbnail()
    {
        if ($this->owner->ID) {
            if ('svg' === $this->owner->getExtension()) {
                $obj = DBHTMLText::create();
                $obj->setValue(file_get_contents(BASE_PATH . $this->owner->Link()));

                return $obj;
            }

            return $this->owner->CMSThumbnail();
        }

        return $this->owner->CMSThumbnail();
    }

    public function updatePreviewLink(&$link, $action)
    {
        $owner = $this->getOwner();
        if ('svg' === $this->owner->getExtension()) {
            return $owner->Link();
        }

        return $link;
    }

    public function onBeforeUnpublish()
    {
        DB::query('DELETE FROM "PerfectCMSImageCache" WHERE "ImageID" = ' . $this->getOwner()->ID);
    }
}

sunnysideup / silverstripe-perfect_cms_images

Push — master ( edcc7a...f020d6 )

getImageLinkCachedIfExists() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
