PageProvider::__construct() - Code Metrics - Inspection of "Implement page translation fallback" - OpencachingDeutschland/oc-server3 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — development (#718)

by Nick

created 2018-05-27 17:25 UTC

PageProvider::__construct() A

↳ Parent: PageProvider

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	4
nc	1
nop	3
dl	0
loc	6
rs	9.4285
c	0
b	0
f	0

<?php

namespace Oc\Page;

use Oc\GlobalContext\GlobalContext;
use Oc\Page\Exception\PageNotFoundException;
use Oc\Page\Exception\PageTranslationNotFoundException;
use Oc\Page\Persistence\BlockService;
use Oc\Page\Persistence\PageEntity;
use Oc\Page\Persistence\BlockEntity;
use Oc\Page\Persistence\PageService;

/**
 * Class PageProvider
 */
class PageProvider
{
    /**
     * @var PageService
     */
    private $pageService;

    /**
     * @var BlockService
     */
    private $blockService;

    /**
     * @var GlobalContext
     */
    private $globalContext;

    /**
     * PageProvider constructor.
     *
     * @param PageService $pageService
     * @param BlockService $blockService
     * @param GlobalContext $globalContext
     */
    public function __construct(PageService $pageService, BlockService $blockService, GlobalContext $globalContext)
    {
        $this->pageService = $pageService;
        $this->blockService = $blockService;
        $this->globalContext = $globalContext;
    }

    /**
     * Fetches the page by the slug.
     *
     * Page blocks are translated in the user language, if the translation does not exist the default language is used.
     * If the default language is also not available a exception is thrown.
     *
     * @param string $slug
     *
     * @return PageStruct
     *
     * @throws PageNotFoundException Thrown if the page could not be found
     * @throws PageTranslationNotFoundException Thrown if no translation of the page could be found
     */
    public function getPageBySlug($slug)
    {
        $slug = strtolower($slug);

        $page = $this->getPage($slug);

        $preferredLocale = $this->globalContext->getLocale();
        $defaultLocale = $this->globalContext->getDefaultLocale();

        $pageBlocks = $this->getPageBlocks(
            $page,
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
            $preferredLocale
        );

        $isFallback = false;

        $sameLocale = $preferredLocale === $defaultLocale;

        if(!$sameLocale && count($pageBlocks) === 0) {
            //Fetch fallback if blocks are empty
            $pageBlocks = $this->getPageBlocks(
                $page,
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
                $defaultLocale
            );

            $isFallback = true;
        }

        if (count($pageBlocks) === 0) {
            throw new PageTranslationNotFoundException('Translation for page "' . $slug . '" could not be found"');
        }

        return new PageStruct(
            $page,
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
            $pageBlocks,
            $preferredLocale,
            $defaultLocale,
            $isFallback
        );
    }

    /**
     * Fetches all page blocks by the given page and locale.
     *
     * @param PageEntity $page
     * @param string $locale
     *
     * @return BlockEntity[]
     */
    private function getPageBlocks(PageEntity $page, $locale)
    {
        return $this->blockService->fetchBy([
            'page_id' => $page->id,
            'locale' => $locale,
            'active' => 1,
        ]);
    }

    /**
     * Fetches the page by the given slug.
     *
     * @param string $slug
     *
     * @return null|PageEntity
     *
     * @throws PageNotFoundException Thrown if the page could not be found
     */
    private function getPage($slug)
    {
        $page = $this->pageService->fetchOneBy([
            'slug' => $slug,
            'active' => 1,
        ]);

        if (!$page) {
            throw new PageNotFoundException('The page "' . $slug . '" could not be found"');
        }

        return $page;
}
}


1			<?php
2
3			namespace Oc\Page;
4
5			use Oc\GlobalContext\GlobalContext;
6			use Oc\Page\Exception\PageNotFoundException;
7			use Oc\Page\Exception\PageTranslationNotFoundException;
8			use Oc\Page\Persistence\BlockService;
9			use Oc\Page\Persistence\PageEntity;
10			use Oc\Page\Persistence\BlockEntity;
11			use Oc\Page\Persistence\PageService;
12
13			/**
14			* Class PageProvider
15			*/
16			class PageProvider
17			{
18			/**
19			* @var PageService
20			*/
21			private $pageService;
22
23			/**
24			* @var BlockService
25			*/
26			private $blockService;
27
28			/**
29			* @var GlobalContext
30			*/
31			private $globalContext;
32
33			/**
34			* PageProvider constructor.
35			*
36			* @param PageService $pageService
37			* @param BlockService $blockService
38			* @param GlobalContext $globalContext
39			*/
40			public function __construct(PageService $pageService, BlockService $blockService, GlobalContext $globalContext)
41			{
42			$this->pageService = $pageService;
43			$this->blockService = $blockService;
44			$this->globalContext = $globalContext;
45			}
46
47			/**
48			* Fetches the page by the slug.
49			*
50			* Page blocks are translated in the user language, if the translation does not exist the default language is used.
51			* If the default language is also not available a exception is thrown.
52			*
53			* @param string $slug
54			*
55			* @return PageStruct
56			*
57			* @throws PageNotFoundException Thrown if the page could not be found
58			* @throws PageTranslationNotFoundException Thrown if no translation of the page could be found
59			*/
60			public function getPageBySlug($slug)
61			{
62			$slug = strtolower($slug);
63
64			$page = $this->getPage($slug);
65
66			$preferredLocale = $this->globalContext->getLocale();
67			$defaultLocale = $this->globalContext->getDefaultLocale();
68
69			$pageBlocks = $this->getPageBlocks(
70			$page,
			0 ignored issues – show Bug introduced 2018-05-27 17:47 UTC by Report Bug Copy Issue Report It seems like `$page` defined by `$this->getPage($slug)` on line `64` can be `null`; however, `Oc\Page\PageProvider::getPageBlocks()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
71			$preferredLocale
72			);
73
74			$isFallback = false;
75
76			$sameLocale = $preferredLocale === $defaultLocale;
77
78			if(!$sameLocale && count($pageBlocks) === 0) {
79			//Fetch fallback if blocks are empty
80			$pageBlocks = $this->getPageBlocks(
81			$page,
			0 ignored issues – show Bug introduced 2018-05-27 17:47 UTC by Report Bug Copy Issue Report It seems like `$page` defined by `$this->getPage($slug)` on line `64` can be `null`; however, `Oc\Page\PageProvider::getPageBlocks()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
82			$defaultLocale
83			);
84
85			$isFallback = true;
86			}
87
88			if (count($pageBlocks) === 0) {
89			throw new PageTranslationNotFoundException('Translation for page "' . $slug . '" could not be found"');
90			}
91
92			return new PageStruct(
93			$page,
			0 ignored issues – show Bug introduced 2018-05-27 17:47 UTC by Report Bug Copy Issue Report It seems like `$page` defined by `$this->getPage($slug)` on line `64` can be `null`; however, `Oc\Page\PageStruct::__construct()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
94			$pageBlocks,
95			$preferredLocale,
96			$defaultLocale,
97			$isFallback
98			);
99			}
100
101			/**
102			* Fetches all page blocks by the given page and locale.
103			*
104			* @param PageEntity $page
105			* @param string $locale
106			*
107			* @return BlockEntity[]
108			*/
109			private function getPageBlocks(PageEntity $page, $locale)
110			{
111			return $this->blockService->fetchBy([
112			'page_id' => $page->id,
113			'locale' => $locale,
114			'active' => 1,
115			]);
116			}
117
118			/**
119			* Fetches the page by the given slug.
120			*
121			* @param string $slug
122			*
123			* @return null\|PageEntity
124			*
125			* @throws PageNotFoundException Thrown if the page could not be found
126			*/
127			private function getPage($slug)
128			{
129			$page = $this->pageService->fetchOneBy([
130			'slug' => $slug,
131			'active' => 1,
132			]);
133
134			if (!$page) {
135			throw new PageNotFoundException('The page "' . $slug . '" could not be found"');
136			}
137
138			return $page;
139			}
140			}
141

OpencachingDeutschland / oc-server3

Pull Request — development (#718)

PageProvider::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like