nystudio107 / craft-imageoptimize

src/imagetransforms/ImageTransform.php

<?php
/**
 * ImageOptimize plugin for Craft CMS
 *
 * Automatically optimize images after they've been transformed
 *
 * @link      https://nystudio107.com

The tag in position 1 should be the @copyright tag

 * @copyright Copyright (c) 2018 nystudio107

@copyright tag must contain a year and the name of the copyright holder

 */

PHP version not specified

Missing @category tag in file comment

Missing @package tag in file comment

Missing @author tag in file comment

Missing @license tag in file comment

namespace nystudio107\imageoptimize\imagetransforms;

use Craft;
use craft\base\SavableComponent;
use craft\elements\Asset;
use craft\helpers\FileHelper;
use craft\helpers\StringHelper;
use craft\models\ImageTransform as CraftImageTransformModel;
use nystudio107\imageoptimize\helpers\UrlHelper;
use ReflectionClass;

/**

Missing short description in doc comment

 * @author    nystudio107

The tag in position 1 should be the @package tag

Content of the @author tag must be in the form "Display Name <username@example.com>"

Tag value for @author tag indented incorrectly; expected 2 spaces but found 4

 * @package   ImageOptimize

Tag value for @package tag indented incorrectly; expected 1 spaces but found 3

 * @since     1.6.0

The tag in position 3 should be the @author tag

Tag value for @since tag indented incorrectly; expected 3 spaces but found 5

 */

Missing @category tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

abstract class ImageTransform extends SavableComponent implements ImageTransformInterface
{
    // Traits
    // =========================================================================

    use ImageTransformTrait;

    // Static Methods
    // =========================================================================

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public static function displayName(): string
    {
        return Craft::t('image-optimize', 'Generic Transform');
    }

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public static function getTemplatesRoot(): array
    {
        $reflect = new ReflectionClass(static::class);
        $classPath = FileHelper::normalizePath(
                dirname($reflect->getFileName())

This line of the multi-line function call does not seem to be indented correctly. Expected 12 spaces, but found 16.

                . '/../templates'
            )

This line of the multi-line function call does not seem to be indented correctly. Expected 8 spaces, but found 12.

            . DIRECTORY_SEPARATOR;
        $id = StringHelper::toKebabCase($reflect->getShortName());

        return [$id, $classPath];
    }

    // Public Methods
    // =========================================================================

    /**

Parameter $asset should have a doc-comment as per coding-style.

Parameter $transform should have a doc-comment as per coding-style.

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function getTransformUrl(Asset $asset, CraftImageTransformModel|string|array|null $transform): ?string
    {
        return null;
    }

    /**

Missing short description in doc comment

Parameter $url should have a doc-comment as per coding-style.

Parameter $asset should have a doc-comment as per coding-style.

Parameter $transform should have a doc-comment as per coding-style.

     * @inheritdoc
     */

Missing @return tag in function comment

    public function getWebPUrl(string $url, Asset $asset, CraftImageTransformModel|string|array|null $transform): ?string
    {
        return $url;
    }

    /**

Missing short description in doc comment

Parameter $asset should have a doc-comment as per coding-style.

     * @inheritdoc
     */

Missing @return tag in function comment

    public function getPurgeUrl(Asset $asset): ?string
    {
        return null;
    }

    /**

Missing short description in doc comment

Parameter $url should have a doc-comment as per coding-style.

     * @inheritdoc
     */

Missing @return tag in function comment

    public function purgeUrl(string $url): bool
    {
        return true;
    }

    /**

Missing short description in doc comment

Parameter $asset should have a doc-comment as per coding-style.

     * @inheritdoc
     */

Missing @return tag in function comment

    public function getAssetUri(Asset $asset): ?string
    {
        $volume = $asset->getVolume();
        $assetPath = $volume->getSubpath() . $asset->getPath();

        // Account for volume types with a subfolder setting
        // e.g. craftcms/aws-s3, craftcms/google-cloud
        if ($volume->getFs()->subfolder ?? null) {
            $subfolder = $volume->getFs()->subfolder;
            $subfolder = Craft::parseEnv($subfolder);

The function Craft::parseEnv() has been deprecated: in 3.7.29. [[App::parseEnv()]] should be used instead.

            return rtrim($subfolder, '/') . '/' . $assetPath;

It seems like $subfolder can also be of type null; however, parameter $string of rtrim() does only seem to accept string, maybe add an additional type check?

        }

        return $assetPath;
    }

    /**

Missing short description in doc comment

     * @param string $url

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 8 spaces but found 1

     * @noinspection PhpComposerExtensionStubsInspection

Tag @noinspection cannot be grouped with parameter tags in a doc comment

     */

Missing @return tag in function comment

    public function prefetchRemoteFile(string $url): void
    {
        // Get an absolute URL with protocol that curl will be happy with
        $url = UrlHelper::absoluteUrlWithProtocol($url);
        $ch = curl_init($url);
        curl_setopt_array($ch, [

The opening parenthesis of a multi-line function call should be the last content on the line.

            CURLOPT_RETURNTRANSFER => 1,
            CURLOPT_FOLLOWLOCATION => 1,
            CURLOPT_SSL_VERIFYPEER => 0,
            CURLOPT_NOBODY => 1,
        ]);

For multi-line function calls, the closing parenthesis should be on a new line.

        curl_exec($ch);
        curl_close($ch);
    }

    /**
     * Append an extension a passed url or path
     *
     * @param $pathOrUrl

Missing parameter comment

     * @param $extension

Missing parameter comment

     *
     * @return string
     */
    public function appendExtension($pathOrUrl, $extension): string
    {
        $path = $this->decomposeUrl($pathOrUrl);
        $path_parts = pathinfo($path['path']);
        $new_path = ($path_parts['filename']) . '.' . ($path_parts['extension'] ?? '') . $extension;
        if (!empty($path_parts['dirname']) && $path_parts['dirname'] !== '.') {
            $dirname = $path_parts['dirname'];
            $dirname = $dirname === '/' ? '' : $dirname;
            $new_path = $dirname . DIRECTORY_SEPARATOR . $new_path;
            $new_path = preg_replace('/([^:])(\/{2,})/', '$1/', $new_path);
        }

        return $path['prefix'] . $new_path . $path['suffix'];
    }

    // Protected Methods
    // =========================================================================

    /**
     * Decompose a URL into a prefix, path, and suffix
     *
     * @param $pathOrUrl

Missing parameter comment

     *
     * @return array
     */
    protected function decomposeUrl($pathOrUrl): array
    {
        $result = array();

        if (filter_var($pathOrUrl, FILTER_VALIDATE_URL)) {
            $url_parts = parse_url($pathOrUrl);
            $result['prefix'] = $url_parts['scheme'] . '://' . $url_parts['host'];
            if (!empty($url_parts['port'])) {
                $result['prefix'] .= ':' . $url_parts['port'];
            }
            $result['path'] = $url_parts['path'];
            $result['suffix'] = '';
            $result['suffix'] .= empty($url_parts['query']) ? '' : '?' . $url_parts['query'];
            $result['suffix'] .= empty($url_parts['fragment']) ? '' : '#' . $url_parts['fragment'];
        } else {
            $result['prefix'] = '';
            $result['path'] = $pathOrUrl;
            $result['suffix'] = '';
        }

        return $result;
    }
}