Solution Technologies
Управление сайтом без ограничений

XS2 Online

Все о разработке проектов
на базе платформы XS2 Framework

Функции XS2 API

xs2GetNodes :: Объекты одного типа

  • Доступна в шаблоне
  • Доступна в процессоре

Эта функция возвращает набор объектов модуля mod в виде массива. Каждый его элемент в свою очередь представляет собой ассоциативный массив полей конкретного объекта. Ключами этого массива являются названия полей запрошенного типа NType. Объекты отбираются по записанному в синтаксисе SQL условию condition. Набор полей определяется параметром fields, а сортировка всего набора задается параметром sort. При вызове из шаблона (Smarty) результат оказывается в переменной с именем, которое задано в параметре var.

Пример 338 :: Выборка объектов одного типа

Допустим, имеется модуль «магазин» (store), в котором определен список производителей (producer). Необходимо получить список всех производителей:

<?php
  $producers = xs2GetNodes(array('NType' => 'producer'));
?>

Пример 340 :: Выборка с сортировкой и ограничениями

Теперь получим тот же список, отсортированный по названию и усеченный до пяти первых элементов.

<?php
  $producers =
    xs2GetNodes(array('NType' => 'producer',
                      'sort' => 'NName asc',
                      'limit'=> 5));
?>

Пример 342 :: Выборка с дополнительными условиями

Такой вызов в шаблоне (Smarty) вернет в переменную $producers все объекты типа producer, которые содержат подстроку «Бобруйск» в поле NName. Результат отсортируется по дате создания в порядке убывания.

{xs2GetNodes
  var = "producers"
  NType = "producer"
  sort = "CDate desc"
  condition = "NName LIKE '%Бобруйск%'"}

Пример 344 :: Сложная выборка и отображение на странице

Такой вызов в шаблоне вернет в переменную $producers все объекты типа producer, отсортированные по дате последнего изменения (MDate). При этом для каждого объекта в наборе вернутся только поля NodId, NName и Country, а для каждого объекта типа «страна» из поля Country вернутся только значения поля NodId и NName.

{xs2GetNodes
  var = "producers"
  NType = "producer"
  sort = "MDate"
  fields = "NName, Country"
  linkDetail = "NName"
  mod = "store"}

Следующий код отображает страну для каждого производителя:

{foreach from=$producers item="producer"}
  {$producer.NName} - {$producer.Country[0].NName}
  <br />
{/foreach}

Параметры

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)
    Название переменной, в которую будет возвращен результат работы функции
    Используется только в шаблоне

    Смотри также

    Эта функция возвращает из модуля mod в виде массива упорядоченный набор объектов, являющихся потомками для объекта с идентификатором ParId ....
    Эта функция возвращает из модуля mod в виде массива набор объектов, дочерних для объекта с идентификатором ParId . Результат можно ограничить...
    Эта функция возвращает из модуля mod в виде массива набор объектов, являющихся потомками для объекта с идентификатором NodId . Результат можно...
    Эта функция возвращает объекты типа NType из модулей, определяемых параметром mods , у которых в виртуальном поле lnkField есть ссылка на...
    Эта функция возвращает набор объектов модуля mod в виде массива. Каждый его элемент в свою очередь представляет собой ассоциативный массив полей...
    Эта функция возвращает «цепочку» (путь в дереве) объектов из модуля mod начиная с объекта с идентификатором rootId (НЕ включая его...
    Copyright ©1998-2008 Солютекс. Все права защищены.
    Этот сайт сделан в designLab | Работает на технологии XS2
    Условия использования | О защите конфиденциальности