nystudio107\codefield\CodeField

Complexity

Total Complexity

2

Size/Duplication

Total Lines	63
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

1 Method

Rating	Name	Duplication	Size	Complexity
A	init()	0	29	2

<?php
/**
 * Code Field plugin for Craft CMS
 *
 * Provides a Code Field that has a full-featured code editor with syntax highlighting & 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\codefield;

use Craft;
use craft\base\Plugin;
use craft\events\PluginEvent;
use craft\events\RegisterComponentTypesEvent;
use craft\services\Fields;
use craft\services\Plugins;
use nystudio107\codefield\fields\Code;
use yii\base\Event;

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

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

 * @since     4.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

 *
 */

Additional blank lines found at end of doc comment

Missing @category tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

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

    /**

Missing short description in doc comment

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

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

     * @var bool
     */
    public bool $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;

        Event::on(
            Fields::class,
            Fields::EVENT_REGISTER_FIELD_TYPES,
            static function(RegisterComponentTypesEvent $event) {

Expected 1 space after FUNCTION keyword; 0 found

                $event->types[] = Code::class;
            }
        );

        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.

                }
            }
        );

        Craft::info(
            Craft::t(
                'codefield',
                '{name} plugin loaded',
                ['name' => $this->name]
            ),
            __METHOD__
        );
    }
}