Логотип

Документация по макросам и шаблонам UMI.CMS

data getProperty()

Название

%data getProperty()% — Выводит свойство страницы по определенному шаблону.

Параметры: data getProperty(element_id, prop_name [, template = 'default', is_random = '0'])

element_id

id страницы, для которой необходимо вывести свойство.

prop_name

Название свойства, которое необходимо вывести. В модуле «Шаблоны данных» это поле называется «Идентификатор».

template

Имя шаблона, по которому следует вывести свойство.

is_random

Этот параметр используется только при выводе значения полей типа «Ссылка на дерево», либо «Выпадающий список с множественным выбором». Если параметр is_random равен «1», то из списка значений будет случайным образом выбрана только 1 страница, либо объект. Для всех остальных типов полей этот параметр макроса игнорируется.

Описание

Этот макрос выводит свойство prop_name, у страницы, указанной в параметре element_id. Вывод свойства осуществляется по шаблону, указанному в параметре template. Вы можете не указывать этот параметр, в этом случае для вывода свойства будет использован шаблон по умолчанию — default.tpl.

Использование лишено смысла. Любое свойство страницы может быть получено по протоколу UPage (см. «Страницы: протокол UPage»). Для этого надо написать имя свойства (значение атрибута name для элемента property) через символ "." (точка) после вызова по протоколу UPage.

Предположим, для страницы с id ="13" мы запросили заголовок h1. Тогда ответ по протоколу Upage будет выглядеть следующим образом:

<udata generation-time="0.003365">
  <property id="13" name="h1" type="string">
    <title>Поле H1</title>
    <value>Политические новости</value>
  </property>
</udata>

Отобразить это свойство можно, например, так:

<xsl:value-of select="document('upage://13.h1')/udata/property/value" />

Используемые шаблоны

Макрос оперирует шаблонами, находящимися в каталоге /tpls/data/.

Используемые блоки шаблона

string

Выводит содержимое для полей типа «Строка».

%field_id%

Выводит числовой идентификатор поля.

%title%

Выводит название поля.

%name%

Выводит идентификатор поля.

%value%

Выводит значение поля

%template%

Выводит текущий шаблон, используемый при выводе свойства для последующего использования во вложенных макросах.

string_empty

Используется в том случае, если необходимо вывести на страницу сообщение о том, что значение поля типа «Строка» пустое.

int

Выводит содержимое для полей типа «Число».

%field_id%

Выводит числовой идентификатор поля.

%title%

Выводит название поля.

%name%

Выводит идентификатор поля.

%value%

Выводит значение поля.

%template%

Выводит текущий шаблон, используемый при выводе свойства для последующего использования во вложенных макросах.

int_empty

Используется в том случае, если необходимо вывести на страницу сообщение о том, что значение поля типа «Число» пустое.

float

Выводит содержимое для полей типа «Число с точкой».

%field_id%

Выводит числовой идентификатор поля.

%title%

Выводит название поля.

%name%

Выводит идентификатор поля.

%value%

Выводит значение поля.

%template%

Выводит текущий шаблон, используемый при выводе свойства для последующего использования во вложенных макросах.

float_empty

Используется в том случае, если необходимо вывести на страницу сообщение о том, что значение поля типа «Число с точкой» пустое.

price

Выводит содержимое для полей типа «Цена». На данный момент его поведение аналогично блоку int.

%field_id%

Выводит числовой идентификатор поля.

%title%

Выводит название поля.

%name%

Выводит идентификатор поля.

%value%

Выводит значение поля.

%template%

Выводит текущий шаблон, используемый при выводе свойства для последующего использования во вложенных макросах.

price_empty

Используется в том случае, если необходимо вывести на страницу сообщение о том, что значение поля типа «Цена» пустое.

text

Выводит содержимое для полей типа «Простой текст».

%field_id%

Выводит числовой идентификатор поля.

%title%

Выводит название поля.

%name%

Выводит идентификатор поля.

%value%

Выводит значение поля.

%template%

Выводит текущий шаблон, используемый при выводе свойства для последующего использования во вложенных макросах.

text_empty

Используется в том случае, если необходимо вывести на страницу сообщение о том, что значение поля типа «Простой текст» пустое.

date

Выводит содержимое для полей типа «Дата».

%field_id%

Выводит числовой идентификатор поля.

%name%

Выводит строковый идентификатор поля.

%title%

Выводит название поля.

%timestamp%

Выводит значение поля в формате timestamp.

%value%

Выводит значение поля в формате YYYY-MM-DD HH:MI:SS.

%template%

Выводит текущий шаблон, используемый при выводе свойства для последующего использования во вложенных макросах.

wysiwyg

Выводит содержимое для полей типа «HTML-текст». Его поведение аналогично блоку text.

%field_id%

Выводит числовой идентификатор поля.

%title%

Выводит название поля.

%name%

Выводит идентификатор поля.

%value%

Выводит значение поля.

%template%

Выводит текущий шаблон, используемый при выводе свойства для последующего использования во вложенных макросах.

wysiwyg_empty

Используется в том случае, если необходимо вывести на страницу сообщение о том, что значение поля типа "HTML-текст" пустое.

file

Выводит содержимое для полей типа «Файл».

%field_id%

Выводит числовой идентификатор поля.

%title%

Выводит название поля.

%name%

Выводит идентификатор поля.

%value%

Выводит значение поля.

%filename%

Имя файла, который содержит выводимое поле.

%filepath%

Путь к файлу в файловой системе (относительный, либо абсолютный).

%src%

Путь к файлу относительно корня сайта. Обычно используется для создания ссылок на файл.

%size%

Размер файла в байтах.

%ext%

Расширение файла (например, «exe», «swf»).

%template%

Выводит текущий шаблон, используемый при выводе свойства для последующего использования во вложенных макросах.

%maxsize%

Выводит максимальный размер загружаемого файла (в Мб).

file_empty

Используется в том случае, если необходимо вывести на страницу сообщение о том, что значение поля типа «Файл» пустое.

img_file

Выводит содержимое для полей типа «Изображение».

%field_id%

Выводит числовой идентификатор поля.

%title%

Выводит название поля.

%name%

Выводит идентификатор поля.

%value%

Выводит значение поля.

%filename%

Имя файла, который содержит выводимое поле.

%filepath%

Путь к файлу в файловой системе (относительный, либо абсолютный).

%src%

Путь к файлу относительно корня сайта. Обычно используется для создания ссылок на файл.

%size%

Размер файла в байтах.

%ext%

Расширение файла (например, «gif», «jpeg», «png»).

%width%

Ширина изображения в пикселях.

%height%

Высота изображения в пикселях.

%template%

Выводит текущий шаблон, используемый при выводе свойства для последующего использования во вложенных макросах.

%maxsize%

Выводит максимальный размер загружаемого файла (в Мб).

img_file_empty

Используется в том случае, если необходимо вывести на страницу сообщение о том, что значение поля типа «Изображение» пустое.

boolean_yes

Этот шаблон используется для полей типа «Кнопка-флажок», которое обозначает значения «да/нет». Если значение поля равно «да» (в редактировании у этого поля стоит галочка, либо каким-либо другим способом оно установлено в значение «true»), то используется этот блок. В противном случае выводится блок boolean_no.

%field_id%

Выводит числовой идентификатор поля.

%title%

Выводит название поля.

%name%

Выводит идентификатор поля.

%template%

Выводит текущий шаблон, используемый при выводе свойства для последующего использования во вложенных макросах

swf_file

Выводит содержимое для полей типа «Флеш-ролик».

%field_id%

Выводит числовой идентификатор поля.

%title%

Выводит название поля.

%name%

Выводит идентификатор поля.

%value%

Выводит значение поля.

%filename%

Имя файла, который содержит выводимое поле.

%filepath%

Путь к файлу в файловой системе (относительный, либо абсолютный).

%src%

Путь к файлу относительно корня сайта. Обычно используется для создания ссылок на файл.

%size%

Размер файла в байтах.

%ext%

Расширение файла («swf»).

%template%

Выводит текущий шаблон, используемый при выводе свойства для последующего использования во вложенных макросах.

%maxsize%

Выводит максимальный размер загружаемого файла (в Мб).

video_file

Выводит содержимое для полей типа «Видео-ролик».

%field_id%

Выводит числовой идентификатор поля.

%title%

Выводит название поля.

%name%

Выводит идентификатор поля.

%value%

Выводит значение поля.

%filename%

Имя файла, который содержит выводимое поле.

%filepath%

Путь к файлу в файловой системе (относительный, либо абсолютный).

%src%

Путь к файлу относительно корня сайта. Обычно используется для создания ссылок на файл.

%size%

Размер файла в байтах.

%ext%

Расширение файла.

%template%

Выводит текущий шаблон, используемый при выводе свойства

%maxsize%

Выводит максимальный размер загружаемого файла (в Мб).

boolean_no

Используется для полей типа «Кнопка-флажок» в том случае, если не выполнено ни одно из условий, позволяющих использовать блок boolean_yes.

%field_id%

Выводит числовой идентификатор поля.

%title%

Выводит название поля.

%name%

Выводит идентификатор поля.

%template%

Выводит текущий шаблон, используемый при выводе свойства для последующего использования во вложенных макросах.

maxsize

relation

Выводит содержимое для полей типа «Выпадающий список», которое содержит выбранный элемент справочника.

%field_id%

Выводит числовой идентификатор поля.

%title%

Выводит название поля.

%name%

Выводит идентификатор поля.

%value%

Выводит значение поля (в данном случае — название элемента справочника

%object_id%

Выводит id объекта, который можно использовать для вывода свойств элемента справочника через макросы %data getPropertyOfObject()% , %data getPropertyGroupOfObject()% или %data getAllGroupsOfObject()% .

%template%

Выводит текущий шаблон, используемый при выводе свойства для последующего использования во вложенных макросах.

relation_empty

Используется в том случае, если необходимо вывести на страницу сообщение о том, что значение поля типа «Выпадающий список» пустое.

relation_mul_block

Блок вывода содержимого для полей типа «Выпадающий список с множественным выбором», которое содержит список выбранных элементов справочника. Требует присутствия блоков relation_mul_item и relation_mul_quant.

%field_id%

Выводит числовой идентификатор поля.

%title%

Выводит название поля.

%name%

Выводит идентификатор поля.

%items%

Выводит список значений используя блок relation_mul_item .

%template%

Выводит текущий шаблон, используемый при выводе свойства для последующего использования во вложенных макросах.

relation_mul_item

Выводит отдельное значение для поля типа «Выпадающий список с множественным выбором».

%field_id%

Выводит числовой идентификатор поля.

%value%

Выводит значение поля (в данном случае — название элемента справочника.

%object_id%

Выводит id объекта, который можно использовать для вывода свойств элемента справочника через макросы %data getPropertyOfObject()% , %data getPropertyGroupOfObject()% или %data getAllGroupsOfObject()% .

%quant%

Позволяет установить квантификатор (разделитель) между значениями. Использует блок relation_mul_quant .

%list-class-first%

в случае, если элемент первый, выводит "first"

%list-class-last%

в случае, если элемент последний, выводит "last"

%list-class-odd%

в случае, если элемент четный, выводит "odd"

%list-class-even%

в случае, если элемент нечетный, выводит "even"

%list-position%

вставляет порядковый номер в списке

relation_mul_quant

Выводит разделитель для полей типа «Выпадающий список с множественным выбором». Обычно содержит «,» или другой стандартный разделитель.

relation_mul_block_empty

Используется в том случае, если необходимо вывести на страницу сообщение о том, что значение поля типа «Выпадающий список с множественным выбором» пустое.

symlink_block

Блок вывода содержимого для полей типа «Ссылка на дерево», которое содержит список выбранных страниц из дерева сайта. Требует присутствия блоков symlink_item и symlink_quant.

%field_id%

Выводит числовой идентификатор поля.

%title%

Выводит название поля.

%name%

Выводит идентификатор поля.

%items%

Выводит список значений используя блок symlink_item .

%template%

Выводит текущий шаблон, используемый при выводе свойства для последующего использования во вложенных макросах.

symlink_item

Выводит отдельное значение для поля типа «Ссылка на дерево».

%field_id%

Выводит числовой идентификатор поля.

%value%

Выводит значение поля (в данном случае — название страницы).

%link%

Выводит ссылку на страницу.

%id%

Выводит id страницы. Можно использовать для вывода свойств страницы через макросы %data.getProperty%, %data.getPropertyGroup% или data.getAllGroups.

%object_id%

Выводит id объекта, который является объектом-источником данных для страницы. Можно использовать для вывода свойств страницы через макросы %data getPropertyOfObject()% , %data getPropertyGroupOfObject()% или %data getAllGroupsOfObject()% .

%quant%

Позволяет установить квантификатор (разделитель) между значениями. Использует блок symlink_quant .

%list-class-first%

в случае, если элемент первый, выводит "first"

%list-class-last%

в случае, если элемент последний, выводит "last"

%list-class-odd%

в случае, если элемент четный, выводит "odd"

%list-class-even%

в случае, если элемент нечетный, выводит "even"

%list-position%

вставляет порядковый номер в списке

symlink_quant

Выводит разделитель для полей типа «Ссылка на дерево». Обычно содержит «,» или другой стандартный разделитель.

symlink_block_empty

Используется в том случае, если необходимо вывести на страницу сообщение о том, что значение поля типа «Ссылка на дерево» пустое.

 

tags_block

Требует присутствия блоков tags_item и tags_empty.

%field_id%

Выводит числовой идентификатор поля.

%items%

Выводит список значений, используя блок tags_item .

 

tags_item

Выводит имя тега.

%field_id%

Выводит числовой идентификатор поля.

%tag%

Выводит имя тега.

%name%

Выводит имя тега.

 

tags_empty

Используется в том случае, если необходимо вывести на страницу сообщение о том, что значение поля типа «Тег» пустое.

 

optioned_block

Выводит содержимое для опционного поля, которое содержит список выбранных элементов справочника.

%field_id%

Выводит id поля.

%field_name%

Выводит имя поля.

%name%

Выводит имя поля.

%title%

Выводит название поля.

%items%

Выводит отдельное значение для поля.

optioned_block_empty

Используется в том случае, если необходимо вывести на страницу сообщение о том, что значение поля типа «Опционное» пустое.

%field_id%

Выводит id поля.

%field_name%

Выводит имя поля.

%name%

Выводит имя поля.

%title%

Выводит название поля.

%items%

Выводит отдельное значение для поля.

optioned_item

Выводит отдельное значение поля типа optioned.

%field_id%

Выводит числовой идентификатор поля.

%int%

Выводит числовое значение поля.

%float%

Выводит значение поля типа "число с точкой".

%text%

Выводит текстовое значение поля.

Значения int, float, text могут быть пустыми.

%varchar%

Выводит строковое значение поля.

%field_name%

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

Значения, которые появляются, если поле справочник не пустое:

%object-id%

Выводит id объекта для значения справочника.

%object-name%

Выводит имя объекта для значения справочника.

Если имеется ссылка на дерево, то появляются также значения:

%element-id%

Выводит id дерева, на которое ссылается поле.

%element-name%

Выводит имя дерева, на которое ссылается поле.

%element-link%

Выводит ссылку на дерево.

multiple_images

Выводит содержимое для поля типа "Набор изображений".

%field_id%

Выводит числовой идентификатор поля.

%name%

Выводит строковой идентификатор поля.

%title%

Выводит название поля.

%template%

Имя используемого шаблона.

%items%

Выводи значения поля, которые отображаются по шаблону блока multiple_images_item.

multiple_images_item

Выводит отдельное изображения поля типа "Набор изображений".

%size%

Выводит размер изображения.

%filename%

Выводит имя файла.

%filepath%

Выводит полный путь до файла.

%src%

Выводит относительный путь до файла.

%ext%

Выводи расширение файла.

%alt%

Выводи альтернативный текст изображения.

multiple_images_empty

Используется в том случае, если необходимо вывести на страницу сообщение о том, что значение поле типа "Набор изображений" пустое.

Примеры использования

Зайдите в редактирование типа данных «Раздел сайта \ Страница контента». Добавьте новое свойство типа «Строка» с названием «Тестовое свойство» и идентификатором «test_property».

Откройте для редактирования страницу контента. Внизу должно появиться поле для ввода «Тестовое свойство». Введите туда фразу «Тестовое значение».

В поле HTML-редактор вставьте макрос: %data getProperty(%pid%, 'test_property', 'sample')%.

В папке /tpls/data создайте файл sample.tpl, который содержит следующий пример:


	<?php
	$FORMS = Array();

	$FORMS['string'] = <<<END
	Значение поля <b>%title%</b> равно <span style='color: red;'>"%value%"</span>
	END;
	?>

Зайдите на страницу, которую вы редактировали. Вы увидите надпись «Значение поля Тестовое свойство равно 'Тестовое значение'».