nystudio107 / craft-plugin-vite

src/services/VitePluginService.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\services;

use Craft;
use craft\helpers\App;
use nystudio107\pluginvite\helpers\FileHelper;

/**

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.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 @link tag in class comment

Missing @license tag in class comment

Missing @category tag in class comment

class VitePluginService extends ViteService
{
    // Constants
    // =========================================================================

    protected const MANIFEST_FILE_NAME = 'manifest.json';

    // Public Properties
    // =========================================================================

    /**

Missing short description in doc comment

     * @var string AssetBundle class name to get the published URLs from
     */
    public string $assetClass = '';

    /**

Missing short description in doc comment

     * @var string The environment variable to look for in order to enable the devServer; the value doesn't matter,
     *              it just needs to exist
     */
    public string $pluginDevServerEnvVar = 'VITE_PLUGIN_DEVSERVER';

    /**

Missing short description in doc comment

     * @var bool Normally the AssetBundle only needs to be registered for CP and Preview requests, and having it
     *           not load for frontend requests saves a db write: https://github.com/nystudio107/craft-plugin-vite/issues/27
     */
    public bool $useForAllRequests = false;

    /**

Missing short description in doc comment

     * @var array|string[] If the first segment of the request matches any items in the array, load the AssetBundle, too.
     *                      Needed for things that add frontend preview targets like SEOmatic
     */
    public array $firstSegmentRequests = [
        'seomatic',
    ];

    /**

Missing short description in doc comment

     * @inheritDoc
     */

Missing @return tag in function comment

    public function init(): void
    {
        // See if the $pluginDevServerEnvVar env var exists, and if not, don't run off of the dev server
        $useDevServer = (bool)App::env($this->pluginDevServerEnvVar);
        if ($useDevServer === false) {
            $this->useDevServer = false;
        }
        parent::init();
        // If we're in a plugin, make sure the caches are unique
        if ($this->assetClass) {
            $this->cacheKeySuffix = $this->assetClass;
        }
        if ($this->devServerRunning()) {
            $this->invalidateCaches();
        }
        // If we have no asset bundle class, or the dev server is running, don't swap in our `/cpresources/` paths
        if (!$this->assetClass || $this->devServerRunning()) {
            return;
        }
        // The Vite service is generally only needed for CP requests & previews, save a db write, see:
        // https://github.com/nystudio107/craft-plugin-vite/issues/27
        $request = Craft::$app->getRequest();
        if (!$this->useForAllRequests && !$request->getIsConsoleRequest()) {
            if (!$request->getIsCpRequest() && !$request->getIsPreview() && !in_array($request->getSegment(1), $this->firstSegmentRequests, true)) {
                return;
            }
        }
        // Map the $manifestPath and $serverPublic to the hashed `/cpresources/` path & URL for our AssetBundle
        $bundle = new $this->assetClass();
        $baseAssetsUrl = Craft::$app->assetManager->getPublishedUrl(
            $bundle->sourcePath,
            true

The call to yii\web\AssetManager::getPublishedUrl() has too many arguments starting with true.

        );
        $this->manifestPath = FileHelper::createUrl($bundle->sourcePath, self::MANIFEST_FILE_NAME);
        if ($baseAssetsUrl !== false) {
            $this->serverPublic = $baseAssetsUrl;
        }
    }
}