XS2 Online
Все о разработке проектов
на базе платформы XS2 Framework
Функции XS2 API
xs2GetBranch :: Дерево потомков объекта
 Доступна в шаблоне Доступна в процессоре
Эта функция возвращает из модуля mod в виде массива упорядоченный набор объектов, являющихся потомками для объекта с идентификатором ParId. Результат можно ограничить объектами типа NType и условием condition в синтаксисе SQL. Набор полей определяется параметром fields, а сортировка результата задается параметром sort. При вызове из шаблона (Smarty) результат оказывается в переменной с именем, которое задано в параметре var.
Стоит обратить внимание, что эта функция рекурсивно производит выборку по дереву. Это означает, что если задан параметр NType, то алгоритм прохода дерева будет пропускать те узлы, которые не являются узлами указанного типа, и не будет производить выборку их потомков даже если среди этих потомков есть узлы указанного типа. Приведем пример дерева:
Машины (NType='section')
Отечественные (NType='section')
ВАЗ (NType='brand')
Audi (NType='brand')
Битые (NType='section')
Новые (NType='section')
Разное (NType='section')
Если произвести выборку xsGetBranch с целью получить всех потомков узла "Машины" типа "section", то мы получим только узлы "Отечественные" и "Разное". В выборку не попадут узлы "Битые" и "Новые", поскольку при рекурсивном проходе с фильтром NType="section" алгоритм пропустит узел Audi.
|
|
|
Параметры
|
ParId
(int)
Идентификатор родительского, по отношению к запрашиваемым, объекта.
Обязательный параметр По умолчанию: 1
|
|
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)
Список полей, по которым сортируется набор.
|
|
limit
(int)
Ограничивает количество возвращаемых узлов.
|
|
prj
(string)
Имя проекта, на котором произволятся действия. Возможность существует при условии, что у указанного проекта разрешен экспорт данных и текущий проект указан среди «доверенных проектов»
По умолчанию: текущий проект
|
|
var
(string)
Название переменной, в которую будет возвращен результат работы функции
Используется только в шаблоне
|
Смотри также
|
Эта функция возвращает из модуля mod в виде массива упорядоченный набор объектов, являющихся потомками для объекта с идентификатором ParId ....
|
|
Эта функция возвращает из модуля mod в виде массива набор объектов, дочерних для объекта с идентификатором ParId . Результат можно ограничить...
|
|
Эта функция возвращает из модуля mod в виде массива набор объектов, являющихся потомками для объекта с идентификатором NodId . Результат можно...
|
|
Эта функция возвращает объекты типа NType из модулей, определяемых параметром mods , у которых в виртуальном поле lnkField есть ссылка на...
|
|
Эта функция возвращает набор объектов модуля mod в виде массива. Каждый его элемент в свою очередь представляет собой ассоциативный массив полей...
|
|
Эта функция возвращает «цепочку» (путь в дереве) объектов из модуля mod начиная с объекта с идентификатором rootId (НЕ включая его...
|
|
|
