MetaContainerController::actionMetaSiteVarsContainer() - Code Metrics - Inspection of "Version 3.3.25" - nystudio107/craft-seomatic - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — develop ( 875d99...b451d2 )

by Andrew

created 2020-11-24 20:30 UTC

actionMetaSiteVarsContainer() A

↳ Parent: MetaContainerController

Complexity

Conditions	1
Paths	1

Size

Total Lines	17
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
cc	1
eloc	9
c	0
b	0
f	0
nc	1
nop	3
dl	0
loc	17
ccs	0
cts	15
cp	0
crap	2
rs	9.9666

<?php
/**
 * SEOmatic plugin for Craft CMS 3.x
 *
 * @link      https://nystudio107.com/
 * @copyright Copyright (c) 2017 nystudio107
 * @license   https://nystudio107.com/license

 */

namespace nystudio107\seomatic\controllers;

use nystudio107\seomatic\Seomatic;
use nystudio107\seomatic\helpers\Container as ContainerHelper;
use nystudio107\seomatic\models\MetaJsonLdContainer;
use nystudio107\seomatic\models\MetaLinkContainer;
use nystudio107\seomatic\models\MetaScriptContainer;
use nystudio107\seomatic\models\MetaSiteVars;
use nystudio107\seomatic\models\MetaTitleContainer;
use nystudio107\seomatic\models\MetaTagContainer;

use Craft;
use craft\web\Controller;

use yii\web\Response;
use yii\web\JsonResponseFormatter;

/**
 * @author    nystudio107

 * @package   Seomatic
 * @since     3.0.0
 */
class MetaContainerController extends Controller
{
    // Protected Properties
    // =========================================================================

    /**
     * @inheritdoc
     */
    protected $allowAnonymous = [
        'all-meta-containers',
        'meta-title-container',
        'meta-tag-container',
        'meta-link-container',
        'meta-script-container',
        'meta-json-ld-container',
        'meta-site-vars-container',
    ];

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

    /**

     * @inheritDoc
     */
    public function beforeAction($action)
    {
        if (!Seomatic::$settings->enableMetaContainerEndpoint) {
            $this->allowAnonymous = false;
        }

        return parent::beforeAction($action);
    }

    /**
     * Return all of the containers
     * URI: /actions/seomatic/meta-container/all-meta-containers?uri=/
     *
     * @param string $uri

     * @param int    $siteId

     * @param bool   $asArray

     *
     * @return Response
     */
    public function actionAllMetaContainers(string $uri, int $siteId = null, bool $asArray = false): Response
    {
        $result = ContainerHelper::getContainerArrays(
            [
                MetaTitleContainer::CONTAINER_TYPE,
                MetaTagContainer::CONTAINER_TYPE,
                MetaLinkContainer::CONTAINER_TYPE,
                MetaScriptContainer::CONTAINER_TYPE,
                MetaJsonLdContainer::CONTAINER_TYPE,
                MetaSiteVars::CONTAINER_TYPE,
            ],
            $uri,
            $siteId,
            $asArray
        );
        // use "pretty" output in debug mode
        Craft::$app->response->formatters[Response::FORMAT_JSON] = [
            'class' => JsonResponseFormatter::class,
            'prettyPrint' => YII_DEBUG,
        ];

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

    /**
     * Return the MetaTitleContainer
     * URI: /actions/seomatic/meta-container/meta-title-container?uri=/
     *
     * @param string $uri

     * @param int    $siteId

     * @param bool   $asArray

     *
     * @return Response
     */
    public function actionMetaTitleContainer(string $uri, int $siteId = null, bool $asArray = false): Response
    {
        $result = ContainerHelper::getContainerArrays(
            [
                MetaTitleContainer::CONTAINER_TYPE,
            ],
            $uri,
            $siteId,
            $asArray
        );
        // use "pretty" output in debug mode
        Craft::$app->response->formatters[Response::FORMAT_JSON] = [
            'class' => JsonResponseFormatter::class,
            'prettyPrint' => YII_DEBUG,
        ];

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

    /**
     * Return the MetaTagContainer
     * URI: /actions/seomatic/meta-container/meta-tag-container?uri=/
     *
     * @param string $uri

     * @param int    $siteId

     * @param bool   $asArray

     *
     * @return Response
     */
    public function actionMetaTagContainer(string $uri, int $siteId = null, bool $asArray = false): Response
    {
        $result = ContainerHelper::getContainerArrays(
            [
                MetaTagContainer::CONTAINER_TYPE,
            ],
            $uri,
            $siteId,
            $asArray
        );
        // use "pretty" output in debug mode
        Craft::$app->response->formatters[Response::FORMAT_JSON] = [
            'class' => JsonResponseFormatter::class,
            'prettyPrint' => YII_DEBUG,
        ];

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

    /**
     * Return the MetaLinkContainer
     * URI: /actions/seomatic/meta-container/meta-link-container?uri=/
     *
     * @param string $uri

     * @param int    $siteId

     * @param bool   $asArray

     *
     * @return Response
     */
    public function actionMetaLinkContainer(string $uri, int $siteId = null, bool $asArray = false): Response
    {
        $result = ContainerHelper::getContainerArrays(
            [
                MetaLinkContainer::CONTAINER_TYPE,
            ],
            $uri,
            $siteId,
            $asArray
        );
        // use "pretty" output in debug mode
        Craft::$app->response->formatters[Response::FORMAT_JSON] = [
            'class' => JsonResponseFormatter::class,
            'prettyPrint' => YII_DEBUG,
        ];

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

    /**
     * Return the MetaScriptContainer
     * URI: /actions/seomatic/meta-container/meta-script-container?uri=/
     *
     * @param string $uri

     * @param int    $siteId

     * @param bool   $asArray

     *
     * @return Response
     */
    public function actionMetaScriptContainer(string $uri, int $siteId = null, bool $asArray = false): Response
    {
        $result = ContainerHelper::getContainerArrays(
            [
                MetaScriptContainer::CONTAINER_TYPE,
            ],
            $uri,
            $siteId,
            $asArray
        );
        // use "pretty" output in debug mode
        Craft::$app->response->formatters[Response::FORMAT_JSON] = [
            'class' => JsonResponseFormatter::class,
            'prettyPrint' => YII_DEBUG,
        ];

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

    /**
     * Return the MetaJsonLdContainer
     * URI: /actions/seomatic/meta-container/meta-json-ld-container?uri=/
     *
     * @param string $uri

     * @param int    $siteId

     * @param bool   $asArray

     *
     * @return Response
     */
    public function actionMetaJsonLdContainer(string $uri, int $siteId = null, bool $asArray = false): Response
    {
        $result = ContainerHelper::getContainerArrays(
            [
                MetaJsonLdContainer::CONTAINER_TYPE,
            ],
            $uri,
            $siteId,
            $asArray
        );
        // use "pretty" output in debug mode
        Craft::$app->response->formatters[Response::FORMAT_JSON] = [
            'class' => JsonResponseFormatter::class,
            'prettyPrint' => YII_DEBUG,
        ];

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

    /**
     * Return the MetaSiteVars "container"
     * URI: /actions/seomatic/meta-container/meta-site-vars-container?uri=/
     *
     * @param string $uri

     * @param int    $siteId

     * @param bool   $asArray

     *
     * @return Response
     */
    public function actionMetaSiteVarsContainer(string $uri, int $siteId = null, bool $asArray = false): Response
    {
        $result = ContainerHelper::getContainerArrays(
            [
                MetaSiteVars::CONTAINER_TYPE,
            ],
            $uri,
            $siteId,
            $asArray
        );
        // use "pretty" output in debug mode
        Craft::$app->response->formatters[Response::FORMAT_JSON] = [
            'class' => JsonResponseFormatter::class,
            'prettyPrint' => YII_DEBUG,
        ];

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

}


1			<?php
2			/**
3			* SEOmatic plugin for Craft CMS 3.x
4			*
5			* @link https://nystudio107.com/
6			* @copyright Copyright (c) 2017 nystudio107
7			* @license https://nystudio107.com/license
			0 ignored issues – show Coding Style introduced 2018-08-22 20:26 UTC by Report Bug Copy Issue Report @license tag must contain a URL and a license name Loading history...
8			*/
9
10			namespace nystudio107\seomatic\controllers;
11
12			use nystudio107\seomatic\Seomatic;
13			use nystudio107\seomatic\helpers\Container as ContainerHelper;
14			use nystudio107\seomatic\models\MetaJsonLdContainer;
15			use nystudio107\seomatic\models\MetaLinkContainer;
16			use nystudio107\seomatic\models\MetaScriptContainer;
17			use nystudio107\seomatic\models\MetaSiteVars;
18			use nystudio107\seomatic\models\MetaTitleContainer;
19			use nystudio107\seomatic\models\MetaTagContainer;
20
21			use Craft;
22			use craft\web\Controller;
23
24			use yii\web\Response;
25			use yii\web\JsonResponseFormatter;
26
27			/**
28			* @author nystudio107
			0 ignored issues – show Coding Style introduced 2018-08-22 20:26 UTC by Report Bug Copy Issue Report The tag in position 1 should be the @package tag Loading history... Coding Style introduced 2018-08-22 20:26 UTC by Report Bug Copy Issue Report Content of the @author tag must be in the form "Display Name <[email protected]>" Loading history...
29			* @package Seomatic
30			* @since 3.0.0
31			*/
32			class MetaContainerController extends Controller
33			{
34			// Protected Properties
35			// =========================================================================
36
37			/**
38			* @inheritdoc
39			*/
40			protected $allowAnonymous = [
41			'all-meta-containers',
42			'meta-title-container',
43			'meta-tag-container',
44			'meta-link-container',
45			'meta-script-container',
46			'meta-json-ld-container',
47			'meta-site-vars-container',
48			];
49
50			// Public Methods
51			// =========================================================================
52
53			/**
			0 ignored issues – show Coding Style introduced 2020-05-19 02:38 UTC by Report Bug Copy Issue Report Parameter `$action` should have a doc-comment as per coding-style. Loading history...
54			* @inheritDoc
55			*/
56			public function beforeAction($action)
57			{
58			if (!Seomatic::$settings->enableMetaContainerEndpoint) {
59			$this->allowAnonymous = false;
60			}
61
62			return parent::beforeAction($action);
63			}
64
65			/**
66			* Return all of the containers
67			* URI: /actions/seomatic/meta-container/all-meta-containers?uri=/
68			*
69			* @param string $uri
			0 ignored issues – show Coding Style introduced 2018-08-22 20:26 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
70			* @param int $siteId
			0 ignored issues – show Coding Style introduced 2018-08-22 20:26 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
71			* @param bool $asArray
			0 ignored issues – show Coding Style introduced 2018-08-22 20:26 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
72			*
73			* @return Response
74			*/
75			public function actionAllMetaContainers(string $uri, int $siteId = null, bool $asArray = false): Response
76			{
77			$result = ContainerHelper::getContainerArrays(
78			[
79			MetaTitleContainer::CONTAINER_TYPE,
80			MetaTagContainer::CONTAINER_TYPE,
81			MetaLinkContainer::CONTAINER_TYPE,
82			MetaScriptContainer::CONTAINER_TYPE,
83			MetaJsonLdContainer::CONTAINER_TYPE,
84			MetaSiteVars::CONTAINER_TYPE,
85			],
86			$uri,
87			$siteId,
88			$asArray
89			);
90			// use "pretty" output in debug mode
91			Craft::$app->response->formatters[Response::FORMAT_JSON] = [
92			'class' => JsonResponseFormatter::class,
93			'prettyPrint' => YII_DEBUG,
94			];
95
96			return $this->asJson($result);
97			}
98
99			/**
100			* Return the MetaTitleContainer
101			* URI: /actions/seomatic/meta-container/meta-title-container?uri=/
102			*
103			* @param string $uri
			0 ignored issues – show Coding Style introduced 2018-08-22 20:26 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
104			* @param int $siteId
			0 ignored issues – show Coding Style introduced 2018-08-22 20:26 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
105			* @param bool $asArray
			0 ignored issues – show Coding Style introduced 2018-08-22 20:26 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
106			*
107			* @return Response
108			*/
109			public function actionMetaTitleContainer(string $uri, int $siteId = null, bool $asArray = false): Response
110			{
111			$result = ContainerHelper::getContainerArrays(
112			[
113			MetaTitleContainer::CONTAINER_TYPE,
114			],
115			$uri,
116			$siteId,
117			$asArray
118			);
119			// use "pretty" output in debug mode
120			Craft::$app->response->formatters[Response::FORMAT_JSON] = [
121			'class' => JsonResponseFormatter::class,
122			'prettyPrint' => YII_DEBUG,
123			];
124
125			return $this->asJson($result);
126			}
127
128			/**
129			* Return the MetaTagContainer
130			* URI: /actions/seomatic/meta-container/meta-tag-container?uri=/
131			*
132			* @param string $uri
			0 ignored issues – show Coding Style introduced 2018-08-22 20:26 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
133			* @param int $siteId
			0 ignored issues – show Coding Style introduced 2018-08-22 20:26 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
134			* @param bool $asArray
			0 ignored issues – show Coding Style introduced 2018-08-22 20:26 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
135			*
136			* @return Response
137			*/
138			public function actionMetaTagContainer(string $uri, int $siteId = null, bool $asArray = false): Response
139			{
140			$result = ContainerHelper::getContainerArrays(
141			[
142			MetaTagContainer::CONTAINER_TYPE,
143			],
144			$uri,
145			$siteId,
146			$asArray
147			);
148			// use "pretty" output in debug mode
149			Craft::$app->response->formatters[Response::FORMAT_JSON] = [
150			'class' => JsonResponseFormatter::class,
151			'prettyPrint' => YII_DEBUG,
152			];
153
154			return $this->asJson($result);
155			}
156
157			/**
158			* Return the MetaLinkContainer
159			* URI: /actions/seomatic/meta-container/meta-link-container?uri=/
160			*
161			* @param string $uri
			0 ignored issues – show Coding Style introduced 2018-10-05 15:58 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
162			* @param int $siteId
			0 ignored issues – show Coding Style introduced 2018-10-05 15:58 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
163			* @param bool $asArray
			0 ignored issues – show Coding Style introduced 2018-10-05 15:58 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
164			*
165			* @return Response
166			*/
167			public function actionMetaLinkContainer(string $uri, int $siteId = null, bool $asArray = false): Response
168			{
169			$result = ContainerHelper::getContainerArrays(
170			[
171			MetaLinkContainer::CONTAINER_TYPE,
172			],
173			$uri,
174			$siteId,
175			$asArray
176			);
177			// use "pretty" output in debug mode
178			Craft::$app->response->formatters[Response::FORMAT_JSON] = [
179			'class' => JsonResponseFormatter::class,
180			'prettyPrint' => YII_DEBUG,
181			];
182
183			return $this->asJson($result);
184			}
185
186			/**
187			* Return the MetaScriptContainer
188			* URI: /actions/seomatic/meta-container/meta-script-container?uri=/
189			*
190			* @param string $uri
			0 ignored issues – show Coding Style introduced 2018-10-05 15:58 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
191			* @param int $siteId
			0 ignored issues – show Coding Style introduced 2018-10-05 15:58 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
192			* @param bool $asArray
			0 ignored issues – show Coding Style introduced 2018-10-05 15:58 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
193			*
194			* @return Response
195			*/
196			public function actionMetaScriptContainer(string $uri, int $siteId = null, bool $asArray = false): Response
197			{
198			$result = ContainerHelper::getContainerArrays(
199			[
200			MetaScriptContainer::CONTAINER_TYPE,
201			],
202			$uri,
203			$siteId,
204			$asArray
205			);
206			// use "pretty" output in debug mode
207			Craft::$app->response->formatters[Response::FORMAT_JSON] = [
208			'class' => JsonResponseFormatter::class,
209			'prettyPrint' => YII_DEBUG,
210			];
211
212			return $this->asJson($result);
213			}
214
215			/**
216			* Return the MetaJsonLdContainer
217			* URI: /actions/seomatic/meta-container/meta-json-ld-container?uri=/
218			*
219			* @param string $uri
			0 ignored issues – show Coding Style introduced 2018-10-05 15:58 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
220			* @param int $siteId
			0 ignored issues – show Coding Style introduced 2018-10-05 15:58 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
221			* @param bool $asArray
			0 ignored issues – show Coding Style introduced 2018-10-05 15:58 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
222			*
223			* @return Response
224			*/
225			public function actionMetaJsonLdContainer(string $uri, int $siteId = null, bool $asArray = false): Response
226			{
227			$result = ContainerHelper::getContainerArrays(
228			[
229			MetaJsonLdContainer::CONTAINER_TYPE,
230			],
231			$uri,
232			$siteId,
233			$asArray
234			);
235			// use "pretty" output in debug mode
236			Craft::$app->response->formatters[Response::FORMAT_JSON] = [
237			'class' => JsonResponseFormatter::class,
238			'prettyPrint' => YII_DEBUG,
239			];
240
241			return $this->asJson($result);
242			}
243
244			/**
245			* Return the MetaSiteVars "container"
246			* URI: /actions/seomatic/meta-container/meta-site-vars-container?uri=/
247			*
248			* @param string $uri
			0 ignored issues – show Coding Style introduced 2018-10-05 15:58 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
249			* @param int $siteId
			0 ignored issues – show Coding Style introduced 2020-11-24 20:39 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
250			* @param bool $asArray
			0 ignored issues – show Coding Style introduced 2018-10-05 15:58 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
251			*
252			* @return Response
253			*/
254			public function actionMetaSiteVarsContainer(string $uri, int $siteId = null, bool $asArray = false): Response
255			{
256			$result = ContainerHelper::getContainerArrays(
257			[
258			MetaSiteVars::CONTAINER_TYPE,
259			],
260			$uri,
261			$siteId,
262			$asArray
263			);
264			// use "pretty" output in debug mode
265			Craft::$app->response->formatters[Response::FORMAT_JSON] = [
266			'class' => JsonResponseFormatter::class,
267			'prettyPrint' => YII_DEBUG,
268			];
269
270			return $this->asJson($result);
271			}
272
273			}
274

nystudio107 / craft-seomatic

Push — develop ( 875d99...b451d2 )

actionMetaSiteVarsContainer() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like