ApiContainer::getVersionModules() - Code Metrics - Inspection of "[WIP] Psr12 (#2)" - ROAResearch/yii2-roa - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 6db6da...5370d9 )

by Angel

created 2019-11-28 17:41 UTC

ApiContainer::getVersionModules() A

↳ Parent: ApiContainer

Complexity

Conditions	3
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	12
rs	9.8666
c	0
b	0
f	0
cc	3
nc	3
nop	0

<?php

namespace roaresearch\yii2\roa\modules;

use roaresearch\yii2\oauth2server\filters\auth\CompositeAuth;
use roaresearch\yii2\oauth2server\Module as OAuth2Module;
use roaresearch\yii2\roa\{
    controllers\ApiContainerController,
    urlRules\Composite as CompositeUrlRule,
    urlRules\Modular as ModularUrlRule,
    urlRules\UrlRuleCreator
};
use Yii;
use yii\{
    base\BootstrapInterface,
    base\InvalidArgumentException,
    base\Module,
    filters\ContentNegotiator,
    helpers\Url,
    web\Response,
    web\UrlNormalizer
};

/**
 * @author Angel (Faryshta) Guevara <[email protected]>
 *
 * @var OAuth2Module $oauth2Module
 */
class ApiContainer extends Module implements UrlRuleCreator, BootstrapInterface
{
    /**
     * @var string
     */
    public $identityClass;

    /**
     * @var string
     */
    public $versionUrlRuleClass = ModularUrlRule::class;

    /**
     * @var string
     */
    public $containerUrlRuleClass = ModularUrlRule::class;

    /**
     * @inheritdoc
     */
    public $defaultRoute = 'index';

    /**
     * @inheritdoc
     */
    public $controllerMap = ['index' => ApiContainerController::class];

    /**
     * @var array
     */
    public $versions = [];

    /**
     * @var string
     */
    public $errorAction;

    /**
     * @var string the module id for the oauth2 server module.
     */
    public $oauth2ModuleId = 'oauth2';

    /**
     * @var array default OAuth2Module configuration.
     */
    private $oauth2Module = [
        'class' => OAuth2Module::class,
        'tokenParamName' => 'accessToken',
        'tokenAccessLifetime' => 3600 * 24,
        'storageMap' => [
        ],
        'grantTypes' => [
            'user_credentials' => [
                'class' => \OAuth2\GrantType\UserCredentials::class,
            ],
            'refresh_token' => [
                'class' => \OAuth2\GrantType\RefreshToken::class,
                'always_issue_new_refresh_token' => true
            ],
        ],
    ];

    /**
     * @inheritdoc
     */
    public function behaviors()
    {
        return [
            'contentNegotiator' => [
                'class' => ContentNegotiator::class,
                'formats' => [
                    'application/json' => Response::FORMAT_JSON,
                    'application/xml' => Response::FORMAT_XML,
                ],
            ],
            'authenticator' => [
                'class' => CompositeAuth::class,
                'oauth2Module' => $this->getUniqueId() . '/'
                    . $this->oauth2ModuleId,
                'except' => [
                    'oauth2/*', // the oauth2 module
                    'index/*', // controller that return this module info
                    '*/options', // all OPTIONS actions for CORS preflight
                ],
            ],
        ];
    }

    /**
     * @var array module
     */
    public function setOauth2Module($module)
    {
        if (is_array($module)) {
            $this->setModule($this->oauth2ModuleId, array_merge(
                $this->oauth2Module,
                ['storageMap' => ['user_credentials' => $this->identityClass]],
                $module
            ));
        } elseif (!$module instanceof OAuth2Module) {
            $this->setModule($this->oauth2ModuleId, $module);
        } else {
            throw new InvalidArgumentException(
                static::class
                    . '::$oauth2Module must be an array or instance of '
                    . OAuth2Module::class
            );
        }
    }

    /**
     * @return OAuth2Module
     */
    public function getOauth2Module(): OAuth2Module
    {
        if (!$this->hasModule($this->oauth2ModuleId)) {
            $this->oauth2Module['storageMap']['user_credentials']
                = $this->identityClass;
            $this->setModule($this->oauth2ModuleId, $this->oauth2Module);
        }

        return $this->getModule($this->oauth2ModuleId);
    }

    /**
     * @inheritdoc
     */
    public function bootstrap($app)
    {
        $this->getOauth2Module()->bootstrap($app);
        if (empty($this->errorAction)) {
            $this->errorAction = $this->uniqueId . '/index/error';
        }
        $app->urlManager->addRules([[
            'class' => $this->containerUrlRuleClass,
            'moduleId' => $this->uniqueId,
            'normalizer' => [
                'action' => UrlNormalizer::ACTION_REDIRECT_PERMANENT,
            ],
        ]]);
    }

    /**
     * @return ApiVersion[] return all the versions attached to the container
     * indexed by their respective id.
     */
    public function getVersionModules(): array
    {
        $versions = [];
        foreach ($this->versions as $route => $config) {
            if (!$this->hasModule($route)) {
                $this->setModule($route, $config);
            }
            $versions[$route] = $this->getModule($route);
        }

        return $versions;
    }

    /**
     * @return \yii\web\UrlRuleInterface[]

     */
    protected function defaultUrlRules()
    {
        return [
            Yii::createObject([
                'class' => \yii\web\UrlRule::class,
                'pattern' => $this->getUniqueId(),
                'route' => $this->getUniqueId(),
            ]),
        ];
    }

    /**
     * @inheritdoc
     */
    public function createUrlRules(CompositeUrlRule $urlRule): array
    {
        // change the error handler and identityClass
        Yii::$app->errorHandler->errorAction = $this->errorAction;
        Yii::$app->user->identityClass = $this->identityClass;

        $rules = $this->defaultUrlRules();
        $auth = $this->getBehavior('authenticator');

        foreach ($this->versions as $route => $config) {
            $auth->except[] = $route . '/index/*';
            $this->setModule($route, $config);
            $rules[] = Yii::createObject([
                'class' => $this->versionUrlRuleClass,
                'moduleId' => "{$this->uniqueId}/$route",
            ]);
        }

        return $rules;
    }

    /**
     * @return string HTTP Url linking to this module
     */
    public function getSelfLink(): string
    {
        return Url::to(['//' . $this->getUniqueId()]);
    }
}


1			<?php
2
3			namespace roaresearch\yii2\roa\modules;
4
5			use roaresearch\yii2\oauth2server\filters\auth\CompositeAuth;
6			use roaresearch\yii2\oauth2server\Module as OAuth2Module;
7			use roaresearch\yii2\roa\{
8			controllers\ApiContainerController,
9			urlRules\Composite as CompositeUrlRule,
10			urlRules\Modular as ModularUrlRule,
11			urlRules\UrlRuleCreator
12			};
13			use Yii;
14			use yii\{
15			base\BootstrapInterface,
16			base\InvalidArgumentException,
17			base\Module,
18			filters\ContentNegotiator,
19			helpers\Url,
20			web\Response,
21			web\UrlNormalizer
22			};
23
24			/**
25			* @author Angel (Faryshta) Guevara <[email protected]>
26			*
27			* @var OAuth2Module $oauth2Module
28			*/
29			class ApiContainer extends Module implements UrlRuleCreator, BootstrapInterface
30			{
31			/**
32			* @var string
33			*/
34			public $identityClass;
35
36			/**
37			* @var string
38			*/
39			public $versionUrlRuleClass = ModularUrlRule::class;
40
41			/**
42			* @var string
43			*/
44			public $containerUrlRuleClass = ModularUrlRule::class;
45
46			/**
47			* @inheritdoc
48			*/
49			public $defaultRoute = 'index';
50
51			/**
52			* @inheritdoc
53			*/
54			public $controllerMap = ['index' => ApiContainerController::class];
55
56			/**
57			* @var array
58			*/
59			public $versions = [];
60
61			/**
62			* @var string
63			*/
64			public $errorAction;
65
66			/**
67			* @var string the module id for the oauth2 server module.
68			*/
69			public $oauth2ModuleId = 'oauth2';
70
71			/**
72			* @var array default OAuth2Module configuration.
73			*/
74			private $oauth2Module = [
75			'class' => OAuth2Module::class,
76			'tokenParamName' => 'accessToken',
77			'tokenAccessLifetime' => 3600 * 24,
78			'storageMap' => [
79			],
80			'grantTypes' => [
81			'user_credentials' => [
82			'class' => \OAuth2\GrantType\UserCredentials::class,
83			],
84			'refresh_token' => [
85			'class' => \OAuth2\GrantType\RefreshToken::class,
86			'always_issue_new_refresh_token' => true
87			],
88			],
89			];
90
91			/**
92			* @inheritdoc
93			*/
94			public function behaviors()
95			{
96			return [
97			'contentNegotiator' => [
98			'class' => ContentNegotiator::class,
99			'formats' => [
100			'application/json' => Response::FORMAT_JSON,
101			'application/xml' => Response::FORMAT_XML,
102			],
103			],
104			'authenticator' => [
105			'class' => CompositeAuth::class,
106			'oauth2Module' => $this->getUniqueId() . '/'
107			. $this->oauth2ModuleId,
108			'except' => [
109			'oauth2/*', // the oauth2 module
110			'index/*', // controller that return this module info
111			'*/options', // all OPTIONS actions for CORS preflight
112			],
113			],
114			];
115			}
116
117			/**
118			* @var array module
119			*/
120			public function setOauth2Module($module)
121			{
122			if (is_array($module)) {
123			$this->setModule($this->oauth2ModuleId, array_merge(
124			$this->oauth2Module,
125			['storageMap' => ['user_credentials' => $this->identityClass]],
126			$module
127			));
128			} elseif (!$module instanceof OAuth2Module) {
129			$this->setModule($this->oauth2ModuleId, $module);
130			} else {
131			throw new InvalidArgumentException(
132			static::class
133			. '::$oauth2Module must be an array or instance of '
134			. OAuth2Module::class
135			);
136			}
137			}
138
139			/**
140			* @return OAuth2Module
141			*/
142			public function getOauth2Module(): OAuth2Module
143			{
144			if (!$this->hasModule($this->oauth2ModuleId)) {
145			$this->oauth2Module['storageMap']['user_credentials']
146			= $this->identityClass;
147			$this->setModule($this->oauth2ModuleId, $this->oauth2Module);
148			}
149
150			return $this->getModule($this->oauth2ModuleId);
151			}
152
153			/**
154			* @inheritdoc
155			*/
156			public function bootstrap($app)
157			{
158			$this->getOauth2Module()->bootstrap($app);
159			if (empty($this->errorAction)) {
160			$this->errorAction = $this->uniqueId . '/index/error';
161			}
162			$app->urlManager->addRules([[
163			'class' => $this->containerUrlRuleClass,
164			'moduleId' => $this->uniqueId,
165			'normalizer' => [
166			'action' => UrlNormalizer::ACTION_REDIRECT_PERMANENT,
167			],
168			]]);
169			}
170
171			/**
172			* @return ApiVersion[] return all the versions attached to the container
173			* indexed by their respective id.
174			*/
175			public function getVersionModules(): array
176			{
177			$versions = [];
178			foreach ($this->versions as $route => $config) {
179			if (!$this->hasModule($route)) {
180			$this->setModule($route, $config);
181			}
182			$versions[$route] = $this->getModule($route);
183			}
184
185			return $versions;
186			}
187
188			/**
189			* @return \yii\web\UrlRuleInterface[]
			0 ignored issues – show Documentation introduced 2019-11-09 03:27 UTC by Report Bug Copy Issue Report Should the return type not be `object[]`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
190			*/
191			protected function defaultUrlRules()
192			{
193			return [
194			Yii::createObject([
195			'class' => \yii\web\UrlRule::class,
196			'pattern' => $this->getUniqueId(),
197			'route' => $this->getUniqueId(),
198			]),
199			];
200			}
201
202			/**
203			* @inheritdoc
204			*/
205			public function createUrlRules(CompositeUrlRule $urlRule): array
206			{
207			// change the error handler and identityClass
208			Yii::$app->errorHandler->errorAction = $this->errorAction;
209			Yii::$app->user->identityClass = $this->identityClass;
210
211			$rules = $this->defaultUrlRules();
212			$auth = $this->getBehavior('authenticator');
213
214			foreach ($this->versions as $route => $config) {
215			$auth->except[] = $route . '/index/*';
216			$this->setModule($route, $config);
217			$rules[] = Yii::createObject([
218			'class' => $this->versionUrlRuleClass,
219			'moduleId' => "{$this->uniqueId}/$route",
220			]);
221			}
222
223			return $rules;
224			}
225
226			/**
227			* @return string HTTP Url linking to this module
228			*/
229			public function getSelfLink(): string
230			{
231			return Url::to(['//' . $this->getUniqueId()]);
232			}
233			}
234

ROAResearch / yii2-roa

Push — master ( 6db6da...5370d9 )

ApiContainer::getVersionModules() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like