nystudio107 / craft-units

src/validators/EmbeddedUnitsDataValidator.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\validators;

use Craft;
use nystudio107\units\models\UnitsData;
use yii\base\Model;
use yii\validators\NumberValidator;
use yii\validators\Validator;
use function is_object;

/**

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 EmbeddedUnitsDataValidator extends Validator
{
    // Public Properties
    // =========================================================================

    /**

Missing short description in doc comment

     * @var string the base units
     */
    public $units;

    /**

Missing short description in doc comment

     * @var bool whether the attribute value can only be an integer. Defaults
     *      to false.
     */
    public $integerOnly = false;
    /**

Missing short description in doc comment

     * @var int|float|null upper limit of the number. Defaults to null, meaning no
     *      upper limit.
     * @see tooBig for the customized message used when the number is too big.
     */
    public $max = null;
    /**

Missing short description in doc comment

     * @var int|float|null lower limit of the number. Defaults to null, meaning no
     *      lower limit.
     * @see tooSmall for the customized message used when the number is too
     *      small.
     */
    public $min = null;

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

    /**

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

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

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function validateAttribute($model, $attribute)
    {
        /** @var Model $model */

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

        $value = $model->$attribute;

        if ($value !== null && is_object($value) && $value instanceof UnitsData) {
            // Validate the model
            $value->validate();
            // Normalize the min/max value
            $this->normalizeMinMax($value);
            // Do a min/max validation, too
            $config = [
                'integerOnly' => $this->integerOnly,
                'min' => $this->min,
                'max' => $this->max,
            ];
            $numberValidator = new NumberValidator($config);
            $numberValidator->validateAttribute($value, 'value');
            // Add any errors to the parent model
            $errors = $value->getErrors();
            foreach ($errors as $attributeError => $valueErrors) {
                /** @var array $valueErrors */

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

                foreach ($valueErrors as $valueError) {
                    $model->addError(
                        $attribute,
                        $valueError
                    );
                }
            }
        } else {
            $model->addError($attribute, Craft::t('units', 'Is not a Model object.'));
        }
    }

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

    /**
     * Normalize the min/max values using the base units
     *
     * @param UnitsData $unitsData

Missing parameter comment

     */

Missing @return tag in function comment

    protected function normalizeMinMax(UnitsData $unitsData)
    {
        $config = [
            'unitsClass' => $unitsData->unitsClass,
            'units' => $this->units,
        ];
        // Normalize the min
        if (!empty($this->min)) {
            $config['value'] = (float)$this->min;
            $baseUnit = new UnitsData($config);
            $this->min = $baseUnit->toUnit($unitsData->units);
        } else {
            $this->min = null;
        }
        // Normalize the max
        if (!empty($this->max)) {
            $config['value'] = (float)$this->max;
            $baseUnit = new UnitsData($config);
            $this->max = $baseUnit->toUnit($unitsData->units);
        } else {
            $this->max = null;
        }
    }
}