Подробное описание

API по работе с виджетами в админке

Открытые члены
	__construct ()

	setSiteId ($site_id)

	setUserId ($user_id)

	getMainList (&$total)

	insertWidget ($wclass, $column, $position=null, $mode=self::MODE_THREE_COLUMN)

	removeWidget ($widget_controller)

	getColumnFieldName ($mode)

	getPositionFieldName ($mode)

	moveWidget ($id, $to_column, $to_pos, $mode)

	getNextPos ($column, $mode)

	getWidgetRecord ($id)

	getFullList ($appendInfo=false, $return_only_unused=false)

	moduleWidgets ($module)

	getWidgetOut ($widget_controller, $param=[])

	issetWidget ($widget_controller)

	noWriteRights ()

	getWidgetByWClass ($wclass)

	getColumnsMode ()

	reCalculatePositions ()

Поля данных
const	MODE_ONE_COLUMN = 1

const	MODE_TWO_COLUMN = 2

const	MODE_THREE_COLUMN = 3

const	DEFAULT_MODE2_COLUMN = 1

const	DEFAULT_MODE3_COLUMN = 2

	$default_add_column = 'center'

	$obj = '\Main\Model\Orm\Widgets'

	$obj_instance

	$site_id

	$widget_folder = 'controller/admin/widget'

Защищенные члены
	moveToOtherColumn ($cur_widget, $to_column, $mode)

	sortInColumn ($cur_widget, $to_column, $to_pos, $mode)

	appendInfo (array $widget_list)

Защищенные данные
	$cur_user_id

Конструктор(ы)

__construct ( )

Методы

appendInfo ( array $widget_list )

protected

Добавляет информацию из базы(используется ли виджет) к списку виджетов.

Аргументы

array $widget_list - список записей о виджетах из базы

Возвращает: array

getColumnFieldName ( $mode )

Возвращает название поля для колонки для режима $mode

Аргументы

integer $mode - режим колоночности

Возвращает: string

getColumnsMode ( )

Возвращает возможные колоночные режимы

Возвращает: array

getFullList	(	$appendInfo = `false`,
		$return_only_unused = `false`
	)

Возвраает список всех виджетов в системе.

Аргументы

bool $appendInfo - если true, то будет добавлена дополнительная информация к виджетам.

Возвращает: array

getMainList ( & $total )

Возвращает список виджетов на главную страницу

Аргументы

integer $total - возвращает общее количество виджетов

Возвращает: array

getNextPos	(	$column,
		$mode
	)

Возвращает следующую позицию в колонке

Аргументы

integer	$column	- номер колонки, начиная от 1
integer	$mode	- режим колоночности

Возвращает: void

getPositionFieldName ( $mode )

Возвращает название поля в БД для позиции в колонке для режима $mode

Аргументы

integer $mode

Возвращает: string

getWidgetByWClass ( $wclass )

Возвращает объект виджета по названию класса

Аргументы

string $wclass

Возвращает: Orm

getWidgetOut	(	$widget_controller,
		$param = `[]`
	)

Возвращает HTML виджета, готовый для отображения

Аргументы

string	$widget_controller	- строковый идентификатор виджета
array	$param

getWidgetRecord ( $id )

Возвращает запись о виджете на рабочем столе

Аргументы

integer $id

Возвращает

insertWidget	(	$wclass,
		$column,
		$position = `null`,
		$mode = `self::MODE_THREE_COLUMN`
	)

Добавляет виджет. В режиме $mode добавляет виджет в заданную колонку и позицию. Во всех остальных режимах добавляет виджет в колонку по умолчанию в нулевую позицию (самая верхняя).

Аргументы

$wclass	- сокращенный идентификатор виджета
$column	- номер колонки для вставки, начиная с 1
$position	- позиция в колонке, начиная с 0. Если null, то виджет будет добавлен в конец
$mode	- режим колоночности

Возвращает

issetWidget ( $widget_controller )

Возвращает полное имя класса контроллера виджета или false, если контроллера не существует

Аргументы

string $widget_controller - строковый идентификатор виджета

Возвращает: string | false

moduleWidgets ( $module )

Возвращает список виджетов у модуля или пустой массив, если модулей нет.

Аргументы

string $module - Имя модуля

Возвращает: array

moveToOtherColumn	(	$cur_widget,
		$to_column,
		$mode
	)

protected

Перемещает виджет в новую колонку в конец

Аргументы

\Main\Model\Orm\Widgets	$cur_widget	- перемещаемый виджет
integer	$to_column	- колонка назначения
integer	$mode	- режим колоночности

Возвращает: mixed - возвращает позицию виджета в новой колонке

moveWidget	(	$id,
		$to_column,
		$to_pos,
		$mode
	)

Перемещение виджета по рабочему столу

Аргументы

integer	$id	- id виджета
integer	$to_column	- имя новой колонки
integer	$to_pos	- порядковый номер виджета в колонке, начиная с нуля
integer	$mode	- количество колонок в сетке (режим: 1,2 или 3)

Возвращает: void

noWriteRights ( )

Возвращает false, в случае если не ошибок, связанных с правами доступа, в противном случае возвращает текст ошибки

Возвращает: bool(false) | string

reCalculatePositions ( )

Пересчитывает порядковые номера всех виджетов во всех режимах колоночности в рамках текущего пользователя и сайта Актуально при удалении виджета

Возвращает: bool

removeWidget ( $widget_controller )

Удаляет виджет по короткому идентификатору виджета

Аргументы

$widget_controller - сокращенный идентификатор виджета

Возвращает: void

setSiteId ( $site_id )

Устанавливает сайт, в рамках которого будут строиться выборки

Аргументы

integer $site_id ID сайта

Возвращает: void

setUserId ( $user_id )

Устанавливает текущего пользователя. Выборки будут это учитывать.

sortInColumn	(	$cur_widget,
		$to_column,
		$to_pos,
		$mode
	)

protected

Сортирует виджеты в рамках одной колонки

Аргументы

\Main\Model\Orm\Widgets	$cur_widget	- перемещаемый виджет
integer	$to_column	- колонка назначения
integer	$to_pos	- позиция назначения
integer	$mode	- режим колоночности

Возвращает: void

Поля

$cur_user_id

protected

$default_add_column = 'center'

$obj = '\Main\Model\Orm\Widgets'

$obj_instance

$site_id

$widget_folder = 'controller/admin/widget'

const DEFAULT_MODE2_COLUMN = 1

const DEFAULT_MODE3_COLUMN = 2

const MODE_ONE_COLUMN = 1

const MODE_THREE_COLUMN = 3

const MODE_TWO_COLUMN = 2

Подробное описание

Открытые члены

Поля данных

Защищенные члены

Защищенные данные

Конструктор(ы)

Методы

Поля