Theme::getProperties() - Code Metrics - Inspection of "inline docs revisions" - o2system/framework - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( a1835d...10e84a )

unknown

created 2019-02-09 04:05 UTC

Theme::getProperties() A

↳ Parent: Theme

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
nc	1
nop	0
dl	0
loc	3
rs	10
c	0
b	0
f	0

<?php
/**
 * This file is part of the O2System Framework package.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @author         Steeve Andrian Salim
 * @copyright      Copyright (c) Steeve Andrian Salim
 */

// ------------------------------------------------------------------------

namespace O2System\Framework\Containers\Modules\DataStructures\Module;

// ------------------------------------------------------------------------

use O2System\Spl\DataStructures\SplArrayObject;
use O2System\Spl\Info\SplDirectoryInfo;
use O2System\Spl\Info\SplFileInfo;

/**
 * Class Theme
 *
 * @package O2System\Framework\Containers\Modules\DataStructures\Module
 */
class Theme extends SplDirectoryInfo
{
    /**
     * Theme Properties
     *
     * @var array
     */
    private $properties = [];

    /**
     * Theme Presets
     *
     * @var array
     */
    private $presets = [];

    /**
     * Theme Layout
     *
     * @var Theme\Layout
     */
    private $layout;

    /**
     * Theme::__construct
     *
     * @param string $dir
     */
    public function __construct($dir)
    {
        parent::__construct($dir);

        // Set Theme Properties
        if (is_file($propFilePath = $dir . 'theme.json')) {
            $properties = json_decode(file_get_contents($propFilePath), true);

            if (json_last_error() === JSON_ERROR_NONE) {
                if (isset($properties[ 'config' ])) {
                    $this->presets = $properties[ 'presets' ];
                    unset($properties[ 'presets' ]);
                }

                $this->properties = $properties;
            }
        }

        // Set Default Theme Layout
        $this->setLayout('theme');
    }

    // ------------------------------------------------------------------------

    /**
     * Theme::isValid
     *
     * @return bool
     */
    public function isValid()
    {
        if (count($this->properties)) {
            return true;
        }

        return false;
    }

    // ------------------------------------------------------------------------

    /**
     * Theme::getParameter
     *
     * @return string
     */
    public function getParameter()
    {
        return $this->getDirName();
    }

    // ------------------------------------------------------------------------

    /**
     * Theme::getCode
     *
     * @return string
     */
    public function getCode()
    {
        return strtoupper(substr(md5($this->getDirName()), 2, 7));
    }

    // ------------------------------------------------------------------------

    /**
     * Theme::getChecksum
     *
     * @return string
     */
    public function getChecksum()
    {
        return md5($this->getMTime());
    }

    // ------------------------------------------------------------------------

    /**
     * Theme::getProperties
     *
     * @return \O2System\Spl\DataStructures\SplArrayObject
     */
    public function getProperties()
    {
        return new SplArrayObject($this->properties);
    }

    // ------------------------------------------------------------------------

    /**
     * Theme::getPresets
     *
     * @return \O2System\Spl\DataStructures\SplArrayObject
     */
    public function getPresets()
    {
        return new SplArrayObject($this->presets);
    }

    // ------------------------------------------------------------------------

    /**
     * Theme::getUrl
     *
     * @param string|null $path
     *
     * @return string
     */
    public function getUrl($path = null)
    {
        return path_to_url($this->getRealPath() . $path);
    }

    // ------------------------------------------------------------------------

    /**
     * Theme::load
     *
     * @return static
     */
    public function load()
    {
        if ($this->getPresets()->offsetExists('assets')) {
            presenter()->assets->autoload($this->getPresets()->offsetGet('assets'));
        }

        presenter()->assets->loadCss('theme.css');
        presenter()->assets->loadJs('theme.js');

        // Autoload default theme layout
        $this->loadLayout();

        return $this;
    }

    // ------------------------------------------------------------------------

    /**
     * Theme::setLayout
     *
     * @param string $layout
     *
     * @return static
     */
    public function setLayout($layout)
    {
        $extensions = ['.php', '.phtml', '.html', '.tpl'];

        if (isset($this->presets[ 'extensions' ])) {
            array_unshift($partialsExtensions, $this->presets[ 'extension' ]);
        } elseif (isset($this->presets[ 'extension' ])) {
            array_unshift($extensions, $this->presets[ 'extension' ]);
        }

        foreach ($extensions as $extension) {
            $extension = trim($extension, '.');

            if ($layout === 'theme') {
                $layoutFilePath = $this->getRealPath() . 'theme.' . $extension;
            } else {
                $layoutFilePath = $this->getRealPath() . 'layouts' . DIRECTORY_SEPARATOR . dash($layout) . DIRECTORY_SEPARATOR . 'layout.' . $extension;
            }

            if (is_file($layoutFilePath)) {
                $this->layout = new Theme\Layout($layoutFilePath);
                break;
            }
        }

        return $this;
    }

    // ------------------------------------------------------------------------

    /**
     * Theme::getLayout
     *
     * @return Theme\Layout
     */
    public function getLayout()
    {
        return $this->layout;
    }

    // ------------------------------------------------------------------------

    /**
     * Theme::loadLayout
     *
     * @return static
     */
    protected function loadLayout()
    {
        if ($this->layout instanceof Theme\Layout) {

            // add theme layout public directory
            loader()->addPublicDir($this->layout->getPath() . 'assets');

            presenter()->assets->autoload(
                [
                    'css' => ['layout'],
                    'js'  => ['layout'],
                ]
            );

            $partials = $this->layout->getPartials()->getArrayCopy();

            foreach ($partials as $offset => $partial) {
                if ($partial instanceof SplFileInfo) {
                    presenter()->partials->addPartial($offset, $partial->getPathName());
                }
            }
        }

        return $this;
    }
}

1			<?php
2			/**
3			* This file is part of the O2System Framework package.
4			*
5			* For the full copyright and license information, please view the LICENSE
6			* file that was distributed with this source code.
7			*
8			* @author Steeve Andrian Salim
9			* @copyright Copyright (c) Steeve Andrian Salim
10			*/
11
12			// ------------------------------------------------------------------------
13
14			namespace O2System\Framework\Containers\Modules\DataStructures\Module;
15
16			// ------------------------------------------------------------------------
17
18			use O2System\Spl\DataStructures\SplArrayObject;
19			use O2System\Spl\Info\SplDirectoryInfo;
20			use O2System\Spl\Info\SplFileInfo;
21
22			/**
23			* Class Theme
24			*
25			* @package O2System\Framework\Containers\Modules\DataStructures\Module
26			*/
27			class Theme extends SplDirectoryInfo
28			{
29			/**
30			* Theme Properties
31			*
32			* @var array
33			*/
34			private $properties = [];
35
36			/**
37			* Theme Presets
38			*
39			* @var array
40			*/
41			private $presets = [];
42
43			/**
44			* Theme Layout
45			*
46			* @var Theme\Layout
47			*/
48			private $layout;
49
50			/**
51			* Theme::__construct
52			*
53			* @param string $dir
54			*/
55			public function __construct($dir)
56			{
57			parent::__construct($dir);
58
59			// Set Theme Properties
60			if (is_file($propFilePath = $dir . 'theme.json')) {
61			$properties = json_decode(file_get_contents($propFilePath), true);
62
63			if (json_last_error() === JSON_ERROR_NONE) {
64			if (isset($properties[ 'config' ])) {
65			$this->presets = $properties[ 'presets' ];
66			unset($properties[ 'presets' ]);
67			}
68
69			$this->properties = $properties;
70			}
71			}
72
73			// Set Default Theme Layout
74			$this->setLayout('theme');
75			}
76
77			// ------------------------------------------------------------------------
78
79			/**
80			* Theme::isValid
81			*
82			* @return bool
83			*/
84			public function isValid()
85			{
86			if (count($this->properties)) {
87			return true;
88			}
89
90			return false;
91			}
92
93			// ------------------------------------------------------------------------
94
95			/**
96			* Theme::getParameter
97			*
98			* @return string
99			*/
100			public function getParameter()
101			{
102			return $this->getDirName();
103			}
104
105			// ------------------------------------------------------------------------
106
107			/**
108			* Theme::getCode
109			*
110			* @return string
111			*/
112			public function getCode()
113			{
114			return strtoupper(substr(md5($this->getDirName()), 2, 7));
115			}
116
117			// ------------------------------------------------------------------------
118
119			/**
120			* Theme::getChecksum
121			*
122			* @return string
123			*/
124			public function getChecksum()
125			{
126			return md5($this->getMTime());
127			}
128
129			// ------------------------------------------------------------------------
130
131			/**
132			* Theme::getProperties
133			*
134			* @return \O2System\Spl\DataStructures\SplArrayObject
135			*/
136			public function getProperties()
137			{
138			return new SplArrayObject($this->properties);
139			}
140
141			// ------------------------------------------------------------------------
142
143			/**
144			* Theme::getPresets
145			*
146			* @return \O2System\Spl\DataStructures\SplArrayObject
147			*/
148			public function getPresets()
149			{
150			return new SplArrayObject($this->presets);
151			}
152
153			// ------------------------------------------------------------------------
154
155			/**
156			* Theme::getUrl
157			*
158			* @param string\|null $path
159			*
160			* @return string
161			*/
162			public function getUrl($path = null)
163			{
164			return path_to_url($this->getRealPath() . $path);
165			}
166
167			// ------------------------------------------------------------------------
168
169			/**
170			* Theme::load
171			*
172			* @return static
173			*/
174			public function load()
175			{
176			if ($this->getPresets()->offsetExists('assets')) {
177			presenter()->assets->autoload($this->getPresets()->offsetGet('assets'));
178			}
179
180			presenter()->assets->loadCss('theme.css');
181			presenter()->assets->loadJs('theme.js');
182
183			// Autoload default theme layout
184			$this->loadLayout();
185
186			return $this;
187			}
188
189			// ------------------------------------------------------------------------
190
191			/**
192			* Theme::setLayout
193			*
194			* @param string $layout
195			*
196			* @return static
197			*/
198			public function setLayout($layout)
199			{
200			$extensions = ['.php', '.phtml', '.html', '.tpl'];
201
202			if (isset($this->presets[ 'extensions' ])) {
203			array_unshift($partialsExtensions, $this->presets[ 'extension' ]);
204			} elseif (isset($this->presets[ 'extension' ])) {
205			array_unshift($extensions, $this->presets[ 'extension' ]);
206			}
207
208			foreach ($extensions as $extension) {
209			$extension = trim($extension, '.');
210
211			if ($layout === 'theme') {
212			$layoutFilePath = $this->getRealPath() . 'theme.' . $extension;
213			} else {
214			$layoutFilePath = $this->getRealPath() . 'layouts' . DIRECTORY_SEPARATOR . dash($layout) . DIRECTORY_SEPARATOR . 'layout.' . $extension;
215			}
216
217			if (is_file($layoutFilePath)) {
218			$this->layout = new Theme\Layout($layoutFilePath);
219			break;
220			}
221			}
222
223			return $this;
224			}
225
226			// ------------------------------------------------------------------------
227
228			/**
229			* Theme::getLayout
230			*
231			* @return Theme\Layout
232			*/
233			public function getLayout()
234			{
235			return $this->layout;
236			}
237
238			// ------------------------------------------------------------------------
239
240			/**
241			* Theme::loadLayout
242			*
243			* @return static
244			*/
245			protected function loadLayout()
246			{
247			if ($this->layout instanceof Theme\Layout) {
			0 ignored issues – show introduced 2019-02-09 04:07 UTC by Report Bug Copy Issue Report `$this->layout` is always a sub-type of `O2System\Framework\Conta...res\Module\Theme\Layout`. Loading history...
248			// add theme layout public directory
249			loader()->addPublicDir($this->layout->getPath() . 'assets');
250
251			presenter()->assets->autoload(
252			[
253			'css' => ['layout'],
254			'js' => ['layout'],
255			]
256			);
257
258			$partials = $this->layout->getPartials()->getArrayCopy();
259
260			foreach ($partials as $offset => $partial) {
261			if ($partial instanceof SplFileInfo) {
262			presenter()->partials->addPartial($offset, $partial->getPathName());
263			}
264			}
265			}
266
267			return $this;
268			}
269			}

o2system / framework

GitHub Access Token became invalid

Push — master ( a1835d...10e84a )

Theme::getProperties() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like