AdminInterface::fields() - Code Metrics - nook-ru/digitalwand.admin_helper - Measure and Improve Code Quality continuously with Scrutinizer

AdminInterface::fields()
last analyzed 2017-03-14 19:11 UTC

↳ Parent: AdminInterface

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
nc	1
dl	0
loc	1
c	0
b	0
f	0

<?php

namespace DigitalWand\AdminHelper\Helper;

/**
 * Базовый класс для описания админского интерфейса.
 * Включает в себя методы описывающие элементы управления, названия столбцов, типы полей и т.д.
 *
 * Есть 2 метода которые обязательно должны быть описаны в реализуемых классах:
 *
 * getFields()  - должен возвращать массив со списком табов и описанием полей для каждого таба
 * getHelpers() - должен возваращать массив со списком классов хелперов, также может включать
 * описание настроек элементов управления для хелпера.
 *
 * Для того что бы модуль мог корректна работать необходима регистрация классов унаследованных от AdminInterface.
 * Это можно сделтаь в include.php другого модуля(не рекомендуется) или AdminInterface зарегистрируется
 * автоматически если при генерации ссылок на страницы админского интерфейса использовался статический
 * метод getLink из соответствующего хелпера (ListHelper для списка элементов и EditHelper для страницы редактирования)
 *
 * При использовании разделов необходимо уведомить AdminInterface элементов и AdminInterface разделов о существовании
 * друг друга, что бы каждый из них регистрировал другого в момент собственной регистрации. Для этого достаточно указать полное
 * имя класса в методе getDependencies(), это нужно сделать как для AdminInterface элементов так и для AdminInterface разделов.
 *
 * @author Nik Samokhvalov <[email protected]>
 * @author Artem Yarygin <[email protected]>
 */
abstract class AdminInterface
{
	/**
	 * Список зарегистрированных интерфейсов
	 * @var string
	 */
	public static $registeredInterfaces = array();

	/**
	 * Описание интерфейса админки: списка табов и полей. Метод должен вернуть массив вида:
	 *
	 * ```
	 * array(
	 *    'TAB_1' => array(
	 *        'NAME' => Loc::getMessage('VENDOR_MODULE_ENTITY_TAB_1_NAME'),
	 *        'FIELDS' => array(
	 *            'FIELD_1' => array(
	 *                'WIDGET' => new StringWidget(),
	 *                'TITLE' => Loc::getMessage('VENDOR_MODULE_ENTITY_FIELD_1_TITLE'),
	 *                ...
	 *            ),
	 *            'FIELD_2' => array(
	 *                'WIDGET' => new NumberWidget(),
	 *                'TITLE' => Loc::getMessage('VENDOR_MODULE_ENTITY_FIELD_2_TITLE'),
	 *                ...
	 *            ),
	 *            ...
	 *        )
	 *    ),
	 *    'TAB_2' => array(
	 *        'NAME' => Loc::getMessage('VENDOR_MODULE_ENTITY_TAB_2_NAME'),
	 *        'FIELDS' => array(
	 *            'FIELD_3' => array(
	 *                'WIDGET' => new DateTimeWidget(),
	 *                'TITLE' => Loc::getMessage('VENDOR_MODULE_ENTITY_FIELD_3_TITLE'),
	 *                ...
	 *            ),
	 *            'FIELD_4' => array(
	 *                'WIDGET' => new UserWidget(),
	 *                'TITLE' => Loc::getMessage('VENDOR_MODULE_ENTITY_FIELD_4_TITLE'),
	 *                ...
	 *            ),
	 *            ...
	 *        )
	 *    ),
	 *  ...
	 * )
	 * ```
	 *
	 * Где TAB_1..2 - символьные коды табов, FIELD_1..4 - название столбцов в таблице сущности. TITLE для поля задавать
	 * не обязательно, в этому случае он будет запрашиваться из модели.
	 *
	 * Более подробную информацию о формате описания настроек виджетов см. в классе HelperWidget.
	 *
	 * @see DigitalWand\AdminHelper\Widget\HelperWidget
	 *
	 * @return array[]
	 */
	abstract public function fields();

	/**
	 * Список классов хелперов с настройками. Метод должен вернуть массив вида:
	 *
	 * ```
	 * array(
	 *    '\Vendor\Module\Entity\AdminInterface\EntityListHelper' => array(
	 *        'BUTTONS' => array(
	 *            'RETURN_TO_LIST' => array('TEXT' => Loc::getMessage('VENDOR_MODULE_ENTITY_RETURN_TO_LIST')),
	 *            'ADD_ELEMENT' => array('TEXT' => Loc::getMessage('VENDOR_MODULE_ENTITY_ADD_ELEMENT'),
	 *            ...
	 *        )
	 *    ),
	 *    '\Vendor\Module\Entity\AdminInterface\EntityEditHelper' => array(
	 *        'BUTTONS' => array(
	 *            'LIST_CREATE_NEW' => array('TEXT' => Loc::getMessage('VENDOR_MODULE_ENTITY_LIST_CREATE_NEW')),
	 *            'LIST_CREATE_NEW_SECTION' => array('TEXT' => Loc::getMessage('VENDOR_MODULE_ENTITY_LIST_CREATE_NEW_SECTION'),
	 *            ...
	 *        )
	 *    )
	 * )
	 * ```
	 *
	 * или
	 *
	 * ```
	 * array(
	 *    '\Vendor\Module\Entity\AdminInterface\EntityListHelper',
	 *    '\Vendor\Module\Entity\AdminInterface\EntityEditHelper'
	 * )
	 * ```
	 *
	 * Где:
	 * <ul>
	 * <li> `Vendor\Module\Entity\AdminInterface` - namespace до реализованных классов AdminHelper.
	 * <li> `BUTTONS` - ключ для массива с описанием элементов управления (подробнее в методе getButton()
	 *          класса AdminBaseHelper).
	 * <li> `LIST_CREATE_NEW`, `LIST_CREATE_NEW_SECTION`, `RETURN_TO_LIST`, `ADD_ELEMENT` - символьные код элементов
	 *          управления.
	 * <li> `EntityListHelper` и `EntityEditHelper` - реализованные классы хелперов.
	 *
	 * Оба формата могут сочетаться друг с другом.
	 *
	 * @see \DigitalWand\AdminHelper\Helper\AdminBaseHelper::getButton()
	 *
	 * @return string[]
	 */
	abstract public function helpers();

	/**
	 * Список зависимых админских интерфейсов, которые будут зарегистрированы при регистраци админского интерфейса,
	 * например, админские интерфейсы разделов.
	 *
	 * @return string[]
	 */
	public function dependencies()
	{
		return array();
	}

	/**
	 * Регистрируем поля, табы и кнопки.
	 */
	public function registerData()
	{
		$fieldsAndTabs = array('FIELDS' => array(), 'TABS' => array());
		$tabsWithFields = $this->fields();

		// приводим массив хелперов к формату класс => настройки
		$helpers = array();

		foreach ($this->helpers() as $key => $value) {
			if (is_array($value)) {
				$helpers[$key] = $value;
			}
			else {
				$helpers[$value] = array();
			}
		}

		$helperClasses = array_keys($helpers);
		/**
		 * @var \Bitrix\Main\Entity\DataManager
		 */
		$model = $helperClasses[0]::getModel();

		foreach ($tabsWithFields as $tabCode => $tab) {
			$fieldsAndTabs['TABS'][$tabCode] = $tab['NAME'];

			foreach ($tab['FIELDS'] as $fieldCode => $field) {
				if (empty($field['TITLE']) && $model) {
					$field['TITLE'] = $model::getEntity()->getField($fieldCode)->getTitle();
				}

				$field['TAB'] = $tabCode;
				$fieldsAndTabs['FIELDS'][$fieldCode] = $field;
			}
		}

		AdminBaseHelper::setInterfaceSettings($fieldsAndTabs, $helpers, $helperClasses[0]::getModule());


		foreach ($helperClasses as $helperClass) {
			/**
			 * @var AdminBaseHelper $helperClass
			 */
			$helperClass::setInterfaceClass(get_called_class());
		}
	}

	/**
	 * Регистрация интерфейса и его зависимостей.
	 */
	public static function register()
	{
		if (!in_array(get_called_class(), static::$registeredInterfaces)) {
			static::$registeredInterfaces[] = get_called_class();

			$adminInterface = new static();
			$adminInterface->registerData();

			foreach ($adminInterface->dependencies() as $adminInterfaceClass) {
				$adminInterfaceClass::register();
			}
		}
	}
}

1			<?php
2
3			namespace DigitalWand\AdminHelper\Helper;
4
5			/**
6			* Базовый класс для описания админского интерфейса.
7			* Включает в себя методы описывающие элементы управления, названия столбцов, типы полей и т.д.
8			*
9			* Есть 2 метода которые обязательно должны быть описаны в реализуемых классах:
10			*
11			* getFields() - должен возвращать массив со списком табов и описанием полей для каждого таба
12			* getHelpers() - должен возваращать массив со списком классов хелперов, также может включать
13			* описание настроек элементов управления для хелпера.
14			*
15			* Для того что бы модуль мог корректна работать необходима регистрация классов унаследованных от AdminInterface.
16			* Это можно сделтаь в include.php другого модуля(не рекомендуется) или AdminInterface зарегистрируется
17			* автоматически если при генерации ссылок на страницы админского интерфейса использовался статический
18			* метод getLink из соответствующего хелпера (ListHelper для списка элементов и EditHelper для страницы редактирования)
19			*
20			* При использовании разделов необходимо уведомить AdminInterface элементов и AdminInterface разделов о существовании
21			* друг друга, что бы каждый из них регистрировал другого в момент собственной регистрации. Для этого достаточно указать полное
22			* имя класса в методе getDependencies(), это нужно сделать как для AdminInterface элементов так и для AdminInterface разделов.
23			*
24			* @author Nik Samokhvalov <[email protected]>
25			* @author Artem Yarygin <[email protected]>
26			*/
27			abstract class AdminInterface
28			{
29			/**
30			* Список зарегистрированных интерфейсов
31			* @var string
32			*/
33			public static $registeredInterfaces = array();
34
35			/**
36			* Описание интерфейса админки: списка табов и полей. Метод должен вернуть массив вида:
37			*
38			* ```
39			* array(
40			* 'TAB_1' => array(
41			* 'NAME' => Loc::getMessage('VENDOR_MODULE_ENTITY_TAB_1_NAME'),
42			* 'FIELDS' => array(
43			* 'FIELD_1' => array(
44			* 'WIDGET' => new StringWidget(),
45			* 'TITLE' => Loc::getMessage('VENDOR_MODULE_ENTITY_FIELD_1_TITLE'),
46			* ...
47			* ),
48			* 'FIELD_2' => array(
49			* 'WIDGET' => new NumberWidget(),
50			* 'TITLE' => Loc::getMessage('VENDOR_MODULE_ENTITY_FIELD_2_TITLE'),
51			* ...
52			* ),
53			* ...
54			* )
55			* ),
56			* 'TAB_2' => array(
57			* 'NAME' => Loc::getMessage('VENDOR_MODULE_ENTITY_TAB_2_NAME'),
58			* 'FIELDS' => array(
59			* 'FIELD_3' => array(
60			* 'WIDGET' => new DateTimeWidget(),
61			* 'TITLE' => Loc::getMessage('VENDOR_MODULE_ENTITY_FIELD_3_TITLE'),
62			* ...
63			* ),
64			* 'FIELD_4' => array(
65			* 'WIDGET' => new UserWidget(),
66			* 'TITLE' => Loc::getMessage('VENDOR_MODULE_ENTITY_FIELD_4_TITLE'),
67			* ...
68			* ),
69			* ...
70			* )
71			* ),
72			* ...
73			* )
74			* ```
75			*
76			* Где TAB_1..2 - символьные коды табов, FIELD_1..4 - название столбцов в таблице сущности. TITLE для поля задавать
77			* не обязательно, в этому случае он будет запрашиваться из модели.
78			*
79			* Более подробную информацию о формате описания настроек виджетов см. в классе HelperWidget.
80			*
81			* @see DigitalWand\AdminHelper\Widget\HelperWidget
82			*
83			* @return array[]
84			*/
85			abstract public function fields();
86
87			/**
88			* Список классов хелперов с настройками. Метод должен вернуть массив вида:
89			*
90			* ```
91			* array(
92			* '\Vendor\Module\Entity\AdminInterface\EntityListHelper' => array(
93			* 'BUTTONS' => array(
94			* 'RETURN_TO_LIST' => array('TEXT' => Loc::getMessage('VENDOR_MODULE_ENTITY_RETURN_TO_LIST')),
95			* 'ADD_ELEMENT' => array('TEXT' => Loc::getMessage('VENDOR_MODULE_ENTITY_ADD_ELEMENT'),
96			* ...
97			* )
98			* ),
99			* '\Vendor\Module\Entity\AdminInterface\EntityEditHelper' => array(
100			* 'BUTTONS' => array(
101			* 'LIST_CREATE_NEW' => array('TEXT' => Loc::getMessage('VENDOR_MODULE_ENTITY_LIST_CREATE_NEW')),
102			* 'LIST_CREATE_NEW_SECTION' => array('TEXT' => Loc::getMessage('VENDOR_MODULE_ENTITY_LIST_CREATE_NEW_SECTION'),
103			* ...
104			* )
105			* )
106			* )
107			* ```
108			*
109			* или
110			*
111			* ```
112			* array(
113			* '\Vendor\Module\Entity\AdminInterface\EntityListHelper',
114			* '\Vendor\Module\Entity\AdminInterface\EntityEditHelper'
115			* )
116			* ```
117			*
118			* Где:
119			* <ul>
120			* <li> `Vendor\Module\Entity\AdminInterface` - namespace до реализованных классов AdminHelper.
121			* <li> `BUTTONS` - ключ для массива с описанием элементов управления (подробнее в методе getButton()
122			* класса AdminBaseHelper).
123			* <li> `LIST_CREATE_NEW`, `LIST_CREATE_NEW_SECTION`, `RETURN_TO_LIST`, `ADD_ELEMENT` - символьные код элементов
124			* управления.
125			* <li> `EntityListHelper` и `EntityEditHelper` - реализованные классы хелперов.
126			*
127			* Оба формата могут сочетаться друг с другом.
128			*
129			* @see \DigitalWand\AdminHelper\Helper\AdminBaseHelper::getButton()
130			*
131			* @return string[]
132			*/
133			abstract public function helpers();
134
135			/**
136			* Список зависимых админских интерфейсов, которые будут зарегистрированы при регистраци админского интерфейса,
137			* например, админские интерфейсы разделов.
138			*
139			* @return string[]
140			*/
141			public function dependencies()
142			{
143			return array();
144			}
145
146			/**
147			* Регистрируем поля, табы и кнопки.
148			*/
149			public function registerData()
150			{
151			$fieldsAndTabs = array('FIELDS' => array(), 'TABS' => array());
152			$tabsWithFields = $this->fields();
153
154			// приводим массив хелперов к формату класс => настройки
155			$helpers = array();
156
157			foreach ($this->helpers() as $key => $value) {
158			if (is_array($value)) {
159			$helpers[$key] = $value;
160			}
161			else {
162			$helpers[$value] = array();
163			}
164			}
165
166			$helperClasses = array_keys($helpers);
167			/**
168			* @var \Bitrix\Main\Entity\DataManager
169			*/
170			$model = $helperClasses[0]::getModel();
			0 ignored issues – show Bug introduced 2017-03-14 09:51 UTC by Report Bug Copy Issue Report The method `getModel` cannot be called on `$helperClasses[0]` (of type `integer\|string`). Methods can only be called on objects. This check looks for methods being called on variables that have been inferred to never be objects. Loading history...
171			foreach ($tabsWithFields as $tabCode => $tab) {
172			$fieldsAndTabs['TABS'][$tabCode] = $tab['NAME'];
173
174			foreach ($tab['FIELDS'] as $fieldCode => $field) {
175			if (empty($field['TITLE']) && $model) {
176			$field['TITLE'] = $model::getEntity()->getField($fieldCode)->getTitle();
177			}
178
179			$field['TAB'] = $tabCode;
180			$fieldsAndTabs['FIELDS'][$fieldCode] = $field;
181			}
182			}
183
184			AdminBaseHelper::setInterfaceSettings($fieldsAndTabs, $helpers, $helperClasses[0]::getModule());
			0 ignored issues – show Bug introduced 2017-03-14 09:51 UTC by Report Bug Copy Issue Report The method `getModule` cannot be called on `$helperClasses[0]` (of type `integer\|string`). Methods can only be called on objects. This check looks for methods being called on variables that have been inferred to never be objects. Loading history...
185
186			foreach ($helperClasses as $helperClass) {
187			/**
188			* @var AdminBaseHelper $helperClass
189			*/
190			$helperClass::setInterfaceClass(get_called_class());
191			}
192			}
193
194			/**
195			* Регистрация интерфейса и его зависимостей.
196			*/
197			public static function register()
198			{
199			if (!in_array(get_called_class(), static::$registeredInterfaces)) {
200			static::$registeredInterfaces[] = get_called_class();
201
202			$adminInterface = new static();
203			$adminInterface->registerData();
204
205			foreach ($adminInterface->dependencies() as $adminInterfaceClass) {
206			$adminInterfaceClass::register();
207			}
208			}
209			}
210			}

nook-ru / digitalwand.admin_helper

AdminInterface::fields() last analyzed 2017-03-14 19:11 UTC

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

AdminInterface::fields()
last analyzed 2017-03-14 19:11 UTC