ThemeManager::getThemes() - Code Metrics - Inspection of "Theme basepath" - luyadev/luya - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#2002)

unknown

created 2020-03-19 06:57 UTC

ThemeManager::getThemes() A

↳ Parent: ThemeManager

Complexity

Conditions	5
Paths	7

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	21
rs	9.2728
c	0
b	0
f	0
cc	5
nc	7
nop	1

<?php

namespace luya\theme;

use luya\base\PackageConfig;
use luya\Exception;
use luya\helpers\Json;
use Yii;
use yii\base\InvalidArgumentException;
use yii\base\InvalidConfigException;

/**
 * Core theme manager for LUYA.
 *
 * This component manage available themes via file system and the actual display themes.
 *
 * @property bool $hasActiveTheme
 * @property Theme $activeTheme
 *
 * @author Bennet Klarhölter <[email protected]>
 * @since  1.1.0
 */
class ThemeManager extends \yii\base\Component
{
    /**
     * Name of the event before the active theme will be setup.
     */
    const EVENT_BEFORE_SETUP = 'eventBeforeSetup';
    
    /**
     * @var string Name of the theme which should be activated on setup. This is commonly used to defined the active theme when **not**
     * using the CMS ThemeManager to switch between themes.
     */
    public $activeThemeName;
    
    /**
     * @var ThemeConfig[]
     */
    private $_themes = [];
    
    /**
     * Read the theme.json and create a new \luya\theme\ThemeConfig for the given base path.
     *
     * @param string $basePath Base path can either be a path to a folder with theme.json files or an absolute path to a theme.json file
     * @return ThemeConfig
     * @throws Exception
     * @throws InvalidConfigException
     */
    public function loadThemeConfig(string $basePath)
    {
        if (strpos($basePath, '@') === 0) {
            $dir = Yii::getAlias($basePath);
        } elseif (strpos($basePath, '/') === 0) {
            // absolute path
            $dir = $basePath;
        } else {
            // relative path
            throw new InvalidConfigException('Theme base path have to be absolute or alias: ' . $basePath);
        }

        // $basePath is an absolute path = /VENDOR/NAME/theme.json
        if (is_file($basePath) && file_exists($basePath)) {
            $themeFile = $basePath;
            // if basePath is the theme file itself and existing process:
            $basePath = pathinfo($basePath, PATHINFO_DIRNAME);
        } else {
            if (!is_dir($dir) || !is_readable($dir)) {
                throw new Exception('Theme directory not exists or readable: ' . $dir);
            }

            $themeFile = $dir . DIRECTORY_SEPARATOR . 'theme.json';
            if (!file_exists($themeFile)) {
                throw new InvalidConfigException('Theme config file missing at: ' . $themeFile);
            }
        }
        
        $config = Json::decode(file_get_contents($themeFile)) ?: [];
    
        return new ThemeConfig($basePath, $config);
    }
    
    /**
     * Setup active theme
     *
     * @throws Exception
     * @throws InvalidConfigException
     * @throws \yii\db\Exception
     */
    public function setup()
    {
        if ($this->activeTheme instanceof Theme) {
            // Active theme already loaded
            return;
        }
        
        $basePath = $this->getActiveThemeBasePath();
        $this->beforeSetup($basePath);
<?php

function getDate($date)
{
    if ($date !== null) {
        return new DateTime($date);
    }

    return false;
}
        
        if ($basePath) {
            $themeConfig = $this->getThemeByBasePath($basePath);
            $theme = new Theme($themeConfig);
            $this->activate($theme);
        }
    }
    
    /**
     * Trigger the {{\luya\theme\ThemeManager::EVENT_BEFORE_SETUP}} event.
     *
     * @param string $basePath
     */
    protected function beforeSetup(string &$basePath)
    {
        $event = new SetupEvent();
        $event->basePath = $basePath;
        $this->trigger(self::EVENT_BEFORE_SETUP, $event);
        
        $basePath = $event->basePath;
    }
    
    /**
     * Get base path of active theme.
     *
     * @return string
     * @throws \yii\db\Exception
     */
    protected function getActiveThemeBasePath()
    {
        if (!empty($this->activeThemeName) && is_string($this->activeThemeName)) {
            return $this->activeThemeName;
        }
        
        return false;
    }
    
    /**
     * Get all theme configs as array list.
     *
     * @param bool $throwException Whether an exception should by throw or not. By version 1.0.24 this is disabled by default.
     * @return ThemeConfig[]
     * @throws \yii\base\Exception
     */
    public function getThemes($throwException = false)
    {
        if ($this->_themes) {

            return $this->_themes;
        }
        
        $themeDefinitions = $this->getThemeDefinitions();
        
        foreach ($themeDefinitions as $themeDefinition) {
            try {
                $themeConfig = $this->loadThemeConfig($themeDefinition);
                $this->registerTheme($themeConfig);
            } catch (\yii\base\Exception $ex) {
                if ($throwException) {
                    throw $ex;
                }
            }
        }
        
        return $this->_themes;
    }
    
    /**
     * Get theme definitions by search in `@app/themes` and the `Yii::$app->getPackageInstaller()`
     *
     * @return string[]
     */
    protected function getThemeDefinitions()
    {
        $themeDefinitions = [];
        
        if (file_exists(Yii::getAlias('@app/themes'))) {
            foreach (glob(Yii::getAlias('@app/themes/*')) as $dirPath) {
                $themeDefinitions[] = "@app/themes/" . basename($dirPath);
            }
        }
        
        foreach (Yii::$app->getPackageInstaller()->getConfigs() as $config) {
            /** @var PackageConfig $config */
            foreach ($config->themes as $theme) {
                if (strpos($theme, '@') === 0 || strpos($theme, '/') === 0) {
                    $themeDefinitions[] = $theme;
                } else {
                    $themeDefinitions[] = '@vendor' . DIRECTORY_SEPARATOR . $config->package['packageFolder'] . DIRECTORY_SEPARATOR . $theme;
                }
            }
        }
        
        return $themeDefinitions;
    }
    
    /**
     * @param string $basePath
     * @param bool $throwException
     *
     * @return ThemeConfig
     * @throws \yii\base\Exception
     * @throws InvalidConfigException
     */
    public function getThemeByBasePath(string $basePath, $throwException = false)
    {
        $themes = $this->getThemes($throwException);
        
        if (!isset($themes[$basePath])) {
            throw new InvalidArgumentException("Theme $basePath could not loaded.");
        }
        
        return $themes[$basePath];
    }
    
    /**
     * Register a theme config and set the path alias with the name of the theme.
     *
     * @param ThemeConfig $themeConfig Base path of the theme.
     *
     * @throws InvalidConfigException
     */
    protected function registerTheme(ThemeConfig $themeConfig)
    {
        $basePath = $themeConfig->getBasePath();
        if (isset($this->_themes[$basePath])) {
            throw new InvalidArgumentException("Theme $basePath already registered.");
        }
        
        $this->_themes[$basePath] = $themeConfig;
        
        Yii::setAlias('@' . basename($basePath) . 'Theme', $basePath);
    }
    
    /**
     * Change the active theme in the \yii\base\View component and set the `activeTheme ` alias to new theme base path.
     *
     * @param Theme $theme
     */
    protected function activate(Theme $theme)
    {
        Yii::$app->view->theme = $theme;
        Yii::setAlias('activeTheme', $theme->basePath);
        
        $this->setActiveTheme($theme);
    }
    
    /**
     * @var Theme|null
     */
    private $_activeTheme;
    
    /**
     * Get the active theme. Null if no theme is activated.
     *
     * @return Theme|null
     */
    public function getActiveTheme()
    {
        return $this->_activeTheme;
    }
    
    /**
     * Change the active theme.
     *
     * @param Theme $theme
     */
    protected function setActiveTheme(Theme $theme)
    {
        $this->_activeTheme = $theme;
    }
    
    /**
     * Check if a theme is activated.
     *
     * @return bool
     */
    public function getHasActiveTheme()
    {
        return $this->getActiveTheme() !== null;
    }
}


1			<?php
2
3			namespace luya\theme;
4
5			use luya\base\PackageConfig;
6			use luya\Exception;
7			use luya\helpers\Json;
8			use Yii;
9			use yii\base\InvalidArgumentException;
10			use yii\base\InvalidConfigException;
11
12			/**
13			* Core theme manager for LUYA.
14			*
15			* This component manage available themes via file system and the actual display themes.
16			*
17			* @property bool $hasActiveTheme
18			* @property Theme $activeTheme
19			*
20			* @author Bennet Klarhölter <[email protected]>
21			* @since 1.1.0
22			*/
23			class ThemeManager extends \yii\base\Component
24			{
25			/**
26			* Name of the event before the active theme will be setup.
27			*/
28			const EVENT_BEFORE_SETUP = 'eventBeforeSetup';
29
30			/**
31			* @var string Name of the theme which should be activated on setup. This is commonly used to defined the active theme when not
32			* using the CMS ThemeManager to switch between themes.
33			*/
34			public $activeThemeName;
35
36			/**
37			* @var ThemeConfig[]
38			*/
39			private $_themes = [];
40
41			/**
42			* Read the theme.json and create a new \luya\theme\ThemeConfig for the given base path.
43			*
44			* @param string $basePath Base path can either be a path to a folder with theme.json files or an absolute path to a theme.json file
45			* @return ThemeConfig
46			* @throws Exception
47			* @throws InvalidConfigException
48			*/
49			public function loadThemeConfig(string $basePath)
50			{
51			if (strpos($basePath, '@') === 0) {
52			$dir = Yii::getAlias($basePath);
53			} elseif (strpos($basePath, '/') === 0) {
54			// absolute path
55			$dir = $basePath;
56			} else {
57			// relative path
58			throw new InvalidConfigException('Theme base path have to be absolute or alias: ' . $basePath);
59			}
60
61			// $basePath is an absolute path = /VENDOR/NAME/theme.json
62			if (is_file($basePath) && file_exists($basePath)) {
63			$themeFile = $basePath;
64			// if basePath is the theme file itself and existing process:
65			$basePath = pathinfo($basePath, PATHINFO_DIRNAME);
66			} else {
67			if (!is_dir($dir) \|\| !is_readable($dir)) {
68			throw new Exception('Theme directory not exists or readable: ' . $dir);
69			}
70
71			$themeFile = $dir . DIRECTORY_SEPARATOR . 'theme.json';
72			if (!file_exists($themeFile)) {
73			throw new InvalidConfigException('Theme config file missing at: ' . $themeFile);
74			}
75			}
76
77			$config = Json::decode(file_get_contents($themeFile)) ?: [];
78
79			return new ThemeConfig($basePath, $config);
80			}
81
82			/**
83			* Setup active theme
84			*
85			* @throws Exception
86			* @throws InvalidConfigException
87			* @throws \yii\db\Exception
88			*/
89			public function setup()
90			{
91			if ($this->activeTheme instanceof Theme) {
92			// Active theme already loaded
93			return;
94			}
95
96			$basePath = $this->getActiveThemeBasePath();
97			$this->beforeSetup($basePath);
			0 ignored issues – show Security Bug introduced 2019-12-29 09:40 UTC by Report Bug Copy Issue Report It seems like `$basePath` defined by `$this->getActiveThemeBasePath()` on line `96` can also be of type `false`; however, `luya\theme\ThemeManager::beforeSetup()` does only seem to accept `string`, did you maybe forget to handle an error condition? This check looks for type mismatches where the missing type is `false`. This is usually indicative of an error condtion. Consider the follow example <?php function getDate($date) { if ($date !== null) { return new DateTime($date); } return false; } This function either returns a new `DateTime` object or false, if there was an error. This is a typical pattern in PHP programming to show that an error has occurred without raising an exception. The calling code should check for this returned `false` before passing on the value to another function or method that may not be able to handle a `false`. Loading history...
98
99			if ($basePath) {
100			$themeConfig = $this->getThemeByBasePath($basePath);
101			$theme = new Theme($themeConfig);
102			$this->activate($theme);
103			}
104			}
105
106			/**
107			* Trigger the {{\luya\theme\ThemeManager::EVENT_BEFORE_SETUP}} event.
108			*
109			* @param string $basePath
110			*/
111			protected function beforeSetup(string &$basePath)
112			{
113			$event = new SetupEvent();
114			$event->basePath = $basePath;
115			$this->trigger(self::EVENT_BEFORE_SETUP, $event);
116
117			$basePath = $event->basePath;
118			}
119
120			/**
121			* Get base path of active theme.
122			*
123			* @return string
124			* @throws \yii\db\Exception
125			*/
126			protected function getActiveThemeBasePath()
127			{
128			if (!empty($this->activeThemeName) && is_string($this->activeThemeName)) {
129			return $this->activeThemeName;
130			}
131
132			return false;
133			}
134
135			/**
136			* Get all theme configs as array list.
137			*
138			* @param bool $throwException Whether an exception should by throw or not. By version 1.0.24 this is disabled by default.
139			* @return ThemeConfig[]
140			* @throws \yii\base\Exception
141			*/
142			public function getThemes($throwException = false)
143			{
144			if ($this->_themes) {
			0 ignored issues – show Bug Best Practice introduced 2019-09-21 18:57 UTC by Report Bug Copy Issue Report The expression `$this->_themes` of type `luya\theme\ThemeConfig[]` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
145			return $this->_themes;
146			}
147
148			$themeDefinitions = $this->getThemeDefinitions();
149
150			foreach ($themeDefinitions as $themeDefinition) {
151			try {
152			$themeConfig = $this->loadThemeConfig($themeDefinition);
153			$this->registerTheme($themeConfig);
154			} catch (\yii\base\Exception $ex) {
155			if ($throwException) {
156			throw $ex;
157			}
158			}
159			}
160
161			return $this->_themes;
162			}
163
164			/**
165			* Get theme definitions by search in `@app/themes` and the `Yii::$app->getPackageInstaller()`
166			*
167			* @return string[]
168			*/
169			protected function getThemeDefinitions()
170			{
171			$themeDefinitions = [];
172
173			if (file_exists(Yii::getAlias('@app/themes'))) {
174			foreach (glob(Yii::getAlias('@app/themes/*')) as $dirPath) {
175			$themeDefinitions[] = "@app/themes/" . basename($dirPath);
176			}
177			}
178
179			foreach (Yii::$app->getPackageInstaller()->getConfigs() as $config) {
180			/** @var PackageConfig $config */
181			foreach ($config->themes as $theme) {
182			if (strpos($theme, '@') === 0 \|\| strpos($theme, '/') === 0) {
183			$themeDefinitions[] = $theme;
184			} else {
185			$themeDefinitions[] = '@vendor' . DIRECTORY_SEPARATOR . $config->package['packageFolder'] . DIRECTORY_SEPARATOR . $theme;
186			}
187			}
188			}
189
190			return $themeDefinitions;
191			}
192
193			/**
194			* @param string $basePath
195			* @param bool $throwException
196			*
197			* @return ThemeConfig
198			* @throws \yii\base\Exception
199			* @throws InvalidConfigException
200			*/
201			public function getThemeByBasePath(string $basePath, $throwException = false)
202			{
203			$themes = $this->getThemes($throwException);
204
205			if (!isset($themes[$basePath])) {
206			throw new InvalidArgumentException("Theme $basePath could not loaded.");
207			}
208
209			return $themes[$basePath];
210			}
211
212			/**
213			* Register a theme config and set the path alias with the name of the theme.
214			*
215			* @param ThemeConfig $themeConfig Base path of the theme.
216			*
217			* @throws InvalidConfigException
218			*/
219			protected function registerTheme(ThemeConfig $themeConfig)
220			{
221			$basePath = $themeConfig->getBasePath();
222			if (isset($this->_themes[$basePath])) {
223			throw new InvalidArgumentException("Theme $basePath already registered.");
224			}
225
226			$this->_themes[$basePath] = $themeConfig;
227
228			Yii::setAlias('@' . basename($basePath) . 'Theme', $basePath);
229			}
230
231			/**
232			* Change the active theme in the \yii\base\View component and set the `activeTheme ` alias to new theme base path.
233			*
234			* @param Theme $theme
235			*/
236			protected function activate(Theme $theme)
237			{
238			Yii::$app->view->theme = $theme;
239			Yii::setAlias('activeTheme', $theme->basePath);
240
241			$this->setActiveTheme($theme);
242			}
243
244			/**
245			* @var Theme\|null
246			*/
247			private $_activeTheme;
248
249			/**
250			* Get the active theme. Null if no theme is activated.
251			*
252			* @return Theme\|null
253			*/
254			public function getActiveTheme()
255			{
256			return $this->_activeTheme;
257			}
258
259			/**
260			* Change the active theme.
261			*
262			* @param Theme $theme
263			*/
264			protected function setActiveTheme(Theme $theme)
265			{
266			$this->_activeTheme = $theme;
267			}
268
269			/**
270			* Check if a theme is activated.
271			*
272			* @return bool
273			*/
274			public function getHasActiveTheme()
275			{
276			return $this->getActiveTheme() !== null;
277			}
278			}
279

luyadev / luya

Pull Request — master (#2002)

ThemeManager::getThemes() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like