add

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

\CTaskCheckListItem::add(CTaskItemInterface $oTaskItem, array $arFields)

Статический метод, отвечает за создание пункта чеклиста.

Первым параметром передается объект конкретной задачи, чтобы прикрепить к ней пункт чеклиста. Вторым параметром передается массив значений этого пункта чеклиста.

Параметры функции

Параметр	Описание
arFields	TITLE (обязательный) - текст чеклиста. Можно передавать любую строку, кроме пустой строки или строки, содержащей только пробелы. Примечание: Если TITLE будет равен === (трем знакам "равно"), то вместо пункта чеклиста будет разделительная линия. SORT_INDEX - индекс сортировки. целое число. Чем больше, тем ниже в списке. IS_COMPLETE - флаг о том, что пункт чеклиста уже выполнен.

Параметр

Описание

arFields

TITLE (обязательный) - текст чеклиста. Можно передавать любую строку, кроме пустой строки или строки, содержащей только пробелы.

Примечание: Если TITLE будет равен === (трем знакам "равно"), то вместо пункта чеклиста будет разделительная линия.

SORT_INDEX - индекс сортировки. целое число. Чем больше, тем ниже в списке.

IS_COMPLETE - флаг о том, что пункт чеклиста уже выполнен.

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

После успешного создания пункта чеклиста вернется объект \CTaskCheckListItem

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

$task = CTaskItem::getInstance($taskId, $userId);
\CTaskCheckListItem::add($task, ['TITLE'=>'First item', 'SORT_INDEX'=>10, 'IS_COMPLETE'=>'N']);
\CTaskCheckListItem::add($task, ['TITLE'=>'Second item', 'SORT_INDEX'=>20, 'IS_COMPLETE'=>'N']);
\CTaskCheckListItem::add($task, ['TITLE'=>'Third item. Completed', 'SORT_INDEX'=>30, 'IS_COMPLETE'=>'Y']);