Все о разработке проектов на базе платформы XS2 Framework
Функции XS2 API
xs2GetNodes :: Объекты одного типа
Доступна в шаблоне
Доступна в процессоре
Эта функция возвращает набор объектов модуля mod в виде массива. Каждый его элемент в свою очередь представляет собой ассоциативный массив полей конкретного объекта. Ключами этого массива являются названия полей запрошенного типа NType. Объекты отбираются по записанному в синтаксисе SQL условию condition. Набор полей определяется параметром fields, а сортировка всего набора задается параметром sort. При вызове из шаблона (Smarty) результат оказывается в переменной с именем, которое задано в параметре var.
Параметры
NType(string)
Тип возвращаемого объекта
condition(string)
Дополнительное условие отбора (синтаксис SQL)
По умолчанию: пустое условие
fields(mixed)
Какие поля объекта возвращать
По умолчанию: 3
Варианты параметра:
int=1 - только общие поля объектов
int=2 - только дополнительные поля
int=3 - все поля
string - Список названий полей через запятую. Несуществующие в типе поля игнорируются.
array - Массив названий полей. Несуществующие в типе поля игнорируются.
linkDetail(mixed)
Какие поля связанных объектов возвращать
По умолчанию: 3
Варианты параметра:
int=1 - только общие поля объектов
int=2 - только дополнительные поля
int=3 - все поля
string - список названий полей через запятую. Несуществующие в типе поля игнорируются.
array - массив названий полей. Несуществующие в типе поля игнорируются.
sort(string)
Список полей, по которым сортируется набор.
mod(string)
Имя модуля, на котором выполняется функция
По умолчанию: текущий модуль
limit(int)
Ограничивает количество возвращаемых узлов.
prj(string)
Имя проекта, на котором произволятся действия. Возможность существует при условии, что у указанного проекта разрешен экспорт данных и текущий проект указан среди «доверенных проектов»
По умолчанию: текущий проект
var(string)
Название переменной, в которую будет возвращен результат работы функции