roaresearch\yii2\roa\controllers\ApiContainerController

Complexity

Total Complexity

6

Size/Duplication

Total Lines	55
Duplicated Lines	0 %

Test Coverage

Coverage

31.25%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	behaviors()	0	3	1
A	actionError()	0	13	3
A	actionIndex()	0	6	1
A	actionGone()	0	6	1

<?php

namespace roaresearch\yii2\roa\controllers;

use Yii;
use yii\{
    helpers\ArrayHelper,
    web\GoneHttpException,
    web\NotFoundHttpException
};

/**
 * Lists all the available versions for an api and handles error responses.
 *
 * @property \roaresearch\yii2\roa\modules\ApiContainer $module
 *
 * @author Angel (Faryshta) Guevara <aguevara@tecnocen.com>
 */
class ApiContainerController extends \yii\rest\Controller
{
    /**
     * @inheritdoc
     */
    public function behaviors()
    {
        return [];
    }

    /**
     * Lists the available versions and their respective stability for the
     * parent module.
     *
     * @return string[]
     */
    public function actionIndex(): array
    {
        return ArrayHelper::map(
            $this->module->versionModules,

It seems like $this->module->versionModules can also be of type object; however, parameter $array of yii\helpers\BaseArrayHelper::map() does only seem to accept array, maybe add an additional type check?

The property versionModules does not exist on roaresearch\yii2\roa\modules\ApiContainer. Since you implemented __get, consider adding a @property annotation.

            'id',
            'factSheet'
        );
    }

    /**
     * Handles the exceptions catched by the system bootstrapping process.
     * @return \Exception
     */
    public function actionError(): \Exception
    {
        if (($exception = Yii::$app->getErrorHandler()->exception) === null) {
            $exception = new NotFoundHttpException(
                Yii::t('yii', 'Page not found.')
            );
        }

        Yii::$app->response->statusCode = isset($exception->statusCode)
            ? $exception->statusCode
            : 500;

        return $exception;
    }

    /**
     * Action shown when a resource is  no longer available.
     *
     * @throws GoneHttpException
     */
    public function actionGone()
    {
        throw new GoneHttpException(
            'The resource you seek is obsolete, visit '
                . $this->module->getSelfLink()
                . ' to get the fact sheets of all available versions.'
        );
    }
}