AdminView::getAdminAssetConfig() - Code Metrics - itstructure/yii2-admin-module - Measure and Improve Code Quality continuously with Scrutinizer

AdminView::getAdminAssetConfig() A
last analyzed 2025-10-20 07:39 UTC

↳ Parent: AdminView

Complexity

Conditions	6
Paths	12

Size

Total Lines	17
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	6
eloc	10
c	1
b	0
f	0
nc	12
nop	0
dl	0
loc	17
rs	9.2222

<?php

namespace Itstructure\AdminModule\components;

use yii\web\View;
use yii\base\InvalidConfigException;
use Itstructure\AdminModule\assets\AdminAsset;

/**
 * Class AdminView
 * Default view for the Admin View
 *
 * @property array $mainMenuConfig Sidebar menu config.
 * @property string $bodyLayout Admin layout type.
 * @property string $skin Admin layout theme. By default are used blue skin.
 * @property null|array|string $assetBundleConfig AssetBundle config.
 * @property string $homeUrl Home URL.
 * @property array $extraAssets An array of extra asset. Each asset can be specified one of the following format:
 * - a string thar represent a class name of extra asset;
 * - an array that must contain a class key and may contain other settings of asset bundle.
 * @see BaseYii::createObject()
 * @property string[] $userBody This array contain a key->value pairs where key - is link name and value is link
 * that will be rendered in "user-body" section of menu.
 * @property string $defaultAssetBundleClass Asset bundle class-name using by default for admin view.
 * @property string $companyName Company name.
 * @property string $shotCompanyName Short company name.
 * @property string $profileLink Link to user profile.
 * @property string $signOutLink Link to sign-out action.
 *
 * @package Itstructure\AdminModule\components
 *
 * @author Andrey Girnik <[email protected]>
 */
class AdminView extends View
{
    /**
     * Layouts.
     */
    const LAYOUT_FIXED = 'fixed';
    const LAYOUT_SIDEBAR_MINI = 'sidebar-mini';
    const LAYOUT_SIDEBAR_COLLAPSE = 'sidebar-collapse';
    const LAYOUT_BOXED = 'layout-boxed';
    const LAYOUT_TOP_NAV = 'layout-top-nav';

    /**
     * Skins.
     */
    const SKIN_BLUE = 'skin-blue';
    const SKIN_BLUE_LIGHT = 'skin-blue-light';
    const SKIN_YELLOW = 'skin-yellow';
    const SKIN_YELLOW_LIGHT = 'skin-yellow-light';
    const SKIN_GREEN = 'skin-green';
    const SKIN_GREEN_LIGHT = 'skin-green-light';
    const SKIN_PURPLE = 'skin-purple';
    const SKIN_PURPLE_LIGHT = 'skin-purple-light';
    const SKIN_RED = 'skin-red';
    const SKIN_RED_LIGHT = 'skin-red-light';
    const SKIN_BLACK = 'skin-black';
    const SKIN_BLACK_LIGHT = 'skin-black-light';

    /**
     * Sidebar menu config.
     *
     * @var array
     */
    public $mainMenuConfig = [];

    /**
     * Admin layout type.
     *
     * @var string
     */
    public $bodyLayout = self::LAYOUT_SIDEBAR_MINI;

    /**
     * Admin layout theme. By default are used blue skin.
     *
     * @var string
     */
    public $skin = self::SKIN_BLUE;

    /**
     * AssetBundle config.
     *
     * @var null|array|string
     */
    public $assetBundleConfig = null;

    /**
     * Home URL.
     *
     * @var string
     */
    public $homeUrl = '/admin';

    /**
     * An array of extra asset. Each asset can be specified one of the following format:
     * - a string thar represent a class name of extra asset;
     * - an array that must contain a class key and may contain other settings of asset bundle.
     *
     * @see BaseYii::createObject()
     *
     * @var array
     */
    public $extraAssets = [];

    /**
     * This array contain a key->value pairs where key - is link name and value is link
     * that will be rendered in "user-body" section of menu.
     *
     * @var string[]
     */
    public $userBody = [];

    /**
     * Asset bundle class-name using by default for admin view.
     *
     * @var string
     */
    private $defaultAssetBundleClass = AdminAsset::class;

    /**
     * Company name.
     *
     * @var string
     */
    public $companyName = 'Company';

    /**
     * Short company name.
     *
     * @var string
     */
    public $shotCompanyName = '';

    /**
     * Link to user profile.
     *
     * @var string
     */
    public $profileLink = '/profile';

    /**
     * Link to sign-out action.
     *
     * @var string
     */
    public $signOutLink = '/site/logout';

    /**
     * Initializes the object.
     *
     * @return void
     */
    public function init(): void
    {
        $this->registerAdminAsset();
        $this->registerExtraAssets();
    }

    /**
     * Register a main admin asset.
     *
     * @return void
     */
    private function registerAdminAsset(): void
    {
        $assetConfig = $this->getAdminAssetConfig();
        $this->registerAsset($assetConfig);
    }

    /**
     * Register an extra assets.
     *
     * @return void
     */
    private function registerExtraAssets(): void
    {
        foreach ($this->extraAssets as $asset) {
            $assetConfig = $this->getExtraAssetConfig($asset);
            $this->registerAsset($assetConfig);
        }
    }

    /**
     * Register an asset bundle in view.
     *
     * @param array $assetConfig config of asset bundle.
     *
     * @return void
     */
    private function registerAsset(array $assetConfig): void
    {
        $assetClassName = $assetConfig['class'];
        $this->assetManager->bundles[$assetClassName] = $assetConfig;
        if (method_exists($assetClassName, 'register')) {
            call_user_func([
                $assetClassName,
                'register',
            ], $this);
        }
    }

    /**
     * Return config array for create instance of AssetBundle.
     *
     * @return array
     */
    private function getAdminAssetConfig(): array
    {
        $config = $this->assetBundleConfig;
        if (null === $config) {
            $config = [];
        }
        if (is_string($config)) {
            $config['class'] = $config;
        }
        if (is_array($config) && !array_key_exists('class', $config)) {
            $config['class'] = $this->defaultAssetBundleClass;
            if (array_key_exists('skin', $config)) {
                $config['skin'] = $this->skin;
            }
        }

        return $config;

    }

    /**
     * Prepare and return an extra asset config.
     *
     * @param string|array $asset extra asset config.
     *
     * @throws InvalidConfigException if the configuration is invalid.
     *
     * @return array
     */
    private function getExtraAssetConfig($asset): array
    {
        $config = [];
        if (is_string($asset)) {
            $config['class'] = $asset;
        } else {
            $config = $asset;
        }
        if (false === array_key_exists('class', $config)) {
            throw new InvalidConfigException('Object configuration must be an array containing a "class" element.');
        }

        return $config;
    }
}


1			<?php
2
3			namespace Itstructure\AdminModule\components;
4
5			use yii\web\View;
6			use yii\base\InvalidConfigException;
7			use Itstructure\AdminModule\assets\AdminAsset;
8
9			/**
10			* Class AdminView
11			* Default view for the Admin View
12			*
13			* @property array $mainMenuConfig Sidebar menu config.
14			* @property string $bodyLayout Admin layout type.
15			* @property string $skin Admin layout theme. By default are used blue skin.
16			* @property null\|array\|string $assetBundleConfig AssetBundle config.
17			* @property string $homeUrl Home URL.
18			* @property array $extraAssets An array of extra asset. Each asset can be specified one of the following format:
19			* - a string thar represent a class name of extra asset;
20			* - an array that must contain a class key and may contain other settings of asset bundle.
21			* @see BaseYii::createObject()
22			* @property string[] $userBody This array contain a key->value pairs where key - is link name and value is link
23			* that will be rendered in "user-body" section of menu.
24			* @property string $defaultAssetBundleClass Asset bundle class-name using by default for admin view.
25			* @property string $companyName Company name.
26			* @property string $shotCompanyName Short company name.
27			* @property string $profileLink Link to user profile.
28			* @property string $signOutLink Link to sign-out action.
29			*
30			* @package Itstructure\AdminModule\components
31			*
32			* @author Andrey Girnik <[email protected]>
33			*/
34			class AdminView extends View
35			{
36			/**
37			* Layouts.
38			*/
39			const LAYOUT_FIXED = 'fixed';
40			const LAYOUT_SIDEBAR_MINI = 'sidebar-mini';
41			const LAYOUT_SIDEBAR_COLLAPSE = 'sidebar-collapse';
42			const LAYOUT_BOXED = 'layout-boxed';
43			const LAYOUT_TOP_NAV = 'layout-top-nav';
44
45			/**
46			* Skins.
47			*/
48			const SKIN_BLUE = 'skin-blue';
49			const SKIN_BLUE_LIGHT = 'skin-blue-light';
50			const SKIN_YELLOW = 'skin-yellow';
51			const SKIN_YELLOW_LIGHT = 'skin-yellow-light';
52			const SKIN_GREEN = 'skin-green';
53			const SKIN_GREEN_LIGHT = 'skin-green-light';
54			const SKIN_PURPLE = 'skin-purple';
55			const SKIN_PURPLE_LIGHT = 'skin-purple-light';
56			const SKIN_RED = 'skin-red';
57			const SKIN_RED_LIGHT = 'skin-red-light';
58			const SKIN_BLACK = 'skin-black';
59			const SKIN_BLACK_LIGHT = 'skin-black-light';
60
61			/**
62			* Sidebar menu config.
63			*
64			* @var array
65			*/
66			public $mainMenuConfig = [];
67
68			/**
69			* Admin layout type.
70			*
71			* @var string
72			*/
73			public $bodyLayout = self::LAYOUT_SIDEBAR_MINI;
74
75			/**
76			* Admin layout theme. By default are used blue skin.
77			*
78			* @var string
79			*/
80			public $skin = self::SKIN_BLUE;
81
82			/**
83			* AssetBundle config.
84			*
85			* @var null\|array\|string
86			*/
87			public $assetBundleConfig = null;
88
89			/**
90			* Home URL.
91			*
92			* @var string
93			*/
94			public $homeUrl = '/admin';
95
96			/**
97			* An array of extra asset. Each asset can be specified one of the following format:
98			* - a string thar represent a class name of extra asset;
99			* - an array that must contain a class key and may contain other settings of asset bundle.
100			*
101			* @see BaseYii::createObject()
102			*
103			* @var array
104			*/
105			public $extraAssets = [];
106
107			/**
108			* This array contain a key->value pairs where key - is link name and value is link
109			* that will be rendered in "user-body" section of menu.
110			*
111			* @var string[]
112			*/
113			public $userBody = [];
114
115			/**
116			* Asset bundle class-name using by default for admin view.
117			*
118			* @var string
119			*/
120			private $defaultAssetBundleClass = AdminAsset::class;
121
122			/**
123			* Company name.
124			*
125			* @var string
126			*/
127			public $companyName = 'Company';
128
129			/**
130			* Short company name.
131			*
132			* @var string
133			*/
134			public $shotCompanyName = '';
135
136			/**
137			* Link to user profile.
138			*
139			* @var string
140			*/
141			public $profileLink = '/profile';
142
143			/**
144			* Link to sign-out action.
145			*
146			* @var string
147			*/
148			public $signOutLink = '/site/logout';
149
150			/**
151			* Initializes the object.
152			*
153			* @return void
154			*/
155			public function init(): void
156			{
157			$this->registerAdminAsset();
158			$this->registerExtraAssets();
159			}
160
161			/**
162			* Register a main admin asset.
163			*
164			* @return void
165			*/
166			private function registerAdminAsset(): void
167			{
168			$assetConfig = $this->getAdminAssetConfig();
169			$this->registerAsset($assetConfig);
170			}
171
172			/**
173			* Register an extra assets.
174			*
175			* @return void
176			*/
177			private function registerExtraAssets(): void
178			{
179			foreach ($this->extraAssets as $asset) {
180			$assetConfig = $this->getExtraAssetConfig($asset);
181			$this->registerAsset($assetConfig);
182			}
183			}
184
185			/**
186			* Register an asset bundle in view.
187			*
188			* @param array $assetConfig config of asset bundle.
189			*
190			* @return void
191			*/
192			private function registerAsset(array $assetConfig): void
193			{
194			$assetClassName = $assetConfig['class'];
195			$this->assetManager->bundles[$assetClassName] = $assetConfig;
196			if (method_exists($assetClassName, 'register')) {
197			call_user_func([
198			$assetClassName,
199			'register',
200			], $this);
201			}
202			}
203
204			/**
205			* Return config array for create instance of AssetBundle.
206			*
207			* @return array
208			*/
209			private function getAdminAssetConfig(): array
210			{
211			$config = $this->assetBundleConfig;
212			if (null === $config) {
213			$config = [];
214			}
215			if (is_string($config)) {
216			$config['class'] = $config;
217			}
218			if (is_array($config) && !array_key_exists('class', $config)) {
219			$config['class'] = $this->defaultAssetBundleClass;
220			if (array_key_exists('skin', $config)) {
221			$config['skin'] = $this->skin;
222			}
223			}
224
225			return $config;
			0 ignored issues – show Bug Best Practice introduced 2021-04-23 09:41 UTC by Report Bug Copy Issue Report The expression `return $config` could return the type `string` which is incompatible with the type-hinted return `array`. Consider adding an additional type-check to rule them out. Loading history...
226			}
227
228			/**
229			* Prepare and return an extra asset config.
230			*
231			* @param string\|array $asset extra asset config.
232			*
233			* @throws InvalidConfigException if the configuration is invalid.
234			*
235			* @return array
236			*/
237			private function getExtraAssetConfig($asset): array
238			{
239			$config = [];
240			if (is_string($asset)) {
241			$config['class'] = $asset;
242			} else {
243			$config = $asset;
244			}
245			if (false === array_key_exists('class', $config)) {
246			throw new InvalidConfigException('Object configuration must be an array containing a "class" element.');
247			}
248
249			return $config;
250			}
251			}
252

itstructure / yii2-admin-module

AdminView::getAdminAssetConfig() A last analyzed 2025-10-20 07:39 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

AdminView::getAdminAssetConfig() A
last analyzed 2025-10-20 07:39 UTC