nystudio107 / craft-units

src/models/Settings.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\models;

use craft\base\Model;
use PhpUnitsOfMeasure\PhysicalQuantity\Length;

/**

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   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 Settings extends Model
{
    // Public Properties
    // =========================================================================

    /**

Missing short description in doc comment

     * @var string The default fully qualified class name of the unit of measure
     */
    public string $defaultUnitsClass = Length::class;

    /**

Missing short description in doc comment

     * @var float The default value of the unit of measure
     */
    public float $defaultValue = 0.0;

    /**

Missing short description in doc comment

     * @var string The default units that the unit of measure is in
     */
    public string $defaultUnits = 'ft';

    /**

Missing short description in doc comment

     * @var bool Whether the units the field can be changed
     */
    public bool $defaultChangeableUnits = true;

    /**

Missing short description in doc comment

     * @var int|float The default minimum allowed number
     */
    public int|float $defaultMin = 0;

    /**

Missing short description in doc comment

     * @var int|float|null The default maximum allowed number
     */
    public int|null|float $defaultMax = null;

    /**

Missing short description in doc comment

     * @var int The default number of digits allowed after the decimal point
     */
    public int $defaultDecimals = 3;

    /**

Missing short description in doc comment

     * @var int|null The default size of the field
     */
    public ?int $defaultSize = 6;

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

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function rules(): array
    {
        $rules = parent::rules();
        $rules = array_merge($rules, [

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

            ['defaultUnitsClass', 'string'],
            ['defaultUnitsClass', 'default', 'value' => Length::class],
            ['defaultValue', 'number'],
            ['defaultValue', 'default', 'value' => 0.0],
            ['defaultUnits', 'string'],
            ['defaultUnits', 'default', 'value' => 'ft'],
            ['defaultChangeableUnits', 'boolean'],
            ['defaultChangeableUnits', 'default', 'value' => true],
            [['defaultMin', 'defaultMax'], 'number'],
            [
                ['defaultMax'],
                'compare',
                'compareAttribute' => 'defaultMin',
                'operator' => '>=',
            ],
            ['defaultMin', 'default', 'value' => 0],
            ['defaultMax', 'default', 'value' => null],
            [['defaultDecimals', 'defaultSize'], 'integer'],
            ['defaultDecimals', 'default', 'value' => 3],
            ['defaultSize', 'default', 'value' => 6],
        ]);

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

        if (!$this->defaultDecimals) {
            $rules[] = [['defaultMin', 'defaultMax'], 'integer'];
        }

        return $rules;
    }
}