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

Класс - тема отображения

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

	init ($fullname)

	getName ()

	getShade ()

	getContext ()

	getFullName ()

	getSelfPath ()

	getRelativePath ()

	getBlocksXmlFilename ()

	getBlocksXml ()

	getThemeXmlFilename ()

	getThemeXml ()

	getShades ()

	getInfo ()

	getPreviewUrl ($shade= '')

	setThisTheme ($options=null, $site_id=null, $context=null, $set_in_config=true)

	removeContext ($context=null, $site_id=null)

	getDefaultOptionValues ()

	getContextOptions ($site_id=null,\SimpleXMLElement $blocks_xml=null)

	resetContextOptions ($site_id=null, $blocks_xml=null)

	getGridSystem ($site_id=null)

Открытые статические члены
static	makeByContext ($context= 'theme', $shade=null)

Поля данных
	$template_path = SM_TEMPLATE_PATH

	$selfpath

	$simplexml

	$blocks_xml

	$relative_self_path

	$shade

	$name

	$context

	$fullname

Защищенные данные
	$preview_file = 'preview{SHADE}.jpg'

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

__construct ( $fullname )

Конструктор объектов - "Тема оформления"

Аргументы

string $fullname - Полный идентификатор темы < ИМЯ="" ПАПКИ="" ТЕМЫ>="">[(НАЗВАНИЕ ОТТЕНКА В СКОБКАХ)][;КОНТЕКСТ БЛОКОВ]

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

Методы

getBlocksXml ( )

Возвращает объект SimpleXml с настройками блоков

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

getBlocksXmlFilename ( )

Возвращает имя XML файла для текущей комплектации системы с информацией о структуре блоков

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

getContext ( )

Возвращает контекст темы

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

getContextOptions	(		$site_id = `null`,
		\SimpleXMLElement	$blocks_xml = `null`
	)

Возвращает объект с настройками темы в рамках контекста.

Аргументы

integer	$site_id	- ID сайта, если null, то текущий сайт
\SimpleXMLElement	$blocks_xml	- внешний blocks.xml файл, из которого будут загружены параметры темы.

Возвращает: | bool(false) False возвращается в случае, если модуль templates не обновлен и он еще не содержит класс настроек темы оформления

getDefaultOptionValues ( )

Возвращает значения параметров темы по умолчанию

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

getFullName ( )

Возвращает полный строковый идентификатор темы

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

getGridSystem ( $site_id = null )

Возвращает тип сеточного фреймворка, используемого темой оформления

Аргументы

integer $site_id - ID сайта, для которого необходимо вернуть сведения

Возвращает

getInfo ( )

Возвращает массив с базовой информацией о теме

getName ( )

Возвращает имя папки Темы (он же уникальный идентификатор темы)

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

getPreviewUrl ( $shade = '' )

Возвращает путь к preview изображения темы

Аргументы

mixed $shade

getRelativePath ( )

Возвращает путь к шаблону относительно корня

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

getSelfPath ( )

Возвращает путь к корневой папке темы

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

getShade ( )

Возвращает оттенок темы

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

getShades ( )

Возвращает массив со списком оттенков темы

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

getThemeXml ( )

Возвращает объект с конфигурацией темы

Возвращает

getThemeXmlFilename ( )

Возвращает путь к файлу theme.xml

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

init ( $fullname )

Инициализизирует тему оформления по полному идентификатору темы

Аргументы

string $fullname - Полный идентификатор темы < ИМЯ="" ПАПКИ="" ТЕМЫ>="">[(НАЗВАНИЕ ОТТЕНКА В СКОБКАХ)][;КОНТЕКСТ БЛОКОВ]

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

static makeByContext	(	$context = `'theme'`,
		$shade = `null`
	)

static

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

Аргументы

string	$context	контекст темы оформления, по умолчанию
	string	shade идентификатор цветовой вариации

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

removeContext	(	$context = `null`,
		$site_id = `null`
	)

Удаляет структуру блоков для идентификатора

Аргументы

string	$context	- идентификатор структуры блоков
integer	$site_id	- ID сайта

resetContextOptions	(	$site_id = `null`,
		$blocks_xml = `null`
	)

Сбрасывает настройки темы оформления в рамках контекста, которые описаны в объекте . Параметры темы, которые описаны в файле theme.xml не изменяются.

Аргументы

integer	$site_id	- ID сайта
\SimpleXMLElement \| false	$blocks_xml	- объект файла blocks.xml

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

setThisTheme	(	$options = `null`,
		$site_id = `null`,
		$context = `null`,
		$set_in_config = `true`
	)

Устанавливает тему в качестве действующей для текущего сайта

Аргументы

mixed	$options	- дополнительные параметры импорта (зарезервировано)
integer \| null	$site_id	- ID сайта, у которого будет установлена тема. Если Null, то у текущего
string	$context	- идентификатор структуры блоков.

Поля

$blocks_xml

$context

$fullname

$name

$preview_file = 'preview{SHADE}.jpg'

protected

$relative_self_path

$selfpath

$shade

$simplexml

$template_path = SM_TEMPLATE_PATH

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

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

Открытые статические члены

Поля данных

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

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

Методы

Поля