nystudio107 / craft-plugin-vite

src/helpers/FileHelper.php

<?php
/**
 * Vite plugin for Craft CMS
 *
 * Allows the use of the Vite.js next generation frontend tooling with Craft CMS
 *
 * @link      https://nystudio107.com

The tag in position 1 should be the @copyright tag

 * @copyright Copyright (c) 2021 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\pluginvite\helpers;

use Craft;
use craft\helpers\FileHelper as CraftFileHelper;
use craft\helpers\UrlHelper;
use GuzzleHttp\Client;
use GuzzleHttp\RequestOptions;
use Psr\Http\Message\ResponseInterface;
use Throwable;
use yii\caching\ChainedDependency;
use yii\caching\FileDependency;
use yii\caching\TagDependency;

/**

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   Vite

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

 * @since     1.0.5

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

class FileHelper
{
    // Constants
    // =========================================================================

    public const CACHE_KEY = 'vite';
    public const CACHE_TAG = 'vite';

    public const DEVMODE_CACHE_DURATION = 1;

    public const SCRIPTS_DIR = '@vendor/nystudio107/craft-plugin-vite/src/web/assets/dist/';

    /**
     * Return the contents of a local file (via path) or remote file (via URL),
     * or null if the file doesn't exist or couldn't be fetched
     * Yii2 aliases and/or environment variables may be used
     *
     * @param string $pathOrUrl

Missing parameter comment

Expected 8 spaces after parameter type; 1 found

     * @param callable|null $callback

Missing parameter comment

     * @param string $cacheKeySuffix

Missing parameter comment

Expected 8 spaces after parameter type; 1 found

     *
     * @return string|array|null
     */
    public static function fetch(string $pathOrUrl, callable $callback = null, string $cacheKeySuffix = '')
    {
        $pathOrUrl = (string)Craft::parseEnv($pathOrUrl);

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

        // Create the dependency tags
        $dependency = new TagDependency([

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

            'tags' => [
                self::CACHE_TAG . $cacheKeySuffix,
                self::CACHE_TAG . $cacheKeySuffix . $pathOrUrl,
            ],
        ]);

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

        // If this is a file path such as for the `manifest.json`, add a FileDependency so it's cache bust if the file changes
        if (!UrlHelper::isAbsoluteUrl($pathOrUrl)) {
            $dependency = new ChainedDependency([

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

                'dependencies' => [
                    new FileDependency([

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

                        'fileName' => $pathOrUrl,
                    ]),

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

                    $dependency,
                ],
            ]);

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

        }
        // Set the cache duration based on devMode
        $cacheDuration = Craft::$app->getConfig()->getGeneral()->devMode
            ? self::DEVMODE_CACHE_DURATION
            : null;
        // Get the result from the cache, or parse the file
        $cache = Craft::$app->getCache();
        return $cache->getOrSet(
            self::CACHE_KEY . $cacheKeySuffix . $pathOrUrl,
            function() use ($pathOrUrl, $callback) {

Expected 1 space after FUNCTION keyword; 0 found

                $contents = null;
                if (UrlHelper::isAbsoluteUrl($pathOrUrl)) {
                    $response = self::fetchResponse($pathOrUrl);
                    if ($response && $response->getStatusCode() === 200) {
                        $contents = $response->getBody()->getContents();
                    }
                } else {
                    // If this is a file path, normalize it first
                    $pathOrUrl = CraftFileHelper::normalizePath($pathOrUrl);
                    $contents = @file_get_contents($pathOrUrl);
                }
                if ($contents && $callback) {
                    $contents = $callback($contents);
                }

                return $contents;
            },
            $cacheDuration,
            $dependency
        );
    }

    /**
     * Return a Guzzle ResponseInterface for the passed in $url
     *
     * @param string $url

Missing parameter comment

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

     * @return ResponseInterface|null

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

     */
    public static function fetchResponse(string $url): ?ResponseInterface
    {
        $response = null;

The assignment to $response is dead and can be removed.

        $clientOptions = [
            RequestOptions::HTTP_ERRORS => false,
            RequestOptions::CONNECT_TIMEOUT => 3,
            RequestOptions::VERIFY => false,
            RequestOptions::TIMEOUT => 5,
        ];
        $client = new Client($clientOptions);
        try {
            $response = $client->request('GET', $url, [

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

                RequestOptions::HEADERS => [
                    'Accept' => '*/*',
                ],
            ]);

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

        } catch (Throwable $e) {
            Craft::error($e->getMessage(), __METHOD__);
        }

        return $response;
    }

    /**
     * Combine a path with a URL to create a URL
     *
     * @param string $url

Missing parameter comment

     * @param string $path

Missing parameter comment

     *
     * @return string
     */
    public static function createUrl(string $url, string $path): string
    {
        $url = (string)Craft::parseEnv($url);

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

        return rtrim($url, '/') . '/' . trim($path, '/');
    }

    /**
     * Fetch a script file
     *
     * @param string $name

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

Missing parameter comment

     * @param string $cacheKeySuffix

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

Missing parameter comment

     * @return string

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

     */
    public static function fetchScript(string $name, string $cacheKeySuffix = ''): string
    {
        $path = self::createUrl(self::SCRIPTS_DIR, $name);

        return self::fetch($path, null, $cacheKeySuffix) ?? '';

The expression return self::fetch($path, null, $cacheKeySuffix) ?? '' could return the type array which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

    }
}