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