hiqdev\thememanager\ThemeManager

Complexity

Total Complexity

30

Size/Duplication

Total Lines	209
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	7

Test Coverage

Coverage

0%

Importance

Changes	13
Bugs	2	Features	1

14 Methods

Rating	Name	Duplication	Size	Complexity
A	setDefaultTheme()	0	4	1
A	getDefaultTheme()	0	9	2
A	getView()	0	8	2
A	setView()	0	4	1
A	setTheme()	0	7	2
A	getTheme()	0	12	3
A	getSettings()	0	4	1
A	isHomePage()	0	6	2
A	registerAssets()	0	7	2
A	bootstrap()	0	17	4
B	widget()	0	20	5
A	hasWidget()	0	4	3
A	getSettingsStorage()	0	4	1
A	getThemeSettings()	0	4	1

<?php

/*
 * Theme Manager for Yii2
 *
 * @link      https://github.com/hiqdev/yii2-thememanager
 * @package   yii2-thememanager
 * @license   BSD-3-Clause
 * @copyright Copyright (c) 2015-2016, HiQDev (http://hiqdev.com/)
 */

namespace hiqdev\thememanager;

use hiqdev\thememanager\models\Settings;
use hiqdev\thememanager\storage\SettingsStorageInterface;
use Yii;
use yii\base\Application;
use yii\base\InvalidConfigException;
use yii\base\Widget;
use yii\web\AssetBundle;

/**
 * Theme Manager.
 *
 * Usage, in config:
 *
 * ```php
 * 'components' => [
 *     'themeManager' => [
 *         'class' => \hiqdev\thememanager\ThemeManager::class,
 *     ],
 * ]
 * ```
 */
class ThemeManager extends \hiqdev\yii2\collection\Manager implements \yii\base\BootstrapInterface
{
    /**
     * @var array basic pathMap for all themes, will be merged with theme own pathMap.
     */
    public $pathMap = [];

    /**
     * {@inheritdoc}
     */
    protected $_itemClass = Theme::class;

    /**
     * @var string default theme name
     */
    protected $_defaultTheme;

    /**
     * Sets the default theme name.
     *
     * @param string $theme default theme name
     */
    public function setDefaultTheme($theme)
    {
        $this->_defaultTheme = $theme;
    }

    /**
     * Returns the default theme. Returns the first of available themes by default.
     *
     * @return string default theme name
     */
    public function getDefaultTheme()
    {
        if (!$this->_defaultTheme) {
            $keys = $this->keys(); /// shame to PHP it can't be done in single line :(
            $this->_defaultTheme = reset($keys);
        }

        return $this->_defaultTheme;
    }

    protected $_view;

    /**
     * @return \yii\web\View
     * @see setView
     */
    public function getView()
    {
        if ($this->_view === null) {
            $this->_view = Yii::$app->getView();
        }

        return $this->_view;
    }

    /**
     * You can change the View for theme manager.
     * @param \yii\web\View $view the view object that will be used to render views or view files.
     */
    public function setView($view)
    {
        $this->_view = $view;
    }

    /**
     * @var Theme current theme object
     */
    protected $_theme;

    /**
     * Changes theme.
     * @param string theme name
     * @throws InvalidConfigException
     */
    public function setTheme($name)
    {
        if (!$name) {
            throw new InvalidConfigException('no theme to set');
        }
        $this->_theme = $name;
    }

    public function getTheme()
    {
        if (is_string($this->_theme)) {
            if (!$this->has($this->_theme)) {
                throw new InvalidConfigException('unknown theme: ' . $this->_theme);
            }
            $this->_theme = $this->getItem($this->_theme);
            $this->getView()->theme = $this->_theme;
        }

        return $this->_theme;
    }

    public function getSettings()
    {
        return $this->getTheme()->getSettings();
    }

    /**
     * @return bool
     */
    public static function isHomePage()
    {
        $controller = Yii::$app->controller;
        $default_controller = Yii::$app->defaultRoute;
        return ($controller->id === $default_controller) && ($controller->action->id === $controller->defaultAction);
    }

    /**
     * @var AssetBundle[] assets to be registered at bootstrap.
     */
    public $assets = [];

    /**
     * Register all the assets.
     */
    public function registerAssets()
    {
        foreach (array_merge($this->assets, $this->getTheme()->assets) as $asset) {
            /** @var AssetBundle $asset */
            $asset::register($this->getView());
        }
    }

    /**
     * @var bool is already bootstrapped
     */
    protected $_isBootstrapped = false;

    /**
     * {@inheritdoc}
     */
    public function bootstrap($app)
    {
        if ($this->_isBootstrapped) {
            return;
        }
        $this->_isBootstrapped = true;

        Yii::trace('Bootstrap themes', get_called_class() . '::bootstrap');

        $data = $this->getSettingsStorage()->get();
        $model = new Settings();
        $model->load($data);
        $theme = $this->hasItem($model->theme) ? $model->theme : null;
        $theme = $theme ?: $this->getDefaultTheme();
        $this->setTheme($theme);
        $this->getTheme();
    }

    public $widgets = [];

    /**
     * Draws widget.
     * @param mixed $config
     * @throws InvalidConfigException
     * @return void
     */
    public function widget($config)
    {
        if (!is_array($config)) {
            $config = ['class' => $config];
        }
        if (!isset($config['class'])) {
            throw new InvalidConfigException('no class given');
        }
        if (isset($this->widgets[$config['class']])) {
            $default = $this->widgets[$config['class']];
            if (is_array($default)) {
                $config = array_merge($default, $config);
                $config['class'] = $default['class'];
            } else {
                $config['class'] = $default;
            }
        }

        return $config['class']::widget($config);
    }

    /**
     * Checks if widget with given name is defined.
     * @param mixed $name name or class
     * @return boolean
     */
    public function hasWidget($name)
    {
        return (isset($this->widgets[$name]) && $this->widgets[$name]) || class_exists($name);
    }

    /**
     * @return SettingsStorageInterface
     */
    public function getSettingsStorage()
    {
        return Yii::$app->get('themeSettingsStorage');
    }

    /**
     * @return array
     */
    public function getThemeSettings()
    {
        return $this->getSettingsStorage()->get();
    }
}