GetList

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

CDBResult
CTaskReminders::GetList(
	array arOrder = array(),
	array arFilter = array()
);

Возвращает список напоминаний о задачах по фильтру arFilter, отсортированный в порядке arOrder.

Параметры метода

Параметр	Описание
arOrder	Массив для сортировки результата. Массив вида array("поле сортировки"=>"направление сортировки" [, ...]). Поле для сортировки может принимать значения: TASK - идентификатор задачи; USER - идентификатор пользователя; DATE - дата напоминания. Направление сортировки может принимать значения: asc - по возрастанию; desc - по убыванию; Необязательный. По умолчанию фильтруется по убыванию идентификатора задачи.
arFilter	Массив вида array("фильтруемое поле"=>"значение фильтра" [, ...]). Фильтруемое поле может принимать значения: TASK_ID - идентификатор задачи; USER_ID - идентификатор пользователя; REMIND_DATE - дата напоминания. Перед названием фильтруемого поля может указать тип фильтрации: "!" - не равно "<" - меньше "<=" - меньше либо равно ">" - больше ">=" - больше либо равно "значения фильтра" - одиночное значение или массив. Необязательный. По умолчанию записи не фильтруются.

Параметр

Описание

arOrder

Массив для сортировки результата. Массив вида array("поле сортировки"=>"направление сортировки" [, ...]).
Поле для сортировки может принимать значения:

TASK - идентификатор задачи;
USER - идентификатор пользователя;
DATE - дата напоминания.

Направление сортировки может принимать значения:

asc - по возрастанию;
desc - по убыванию;

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

arFilter

Массив вида array("фильтруемое поле"=>"значение фильтра" [, ...]). Фильтруемое поле может принимать значения:

TASK_ID - идентификатор задачи;
USER_ID - идентификатор пользователя;
REMIND_DATE - дата напоминания.

Перед названием фильтруемого поля может указать тип фильтрации:

"!" - не равно
"<" - меньше
"<=" - меньше либо равно
">" - больше
">=" - больше либо равно

"значения фильтра" - одиночное значение или массив.

Необязательный. По умолчанию записи не фильтруются.

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

Возвращается объект CDBResult.

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

<?
// Выбираем все напоминания о задаче с ID = 2 для текущего пользователя
if (CModule::IncludeModule("tasks"))
{
	$res = CTaskReminders::GetList(
		Array("DATE" => "ASC"), 
		Array("TASK_ID" => "2", "USER_ID" => $USER->GetID())
	);
	while ($arReminder = $res->GetNext())
	{
		echo $arReminder["REMIND_DATE"]."<br>";
	}
}
?>

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

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

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

Наверх