nystudio107 / craft-units

src/Units.php

<?php
/**
 * Units plugin for Craft CMS
 *
 * A plugin for handling physical quantities and the units of measure in which they're represented.
 *
 * @link      https://nystudio107.com/

The tag in position 1 should be the @copyright tag

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

use Craft;
use craft\base\Model;
use craft\base\Plugin;
use craft\events\RegisterComponentTypesEvent;
use craft\services\Fields;
use craft\web\twig\variables\CraftVariable;
use nystudio107\units\fields\Units as UnitsField;
use nystudio107\units\helpers\ClassHelper;
use nystudio107\units\models\Settings;
use nystudio107\units\variables\UnitsVariable;
use PhpUnitsOfMeasure\PhysicalQuantity\Length;
use yii\base\Event;

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

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

Missing @license tag in class comment

Missing @link tag in class comment

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

    /**

Missing short description in doc comment

     * @var Units
     */
    public static $plugin;

    /**

Missing short description in doc comment

     * @var UnitsVariable
     */
    public static $variable;

    // 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 = true;
    /**

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(): void
    {
        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[] = UnitsField::class;
            }
        );

        self::$variable = new UnitsVariable();
        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('units', self::$variable);
            }
        );

        Event::on(
            UnitsField::class,
            'craftQlGetFieldSchema',
            static function($event) {

Expected 1 space after FUNCTION keyword; 0 found

                $field = $event->sender;

                if (!$field instanceof UnitsField) {
                    return;
                }

                $object = $event->schema->createObjectType(ucfirst($field->handle) . 'Units');
                $object->addFloatField('value');
                $object->addStringField('units');

                $event->schema->addField($field)->type($object);
                $event->handled = true;
            }
        );

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

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

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

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

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    protected function settingsHtml(): ?string
    {
        $unitsClassMap = array_flip(ClassHelper::getClassesInNamespace(Length::class));
        return Craft::$app->view->renderTemplate(
            'units/settings',
            [
                'settings' => $this->getSettings(),
                'unitsClassMap' => $unitsClassMap,
            ]
        );
    }
}