nystudio107\vite\Vite::injectErrorEntry()

Complexity

Conditions	9
Paths	11

Size

Total Lines	19
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

1 Method

Rating	Name	Duplication	Size	Complexity
A	Vite::createSettingsModel()	0	3	1

<?php
/**
 * Vite plugin for Craft CMS 3.x
 *
 * 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\vite;

use nystudio107\vite\models\Settings;
use nystudio107\vite\variables\ViteVariable;

use nystudio107\pluginvite\services\ViteService;

use Craft;
use craft\base\Plugin;
use craft\events\RegisterCacheOptionsEvent;
use craft\utilities\ClearCaches;
use craft\web\twig\variables\CraftVariable;

use yii\base\Event;

/**
 * Class Vite
 *
 * @author    nystudio107

The tag in position 1 should be the @package tag

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

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

 * @package   Vite

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

 * @since     1.0.0

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

The tag in position 3 should be the @author tag

 *
 * @property  ViteService $vite

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

 */

Missing @link tag in class comment

Missing @license tag in class comment

Missing @category tag in class comment

class Vite extends Plugin
{
    // Static Properties
    // =========================================================================

    /**

Missing short description in doc comment

     * @var Vite
     */
    public static $plugin;

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

    /**

Missing short description in doc comment

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

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

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

     * @inheritdoc
     */
    public function __construct($id, $parent = null, array $config = [])
    {
        $config['components'] = [
            'vite' => [
                'class' => ViteService::class,
            ]
        ];

        parent::__construct($id, $parent, $config);
    }

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

    /**

Missing short description in doc comment

     * @var string
     */
    public $schemaVersion = '1.0.0';

    /**

Missing short description in doc comment

     * @var bool
     */
    public $hasCpSettings = false;

    /**

Missing short description in doc comment

     * @var bool
     */
    public $hasCpSection = false;

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

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function init()
    {
        parent::init();
        self::$plugin = $this;

        // Configure our Vite service with the settings
        $settings = $this->getSettings();
        if ($settings) {
            $settingsAttrs = $settings->getAttributes();
            $viteAttrs = $this->vite->getAttributes();
            Craft::configure($this->vite, array_intersect_key(

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

                $settingsAttrs,
                $viteAttrs
            ));

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

        }
        // Register our variable
        Event::on(
            CraftVariable::class,
            CraftVariable::EVENT_INIT,
            function (Event $event) {
                /** @var CraftVariable $variable */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

                $variable = $event->sender;
                $variable->set('vite', [

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

                    'class' => ViteVariable::class,
                    'viteService' => $this->vite,
                ]);

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

            }
        );
        // Handler: ClearCaches::EVENT_REGISTER_CACHE_OPTIONS
        Event::on(
            ClearCaches::class,
            ClearCaches::EVENT_REGISTER_CACHE_OPTIONS,
            function (RegisterCacheOptionsEvent $event) {
                Craft::debug(
                    'ClearCaches::EVENT_REGISTER_CACHE_OPTIONS',
                    __METHOD__
                );
                // Register our caches for the Clear Cache Utility
                $event->options = array_merge(
                    $event->options,
                    $this->customAdminCpCacheOptions()
                );
            }
        );
        // Log that the plugin has loaded
        Craft::info(
            Craft::t(
                'vite',
                '{name} plugin loaded',
                ['name' => $this->name]
            ),
            __METHOD__
        );
    }

    /**
     * Clear all the caches!
     */

Missing @return tag in function comment

    public function clearAllCaches()
    {
        // Clear all of Vite's caches
        $this->vite->invalidateCaches();
    }

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

    /**
     * Returns the custom Control Panel cache options.
     *
     * @return array
     */
    protected function customAdminCpCacheOptions(): array
    {
        return [
            // Manifest cache
            [
                'key' => 'vite-file-cache',
                'label' => Craft::t('vite', 'Vite Cache'),
                'action' => [$this, 'clearAllCaches'],
            ],
        ];
    }

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    protected function createSettingsModel()
    {
        return new Settings();
    }
}