nystudio107 / craft-twigfield

src/Twigfield.php

<?php
/**
 * Twigfield for Craft CMS
 *
 * Provides a twig editor field with Twig & Craft API autocomplete
 *
 * @link      https://nystudio107.com

The tag in position 1 should be the @copyright tag

 * @copyright Copyright (c) 2022 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\twigfield;

use Craft;
use craft\events\RegisterTemplateRootsEvent;
use craft\helpers\UrlHelper;
use craft\i18n\PhpMessageSource;
use craft\web\Application as CraftWebApp;
use craft\web\View;
use nystudio107\twigfield\helpers\Config;
use nystudio107\twigfield\models\Settings;
use nystudio107\twigfield\services\AutocompleteService;
use yii\base\BootstrapInterface;
use yii\base\Event;
use yii\base\Module;

/**

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   Twigfield

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 AutocompleteService $autocomplete
 */

Missing @category tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class Twigfield extends Module implements BootstrapInterface
{
    // Constants
    // =========================================================================

    const ID = 'twigfield';

    const DEFAULT_FIELD_TYPE = 'Twigfield';

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

    /**

Missing short description in doc comment

     * @var Settings The Twigfield config settings
     */
    public static $settings = null;

    // Public 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.

     * @inerhitdoc
     */
    public function __construct($id = self::ID, $parent = null, $config = [])
    {
        /**
         * Explicitly set the $id parameter, as earlier versions of Yii2 look for a
         * default parameter, and depend on $id being explicitly set:
         * https://github.com/yiisoft/yii2/blob/f3d1534125c9c3dfe8fa65c28a4be5baa822e721/framework/di/Container.php#L436-L448
         */
        parent::__construct($id, $parent, $config);
    }

    /**

Missing short description in doc comment

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

     * @inerhitDoc
     */

Missing @return tag in function comment

    public function bootstrap($app)
    {
        // Only bootstrap if this is a CraftWebApp
        if (!$app instanceof CraftWebApp) {
            return;
        }
        // Set the instance of this module class, so we can later access it with `Twigfield::getInstance()`
        static::setInstance($this);
        // Configure our module
        $this->configureModule();
        // Register our components
        $this->registerComponents();
        // Register our event handlers
        $this->registerEventHandlers();
        Craft::info('Twigfield module bootstrapped', __METHOD__);
    }

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

    /**
     * Configure our module
     *
     * @return void
     */
    protected function configureModule(): void
    {
        // Set up our alias
        Craft::setAlias('@nystudio107/twigfield', $this->getBasePath());
        Craft::setAlias('@twigfieldEndpointUrl', UrlHelper::actionUrl('twigfield/autocomplete/index'));
        // Register our module
        Craft::$app->setModule($this->id, $this);
        // Translation category
        $i18n = Craft::$app->getI18n();
        /** @noinspection UnSafeIsSetOverArrayInspection */

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

        if (!isset($i18n->translations[$this->id]) && !isset($i18n->translations[$this->id . '*'])) {
            $i18n->translations[$this->id] = [
                'class' => PhpMessageSource::class,
                'sourceLanguage' => 'en-US',
                'basePath' => '@nystudio107/twigfield/translations',
                'forceTranslation' => true,
                'allowOverrides' => true,
            ];
        }
        // Set our settings
        $config = Config::getConfigFromFile($this->id);
        self::$settings = new Settings($config);
    }

    /**
     * Registers our components
     *
     * @return void
     */
    public function registerComponents(): void
    {
        $this->setComponents([

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

            'autocomplete' => AutocompleteService::class,
        ]);

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

    }

    /**
     * Registers our event handlers
     *
     * @return void
     */
    public function registerEventHandlers(): void
    {
        // Base CP templates directory
        Event::on(View::class, View::EVENT_REGISTER_CP_TEMPLATE_ROOTS, function (RegisterTemplateRootsEvent $e) {

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

            if (is_dir($baseDir = $this->getBasePath() . DIRECTORY_SEPARATOR . 'templates')) {
                $e->roots[$this->id] = $baseDir;
            }
        });

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

        // Base Site templates directory
        if (self::$settings->allowFrontendAccess) {
            Event::on(View::class, View::EVENT_REGISTER_SITE_TEMPLATE_ROOTS, function (RegisterTemplateRootsEvent $e) {

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

                if (is_dir($baseDir = $this->getBasePath() . DIRECTORY_SEPARATOR . 'templates')) {
                    $e->roots[$this->id] = $baseDir;
                }
            });

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

        }
    }
}