nystudio107\units\controllers\UnitsController

Complexity

Total Complexity

2

Size/Duplication

Total Lines	39
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	1

2 Methods

Rating	Name	Duplication	Size	Complexity
A	actionAllAvailableUnits()	0	3	1
A	actionAvailableUnits()	0	3	1

<?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\controllers;

use craft\web\Controller;
use nystudio107\units\Units;
use yii\web\Response;

/**

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 UnitsController extends Controller
{
    // Properties
    // =========================================================================

    /**

Missing short description in doc comment

     * @inheritdoc
     */
    protected array|bool|int $allowAnonymous = [
        'all-available-units',
        'available-units',
    ];

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

    /**
     * Return all the available units as JSON
     *
     * @param bool $includeAliases whether to include aliases or not
     *
     * @return Response
     */
    public function actionAllAvailableUnits(bool $includeAliases = false): Response
    {
        return $this->asJson(Units::$variable->allAvailableUnits($includeAliases));
    }

    /**
     * Return the available units for a given AbstractPhysicalQuantity as JSON
     *
     * @param string $unitsClass

Missing parameter comment

     * @param bool $includeAliases whether to include aliases or not

Expected 3 spaces after parameter type; 1 found

     *
     * @return Response
     */
    public function actionAvailableUnits(string $unitsClass, bool $includeAliases = false): Response
    {
        return $this->asJson(Units::$variable->availableUnits($unitsClass, $includeAliases));
    }
}