nystudio107\retour\controllers\ApiController

Complexity

Total Complexity

3

Size/Duplication

Total Lines	39
Duplicated Lines	0 %

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	actionGetRedirects()	0	5	1
A	beforeAction()	0	7	2

<?php
/**
 * Retour plugin for Craft CMS
 *
 * Retour allows you to intelligently redirect legacy URLs, so that you don't
 * lose SEO value when rebuilding & restructuring a website
 *
 * @link      https://nystudio107.com/

The tag in position 1 should be the @copyright tag

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

use craft\web\Controller;
use nystudio107\retour\Retour;
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   Retour

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

 * @since     3.1.39

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 ApiController extends Controller
{
    // Constants
    // =========================================================================

    // Protected Properties
    // =========================================================================

    /**

Missing short description in doc comment

     * @inheritdoc
     */
    protected array|bool|int $allowAnonymous = [
        'get-redirects',
    ];

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

    /**

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

Missing short description in doc comment

     * @inheritDoc
     */

Missing @return tag in function comment

    public function beforeAction($action): bool
    {
        if (!Retour::$settings->enableApiEndpoint) {
            $this->allowAnonymous = false;
        }

        return parent::beforeAction($action);
    }

    /**

Missing short description in doc comment

     * @param null $siteId

Are you sure the doc-type for parameter $siteId is correct as it would always require null to be passed?

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return Response

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function actionGetRedirects($siteId = null): Response
    {
        $redirects = Retour::$plugin->redirects->getAllStaticRedirects(null, $siteId);

The method getAllStaticRedirects() does not exist on null.

        return $this->asJson($redirects);
    }
}