nystudio107 / craft-twigpack

src/Twigpack.php

<?php
/**
 * Twigpack plugin for Craft CMS 3.x
 *
 * Twigpack is the conduit between Twig and webpack, with manifest.json &
 * webpack-dev-server HMR support
 *
 * @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\twigpack;

use Craft;
use craft\base\Model;
use craft\base\Plugin;
use craft\cloud\cli\controllers\UpController;
use craft\events\CancelableEvent;
use craft\events\PluginEvent;
use craft\events\RegisterCacheOptionsEvent;
use craft\events\TemplateEvent;
use craft\services\Plugins;
use craft\utilities\ClearCaches;
use craft\web\Application;
use craft\web\twig\variables\CraftVariable;
use craft\web\View;
use nystudio107\twigpack\models\Settings;
use nystudio107\twigpack\services\Manifest as ManifestService;
use nystudio107\twigpack\variables\ManifestVariable;
use yii\base\Event;
use yii\web\NotFoundHttpException;

/**
 * Class Twigpack
 *
 * @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   Twigpack

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

 *
 * @property  ManifestService $manifest

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

 */

Missing @category tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

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

    /**

Missing short description in doc comment

     * @var ?Twigpack
     */
    public static ?Twigpack $plugin = null;

    /**

Missing short description in doc comment

     * @var string
     */
    public static string $templateName = '';

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

Missing short description in doc comment

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

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

Missing short description in doc comment

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

Missing short description in doc comment

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

    /**

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'] = [
            'manifest' => ManifestService::class,
        ];

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

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

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function init(): void
    {
        parent::init();
        self::$plugin = $this;
        // Install our event listeners
        $this->installEventListeners();
        // Log that we've loaded
        Craft::info(
            Craft::t(
                'twigpack',
                '{name} plugin loaded',
                ['name' => $this->name]
            ),
            __METHOD__
        );
    }

    /**
     * Clear all the caches!
     */

Missing @return tag in function comment

    public function clearAllCaches(): void
    {
        // Clear all of Twigpack's caches
        self::$plugin->manifest->invalidateCaches();
    }

    /**
     * Inject the error entry point JavaScript for auto-reloading of Twig error
     * pages
     */

Missing @return tag in function comment

    public function injectErrorEntry(): void
    {
        if (Craft::$app->getResponse()->isServerError || Craft::$app->getResponse()->isClientError) {
            /** @var ?Settings $settings */

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

            $settings = self::$plugin->getSettings();

The method getSettings() does not exist on null.

            if ($settings && !empty($settings->errorEntry) && $settings->useDevServer) {
                try {
                    $errorEntry = $settings->errorEntry;
                    if (is_string($errorEntry)) {
                        $errorEntry = [$errorEntry];
                    }
                    foreach ($errorEntry as $entry) {
                        $tag = self::$plugin->manifest->getJsModuleTags($entry, false);
                        if ($tag !== null) {
                            echo $tag;
                        }
                    }
                } catch (NotFoundHttpException $e) {
                    // That's okay, Twigpack will have already logged the error
                }
            }
        }
    }

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

    /**
     * Install our event listeners.
     */

Missing @return tag in function comment

    protected function installEventListeners(): void
    {
        // Remember the name of the currently rendering template
        // Handler: View::EVENT_BEFORE_RENDER_PAGE_TEMPLATE
        Event::on(
            View::class,
            View::EVENT_BEFORE_RENDER_PAGE_TEMPLATE,
            static function(TemplateEvent $event) {

Expected 1 space after FUNCTION keyword; 0 found

                self::$templateName = $event->template;
            }
        );
        // Handler: CraftVariable::EVENT_INIT
        Event::on(
            CraftVariable::class,
            CraftVariable::EVENT_INIT,
            static function(Event $event) {

Expected 1 space after FUNCTION keyword; 0 found

                /** @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('twigpack', ManifestVariable::class);
            }
        );
        // Handler: Plugins::EVENT_AFTER_INSTALL_PLUGIN
        Event::on(
            Plugins::class,
            Plugins::EVENT_AFTER_INSTALL_PLUGIN,
            function(PluginEvent $event) {

Expected 1 space after FUNCTION keyword; 0 found

                if ($event->plugin === $this) {

The condition $event->plugin === $this is always false.

                    // Invalidate our caches after we've been installed
                    $this->clearAllCaches();
                }
            }
        );
        // Handler: ClearCaches::EVENT_REGISTER_CACHE_OPTIONS
        Event::on(
            ClearCaches::class,
            ClearCaches::EVENT_REGISTER_CACHE_OPTIONS,
            function(RegisterCacheOptionsEvent $event) {

Expected 1 space after FUNCTION keyword; 0 found

                Craft::debug(
                    'ClearCaches::EVENT_REGISTER_CACHE_OPTIONS',
                    __METHOD__
                );
                // Register our caches for the Clear Cache Utility
                $event->options = array_merge(
                    $event->options,
                    $this->customAdminCpCacheOptions()
                );
            }
        );
        // Clears cache after craft cloud/up is run, which Craft Cloud runs on deploy
        // Handler: UpController::EVENT_AFTER_UP
        if (class_exists(UpController::class)) {
            Event::on(
                UpController::class,
                UpController::EVENT_AFTER_UP,
                function (CancelableEvent $event) {

The parameter $event is not used and could be removed.

                    $this->clearAllCaches();
                }
            );
        }

        // delay attaching event handler to the view component after it is fully configured
        $app = Craft::$app;
        if ($app->getConfig()->getGeneral()->devMode) {
            $app->on(Application::EVENT_BEFORE_REQUEST, function() use ($app) {

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

Expected 1 space after FUNCTION keyword; 0 found

                $app->getView()->on(View::EVENT_END_BODY, [$this, 'injectErrorEntry']);
            });

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

        }
    }

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

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    protected function createSettingsModel(): ?Model
    {
        return new Settings();
    }
}