Index::index() - Code Metrics - Inspection of "Minor constant refactoring" - abterphp/website - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 3e1455...cd0e92 )

by Peter

created 2019-07-23 05:38 UTC

Index::index() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	1
c	0
b	0
f	0
nc	1
nop	0
dl	0
loc	3
rs	10

<?php

declare(strict_types=1);

namespace AbterPhp\Website\Http\Controllers\Website;

use AbterPhp\Framework\Assets\AssetManager;
use AbterPhp\Framework\Http\Controllers\ControllerAbstract;
use AbterPhp\Framework\Session\FlashService;
use AbterPhp\Framework\Template\Engine;
use AbterPhp\Website\Constant\Routes;
use AbterPhp\Website\Domain\Entities\Page\Assets;
use AbterPhp\Website\Domain\Entities\Page\Meta;
use AbterPhp\Website\Domain\Entities\PageLayout\Assets as LayoutAssets;
use AbterPhp\Website\Orm\PageRepo;
use Opulence\Http\Responses\Response;
use Opulence\Http\Responses\ResponseHeaders;
use Opulence\Orm\OrmException;
use Opulence\Routing\Urls\UrlGenerator;

class Index extends ControllerAbstract
{
    /** @var Engine */
    protected $templateEngine;

    /** @var PageRepo */
    protected $pageRepo;

    /** @var UrlGenerator */
    protected $urlGenerator;

    /** @var AssetManager */
    protected $assetManager;

    /** @var string|null */
    protected $baseUrl;

    /** @var string */
    protected $siteTitle;

    /**
     * Index constructor.
     *
     * @param FlashService $flashService
     * @param Engine       $templateEngine
     * @param PageRepo     $pageRepo
     * @param UrlGenerator $urlGenerator
     * @param AssetManager $assetManager
     * @param string|null  $baseUrl
     * @param string       $siteTitle
     */
    public function __construct(
        FlashService $flashService,
        Engine $templateEngine,
        PageRepo $pageRepo,
        UrlGenerator $urlGenerator,
        AssetManager $assetManager,
        ?string $baseUrl,
        string $siteTitle
    ) {
        $this->templateEngine = $templateEngine;
        $this->pageRepo       = $pageRepo;
        $this->urlGenerator   = $urlGenerator;
        $this->assetManager   = $assetManager;

        $this->baseUrl   = $baseUrl;
        $this->siteTitle = $siteTitle;

        parent::__construct($flashService);
    }

    /**
     * Shows the homepage
     *
     * @return Response The response
     */
    public function index(): Response
    {
        return $this->fallback('index');
    }

    /**
     * Shows the homepage
     *
     * @return Response The response
     */
    public function fallback(string $identifier): Response
    {
        $this->view = $this->viewFactory->createView('contents/frontend/page');

        try {
            $page = $this->pageRepo->getWithLayout($identifier);
        } catch (OrmException $exc) {
            return $this->notFound();
        }

        $vars      = ['title' => $page->getTitle()];
        $templates = [
            'body'   => $page->getBody(),
            'layout' => $page->getLayout(),
        ];

        $body = $this->templateEngine->run('page', $page->getIdentifier(), $templates, $vars);

        $pageUrl     = $this->urlGenerator->createFromName(Routes::ROUTE_FALLBACK, $identifier);
        $homepageUrl = $this->urlGenerator->createFromName(Routes::ROUTE_INDEX);

        $this->view->setVar('body', $body);
        $this->view->setVar('siteTitle', $this->siteTitle);
        $this->view->setVar('pageUrl', $pageUrl);
        $this->view->setVar('homepageUrl', $homepageUrl);

        $this->setMetaVars($page->getMeta());
        $this->setAssetsVars($page->getAssets());

        return $this->createResponse($page->getTitle());
    }

    /**
     * @param Meta $meta
     */
    protected function setMetaVars(Meta $meta)
    {
        $this->view->setVar('metaDescription', $meta->getDescription());
        $this->view->setVar('metaKeywords', explode(',', $meta->getKeywords()));
        $this->view->setVar('metaCopyright', $meta->getCopyright());
        $this->view->setVar('metaAuthor', $meta->getAuthor());
        $this->view->setVar('metaRobots', $meta->getRobots());
        $this->view->setVar('metaOGDescription', $meta->getOGDescription());
        $this->view->setVar('metaOGTitle', $meta->getOGTitle());
        $this->view->setVar('metaOGImage', $meta->getOGImage());
    }

    /**
     * @param Assets|null $assets
     */
    protected function setAssetsVars(?Assets $assets)
    {
        if ($assets === null) {
            return;
        }

        $origHeader = $this->view->hasVar('header') ? (string)$this->view->getVar('header') : '';
        $origFooter = $this->view->hasVar('footer') ? (string)$this->view->getVar('footer') : '';

        $this->view->setVar('header', $origHeader . $assets->getHeader());
        $this->view->setVar('footer', $origFooter . $assets->getFooter());
        $this->view->setVar('page', $assets->getKey());

        $key = $assets->getKey();
        foreach ($assets->getJsFiles() as $jsFile) {
            $this->assetManager->addJs($key, $jsFile);
        }
        foreach ($assets->getCssFiles() as $cssFile) {
            $this->assetManager->addCss($key, $cssFile);
        }

        $this->setLayoutAssetsVars($assets->getLayoutAssets());
    }

    /**
     * @param LayoutAssets|null $assets
     */
    protected function setLayoutAssetsVars(?LayoutAssets $assets)
    {
        if ($assets === null) {
            return;
        }

        $origHeader = $this->view->hasVar('header') ? (string)$this->view->getVar('header') : '';
        $origFooter = $this->view->hasVar('footer') ? (string)$this->view->getVar('footer') : '';

        $this->view->setVar('header', $origHeader . $assets->getHeader());
        $this->view->setVar('footer', $origFooter . $assets->getFooter());
        $this->view->setVar('layout', $assets->getKey());

        $key = $assets->getKey();
        foreach ($assets->getJsFiles() as $jsFile) {
            $this->assetManager->addJs($key, $jsFile);
        }
        foreach ($assets->getCssFiles() as $cssFile) {
            $this->assetManager->addCss($key, $cssFile);
        }
    }

    /**
     * @param string $route
     *
     * @return string
     * @throws \Opulence\Routing\Urls\URLException
     */
    protected function getCanonicalUrl(string $route): string
    {
        $path = $this->urlGenerator->createFromName($route);

        return $this->baseUrl . ltrim($path, '/');
    }

    /**
     * @return string
     */
    protected function getBaseUrl(): string
    {
        if ($this->baseUrl === null) {
            $this->baseUrl = sprintf(
                '%s://%s/',
                $this->request->getServer()->get('REQUEST_SCHEME'),
                $this->request->getServer()->get('SERVER_NAME')
            );
        }

        return $this->baseUrl;
    }

    /**
     * 404 page
     *
     * @return Response The response
     */
    protected function notFound(): Response
    {
        $this->view = $this->viewFactory->createView('contents/frontend/404');

        $response = $this->createResponse('404 Page not Found');
        $response->setStatusCode(ResponseHeaders::HTTP_NOT_FOUND);

        return $response;
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace AbterPhp\Website\Http\Controllers\Website;
6
7			use AbterPhp\Framework\Assets\AssetManager;
8			use AbterPhp\Framework\Http\Controllers\ControllerAbstract;
9			use AbterPhp\Framework\Session\FlashService;
10			use AbterPhp\Framework\Template\Engine;
11			use AbterPhp\Website\Constant\Routes;
12			use AbterPhp\Website\Domain\Entities\Page\Assets;
13			use AbterPhp\Website\Domain\Entities\Page\Meta;
14			use AbterPhp\Website\Domain\Entities\PageLayout\Assets as LayoutAssets;
15			use AbterPhp\Website\Orm\PageRepo;
16			use Opulence\Http\Responses\Response;
17			use Opulence\Http\Responses\ResponseHeaders;
18			use Opulence\Orm\OrmException;
19			use Opulence\Routing\Urls\UrlGenerator;
20
21			class Index extends ControllerAbstract
22			{
23			/** @var Engine */
24			protected $templateEngine;
25
26			/** @var PageRepo */
27			protected $pageRepo;
28
29			/** @var UrlGenerator */
30			protected $urlGenerator;
31
32			/** @var AssetManager */
33			protected $assetManager;
34
35			/** @var string\|null */
36			protected $baseUrl;
37
38			/** @var string */
39			protected $siteTitle;
40
41			/**
42			* Index constructor.
43			*
44			* @param FlashService $flashService
45			* @param Engine $templateEngine
46			* @param PageRepo $pageRepo
47			* @param UrlGenerator $urlGenerator
48			* @param AssetManager $assetManager
49			* @param string\|null $baseUrl
50			* @param string $siteTitle
51			*/
52			public function __construct(
53			FlashService $flashService,
54			Engine $templateEngine,
55			PageRepo $pageRepo,
56			UrlGenerator $urlGenerator,
57			AssetManager $assetManager,
58			?string $baseUrl,
59			string $siteTitle
60			) {
61			$this->templateEngine = $templateEngine;
62			$this->pageRepo = $pageRepo;
63			$this->urlGenerator = $urlGenerator;
64			$this->assetManager = $assetManager;
65
66			$this->baseUrl = $baseUrl;
67			$this->siteTitle = $siteTitle;
68
69			parent::__construct($flashService);
70			}
71
72			/**
73			* Shows the homepage
74			*
75			* @return Response The response
76			*/
77			public function index(): Response
78			{
79			return $this->fallback('index');
80			}
81
82			/**
83			* Shows the homepage
84			*
85			* @return Response The response
86			*/
87			public function fallback(string $identifier): Response
88			{
89			$this->view = $this->viewFactory->createView('contents/frontend/page');
90
91			try {
92			$page = $this->pageRepo->getWithLayout($identifier);
93			} catch (OrmException $exc) {
94			return $this->notFound();
95			}
96
97			$vars = ['title' => $page->getTitle()];
98			$templates = [
99			'body' => $page->getBody(),
100			'layout' => $page->getLayout(),
101			];
102
103			$body = $this->templateEngine->run('page', $page->getIdentifier(), $templates, $vars);
104
105			$pageUrl = $this->urlGenerator->createFromName(Routes::ROUTE_FALLBACK, $identifier);
106			$homepageUrl = $this->urlGenerator->createFromName(Routes::ROUTE_INDEX);
107
108			$this->view->setVar('body', $body);
109			$this->view->setVar('siteTitle', $this->siteTitle);
110			$this->view->setVar('pageUrl', $pageUrl);
111			$this->view->setVar('homepageUrl', $homepageUrl);
112
113			$this->setMetaVars($page->getMeta());
114			$this->setAssetsVars($page->getAssets());
115
116			return $this->createResponse($page->getTitle());
117			}
118
119			/**
120			* @param Meta $meta
121			*/
122			protected function setMetaVars(Meta $meta)
123			{
124			$this->view->setVar('metaDescription', $meta->getDescription());
125			$this->view->setVar('metaKeywords', explode(',', $meta->getKeywords()));
126			$this->view->setVar('metaCopyright', $meta->getCopyright());
127			$this->view->setVar('metaAuthor', $meta->getAuthor());
128			$this->view->setVar('metaRobots', $meta->getRobots());
129			$this->view->setVar('metaOGDescription', $meta->getOGDescription());
130			$this->view->setVar('metaOGTitle', $meta->getOGTitle());
131			$this->view->setVar('metaOGImage', $meta->getOGImage());
132			}
133
134			/**
135			* @param Assets\|null $assets
136			*/
137			protected function setAssetsVars(?Assets $assets)
138			{
139			if ($assets === null) {
140			return;
141			}
142
143			$origHeader = $this->view->hasVar('header') ? (string)$this->view->getVar('header') : '';
144			$origFooter = $this->view->hasVar('footer') ? (string)$this->view->getVar('footer') : '';
145
146			$this->view->setVar('header', $origHeader . $assets->getHeader());
147			$this->view->setVar('footer', $origFooter . $assets->getFooter());
148			$this->view->setVar('page', $assets->getKey());
149
150			$key = $assets->getKey();
151			foreach ($assets->getJsFiles() as $jsFile) {
152			$this->assetManager->addJs($key, $jsFile);
153			}
154			foreach ($assets->getCssFiles() as $cssFile) {
155			$this->assetManager->addCss($key, $cssFile);
156			}
157
158			$this->setLayoutAssetsVars($assets->getLayoutAssets());
159			}
160
161			/**
162			* @param LayoutAssets\|null $assets
163			*/
164			protected function setLayoutAssetsVars(?LayoutAssets $assets)
165			{
166			if ($assets === null) {
167			return;
168			}
169
170			$origHeader = $this->view->hasVar('header') ? (string)$this->view->getVar('header') : '';
171			$origFooter = $this->view->hasVar('footer') ? (string)$this->view->getVar('footer') : '';
172
173			$this->view->setVar('header', $origHeader . $assets->getHeader());
174			$this->view->setVar('footer', $origFooter . $assets->getFooter());
175			$this->view->setVar('layout', $assets->getKey());
176
177			$key = $assets->getKey();
178			foreach ($assets->getJsFiles() as $jsFile) {
179			$this->assetManager->addJs($key, $jsFile);
180			}
181			foreach ($assets->getCssFiles() as $cssFile) {
182			$this->assetManager->addCss($key, $cssFile);
183			}
184			}
185
186			/**
187			* @param string $route
188			*
189			* @return string
190			* @throws \Opulence\Routing\Urls\URLException
191			*/
192			protected function getCanonicalUrl(string $route): string
193			{
194			$path = $this->urlGenerator->createFromName($route);
195
196			return $this->baseUrl . ltrim($path, '/');
197			}
198
199			/**
200			* @return string
201			*/
202			protected function getBaseUrl(): string
203			{
204			if ($this->baseUrl === null) {
205			$this->baseUrl = sprintf(
206			'%s://%s/',
207			$this->request->getServer()->get('REQUEST_SCHEME'),
208			$this->request->getServer()->get('SERVER_NAME')
209			);
210			}
211
212			return $this->baseUrl;
213			}
214
215			/**
216			* 404 page
217			*
218			* @return Response The response
219			*/
220			protected function notFound(): Response
221			{
222			$this->view = $this->viewFactory->createView('contents/frontend/404');
223
224			$response = $this->createResponse('404 Page not Found');
225			$response->setStatusCode(ResponseHeaders::HTTP_NOT_FOUND);
226
227			return $response;
228			}
229			}
230

abterphp / website

Push — master ( 3e1455...cd0e92 )

Index::index() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like