Документация для разработчиков
Темная тема

GetList

Описание и параметры

CDBResult
CEventMessage::GetList(
	string &by="id",
	string &order="desc",
	array filter
)

Возвращает список почтовых шаблонов в виде объекта класса CDBResult. Статический метод.

Параметры

Параметр Описание
by Ссылка на переменную с полем для сортировки, может принимать значения:
  • site_id - идентификатор сайта;
  • subject - тема;
  • timestamp_x - дата изменения;
  • event_name - тип события;
  • id - ID шаблона;
  • active - активность;
оrder Ссылка на переменную с порядком сортировки, может принимать значения:
  • asc - по возрастанию;
  • desc - по убыванию;
filter Массив вида array("фильтруемое поле"=>"значение" [, ...]), может принимать значения:
  • ID - ID шаблона;
  • TYPE - код и заголовок типа события (допустима сложная логика);
  • TYPE_ID - код типа события (допустима сложная логика);
  • TIMESTAMP_1 - левая часть интервала ("c") для поиска по дате изменения;
  • TIMESTAMP_2 - правая часть интервала ("по") для поиска по дате изменения;
  • SITE_ID - идентификатор сайта (допустимо задание массива для поиска по логике "или", либо допустимо использование сложной логики);
  • ACTIVE - флаг активности (Y|N);
  • FROM - поле "От кого" (допустима сложная логика);
  • TO - поле "Кому" (допустима сложная логика);
  • BCC - поле "Скрытая копия" (допустима сложная логика);
  • SUBJECT - по теме сообщения (допустима сложная логика);
  • BODY_TYPE - по типу тела сообщения (text|html);
  • BODY - по телу сообщения (допустима сложная логика);

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

<?
$arFilter = Array(
	"ID"            => "12 | 134",
	"TYPE"          => "контракт & рекл",
	"TYPE_ID"       => array("ADV_BANNER", "ADV_CONTRACT"),
	"TIMESTAMP_1"   => "12.11.2001",
	"TIMESTAMP_2"   => "12.11.2005",
	"SITE_ID"       => "ru | en",
	"ACTIVE"        => "Y",
	"FROM"          => "bitrixsoft.ru",
	"TO"            => "#TO#",
	"BCC"           => "admin",
	"SUBJECT"       => "конктракт",
	"BODY_TYPE"     => "text",
	"BODY"          => "auto"
);
$rsMess = CEventMessage::GetList($by="site_id", $order="desc", $arFilter);
while($arMess = $rsMess->GetNext())
{
	var_dump($arMess);
}
?>


© «Битрикс», 2001-2024, «1С-Битрикс», 2024