GetList

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

CDBResult
CPosting::GetList(
	$aSort = Array(),
	$arFilter = Array(),
	$arSelect = Array(),
	$arNavStartParams = false
);

Метод возвращает список выпусков по фильтру. Метод нестатический.

Параметры

Параметр	Описание	C версии
aSort	Массив, содержащий признак сортировки в виде наборов "название поля"=>"направление". Название поля может принимать значение: ID - идентификатор выпуска; TIMESTAMP - дата изменения; SUBJECT - тема письма; BODY_TYPE - тип текста; STATUS - статус выпуска; DATE_SENT - дата отправки выпуска; AUTO_SEND_TIME - время автоматической отправки выпуска; Направление сортировки может принимать значение: ASC - по возрастанию; DESC - по убыванию. Пример: array( "STATUS"=>"ASC", "DATE_SENT"=>"DESC" )
arFilter	Массив, содержащий фильтр в виде наборов "название поля"=>"значение фильтра". Название поля может принимать значение: ID - идентификатор выпуска (возможны сложные условия); TIMESTAMP_1 - дата изменения (начало периода); TIMESTAMP_2 - дата изменения (конец периода); DATE_SENT_1 - дата отправки (начало периода); DATE_SENT_2 - дата отправки (конец периода); AUTO_SEND_TIME_1 - дата или время автоматической отправки (начало периода); AUTO_SEND_TIME_2 - дата или время автоматической отправки (конец периода); STATUS - статус выпуска строкой (возможны сложные условия); STATUS_ID - статус выпуска символом (возможны сложные условия); SUBJECT - тема письма (возможны сложные условия); FROM - поле "от кого" письма (возможны сложные условия); TO - кому отправлен выпуск (возможны сложные условия); BODY_TYPE - тип текста письма; BODY - текст письма (возможны сложные условия); RUB_ID - массив идентификаторов рассылок с которыми связан выпуск; MSG_CHARSET - кодировка в которой был составлен выпуск (точное совпадение). Пример: array( "SUBJECT"=>"test \| тест", "TO"=>"@bitrixsoft.ru" )
arSelect	Массив, содержащий список полей CPostingGeneral.	20.0.0
arNavStartParams	Необязательное. По умолчанию false - не ограничивать выводимые элементы. Для ограничения выводимых элементов передается массив с ключами nTopCount - ограничить количество сверху; bShowAll - разрешить вывести все элементы при постраничной навигации; iNumPage - номер страницы при постраничной навигации; nPageSize - количество элементов на странице при постраничной навигации. Если параметру arNavStartParams передать пустой массив, то установится ограничение на 10 выводимых элементов.	20.0.0

Возвращаемые значения

Возвращается результат запроса типа CDBResult. При выборке из результата методами класса CDBResult становятся доступны поля объекта "Выпуск", за исключением полей типа text.

Если поля фильтра содержат ошибку, то переменная LAST_ERROR класса содержит сообщение об ошибке.

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

$cPosting = new CPosting;
$arFilter = Array(
	"ID" => $find_id,
	"TIMESTAMP_1" => $find_timestamp_1,
	"TIMESTAMP_2" => $find_timestamp_2,
	"DATE_SENT_1" => $find_date_sent_1,
	"DATE_SENT_2" => $find_date_sent_2,
	"STATUS" => $find_status,
	"STATUS_ID" => $find_status_id,
	"SUBJECT" => $find_subject,
	"FROM" => $find_from,
	"TO" => $find_to,
	"BODY" =>; $find_body,
	"BODY_TYPE" => $find_body_type
);
$rsPosting = $cPosting->GetList(array($by=>$order), $arFilter);
$strError .= $cPosting->LAST_ERROR;

$rsPosting->NavStart(50);
echo $rsPosting->NavPrint("Issues");
while($rsPosting->NavNext(true, "f_"))
{
	//...
}

Пользовательские комментарии

Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.

Наверх