Site::getOutputProperty() - Code Metrics - Inspection of "Merge branch 'master' into nested-sections" - Cecilapp/Cecil - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — nested-sections ( 2d40b2...7dbf34 )

by Arnaud

created 2024-02-12 13:46 UTC

Site::getOutputProperty() A

↳ Parent: Site

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	1	Features	0

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

<?php

declare(strict_types=1);

/*
 * This file is part of Cecil.
 *
 * Copyright (c) Arnaud Ligny <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Cecil\Renderer;

use Cecil\Builder;
use Cecil\Collection\Page\Page as CollectionPage;

/**
 * Class Site.
 */
class Site implements \ArrayAccess
{
    /** @var Builder Builder object. */
    protected $builder;

    /** @var \Cecil\Config */
    protected $config;

    /** @var string Current language. */
    protected $language;

    public function __construct(Builder $builder, string $language)
    {
        $this->builder = $builder;
        $this->config = $this->builder->getConfig();
        $this->language = $language;
    }

    /**
     * Implement ArrayAccess.
     *
     * @param mixed $offset
     *
     * @return bool
     */
    #[\ReturnTypeWillChange]
    public function offsetExists($offset): bool
    {
        // special cases
        switch ($offset) {
            case 'menus':
            case 'home':
            case 'debug':
                return true;
        }

        return $this->config->has($offset);
    }

    /**
     * Implements \ArrayAccess.
     *
     * @param mixed $offset
     *
     * @return mixed|null
     */
    #[\ReturnTypeWillChange]
    public function offsetGet($offset)
    {
        // If it's a built-in variable: dot not fetchs data from config raw
        switch ($offset) {
            case 'pages':
                return $this->getPages();
            case 'menus':
                return $this->builder->getMenus($this->language);
            case 'taxonomies':
                return $this->builder->getTaxonomies($this->language);
            case 'data':
                return $this->builder->getData();
            case 'static':
                return $this->builder->getStatic();
            case 'language':
                return new Language($this->config, $this->language);
            case 'home':
                return 'index';
            case 'debug':
                return $this->builder->isDebug();
        }

        return $this->config->get($offset, $this->language);
    }

    /**
     * Implements \ArrayAccess.
     *
     * @param mixed $offset
     * @param mixed $value
     *
     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
     */
    #[\ReturnTypeWillChange]
    public function offsetSet($offset, $value): void
    {
    }

    /**
     * Implements \ArrayAccess.
     *
     * @param mixed $offset
     *
     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
     */
    #[\ReturnTypeWillChange]
    public function offsetUnset($offset): void
    {
    }

    /**
     * Returns a page for the provided language or the current one provided.
     *
     * @throws \DomainException
     */
    public function getPage(string $id, string $language = null): ?CollectionPage
    {
        $pageId = $id;
        $language = $language ?? $this->language;

        if ($language !== null && $language != $this->config->getLanguageDefault()) {
            $pageId = "$language/$id";
        }

        if ($this->builder->getPages()->has($pageId) === false) {
            // if multilingual == false
            if ($this->builder->getPages()->has($id) && $this->builder->getPages()->get($id)->getVariable('multilingual') === false) {
                return $this->builder->getPages()->get($id);
            }

            return null;
        }

        return $this->builder->getPages()->get($pageId);
    }

    /**
     * Returns all pages, in the current language.
     */
    public function getPages(): \Cecil\Collection\Page\Collection
    {
        return $this->builder->getPages()->filter(function (CollectionPage $page) {
            // We should fix case of virtual pages without language
            if (
                $page->getVariable('language') === null
                && $this->language == $this->config->getLanguageDefault()
            ) {
                return true;
            }

            return $page->getVariable('language') == $this->language;
        });
    }

    /**
     * Returns all pages, regardless of their translation.
     */
    public function getAllPages(): \Cecil\Collection\Page\Collection
    {
        return $this->builder->getPages();
    }

    /**
     * Alias of getAllPages().
     */
    public function getPagesIntl(): \Cecil\Collection\Page\Collection
    {
        return $this->getAllPages();
    }

    /**
     * Returns current time.
     */
    public function getTime(): int
    {
        return time();
    }

    /**
     * Returns the property value(s) of an output format.
     */
    public function getOutputProperty(string $name, string $property): string|array|null
    {
        return $this->config->getOutputFormatProperty($name, $property);
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		/*
6		* This file is part of Cecil.
7		*
8		* Copyright (c) Arnaud Ligny <[email protected]>
9		*
10		* For the full copyright and license information, please view the LICENSE
11		* file that was distributed with this source code.
12		*/
13
14		namespace Cecil\Renderer;
15
16		use Cecil\Builder;
17		use Cecil\Collection\Page\Page as CollectionPage;
18
19		/**
20		* Class Site.
21		*/
22		class Site implements \ArrayAccess
23		{
24		/** @var Builder Builder object. */
25		protected $builder;
26
27		/** @var \Cecil\Config */
28		protected $config;
29
30		/** @var string Current language. */
31		protected $language;
32
33	1	public function __construct(Builder $builder, string $language)
34		{
35	1	$this->builder = $builder;
36	1	$this->config = $this->builder->getConfig();
37	1	$this->language = $language;
38		}
39
40		/**
41		* Implement ArrayAccess.
42		*
43		* @param mixed $offset
44		*
45		* @return bool
46		*/
47		#[\ReturnTypeWillChange]
48	1	public function offsetExists($offset): bool
49		{
50		// special cases
51		switch ($offset) {
52	1	case 'menus':
53	1	case 'home':
54	1	case 'debug':
55		return true;
56		}
57	1
58		return $this->config->has($offset);
59		}
60
61		/**
62		* Implements \ArrayAccess.
63		*
64		* @param mixed $offset
65		*
66		* @return mixed\|null
67		*/
68	1	#[\ReturnTypeWillChange]
69		public function offsetGet($offset)
70		{
71		// If it's a built-in variable: dot not fetchs data from config raw
72	1	switch ($offset) {
73	1	case 'pages':
74	1	return $this->getPages();
75	1	case 'menus':
76	1	return $this->builder->getMenus($this->language);
77	1	case 'taxonomies':
78	1	return $this->builder->getTaxonomies($this->language);
79	1	case 'data':
80	1	return $this->builder->getData();
81	1	case 'static':
82	1	return $this->builder->getStatic();
83	1	case 'language':
84	1	return new Language($this->config, $this->language);
85	1	case 'home':
86		return 'index';
87		case 'debug':
88	1	return $this->builder->isDebug();
89		}
90
91		return $this->config->get($offset, $this->language);
92		}
93
94		/**
95		* Implements \ArrayAccess.
96		*
97		* @param mixed $offset
98		* @param mixed $value
99		*
100		* @SuppressWarnings(PHPMD.UnusedFormalParameter)
101		*/
102		#[\ReturnTypeWillChange]
103		public function offsetSet($offset, $value): void
104		{
105		}
106
107		/**
108		* Implements \ArrayAccess.
109		*
110		* @param mixed $offset
111		*
112		* @SuppressWarnings(PHPMD.UnusedFormalParameter)
113		*/
114		#[\ReturnTypeWillChange]
115		public function offsetUnset($offset): void
116		{
117		}
118
119		/**
120		* Returns a page for the provided language or the current one provided.
121	1	*
122		* @throws \DomainException
123	1	*/
124	1	public function getPage(string $id, string $language = null): ?CollectionPage
125	1	{
126		$pageId = $id;
127	1	$language = $language ?? $this->language;
128	1
129		if ($language !== null && $language != $this->config->getLanguageDefault()) {
130		$pageId = "$language/$id";
131	1	}
132
133		if ($this->builder->getPages()->has($pageId) === false) {
134		// if multilingual == false
135		if ($this->builder->getPages()->has($id) && $this->builder->getPages()->get($id)->getVariable('multilingual') === false) {
136		return $this->builder->getPages()->get($id);
137	1	}
138
139	1	return null;
140		}
141	1
142		return $this->builder->getPages()->get($pageId);
143		}
144
145	1	/**
146	1	* Returns all pages, in the current language.
147		*/
148		public function getPages(): \Cecil\Collection\Page\Collection
149		{
150		return $this->builder->getPages()->filter(function (CollectionPage $page) {
151		// We should fix case of virtual pages without language
152	1	if (
153		$page->getVariable('language') === null
154	1	&& $this->language == $this->config->getLanguageDefault()
155		) {
156		return true;
157		}
158
159		return $page->getVariable('language') == $this->language;
160		});
161		}
162
163		/**
164		* Returns all pages, regardless of their translation.
165		*/
166		public function getAllPages(): \Cecil\Collection\Page\Collection
167		{
168	1	return $this->builder->getPages();
169		}
170	1
171		/**
172		* Alias of getAllPages().
173		*/
174		public function getPagesIntl(): \Cecil\Collection\Page\Collection
175		{
176		return $this->getAllPages();
177		}
178
179		/**
180		* Returns current time.
181		*/
182		public function getTime(): int
183		{
184		return time();
185		}
186
187		/**
188		* Returns the property value(s) of an output format.
189		*/
190		public function getOutputProperty(string $name, string $property): string\|array\|null
191		{
192		return $this->config->getOutputFormatProperty($name, $property);
193		}
194		}
195

Cecilapp / Cecil

Push — nested-sections ( 2d40b2...7dbf34 )

Site::getOutputProperty() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like