method public static

FavoriteTable::add()

Класс: \Bitrix\Tasks\Internals\Task\FavoriteTable

Сигнатура

public static add(array<string|int, mixed> $data) : AddResult

Описание

Добавляет задачу в избранное для конкретного (или текущего) пользователя. Эта функция НЕ проверяет права доступа.

Параметры

$data array<string|int, mixed>

Массив с полями вида array( "fields" => array( "FIELD1" => "value1", "FIELD2" => "value2", ), "auth_context" => \Bitrix\Main\Authentication\Context object ) либо просто плоский массив полей. Этот метод использует стратегию по умолчанию, определённую в классе.

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

AddResult

Как применяется в FavoriteTable

FavoriteTable::add() — метод класса \Bitrix\Tasks\Internals\Task\FavoriteTable модуля «Задачи». Это ORM-сущность D7 (наследник DataManager): строки читаются как объекты EO_Favorite, наборы — как EO_Favorite_Collection. Метод достаётся FavoriteTable от DataManager::add: поведение общее для всех сущностей, а данные, поля и классы — свои.

Добавляет строку в таблицу FavoriteTable. Перед записью ORM проверяет поля (checkFields()) и вызывает события; ошибки возвращаются в результате, исключения не бросаются.

use Bitrix\Main\Loader;
use Bitrix\Tasks\Internals\Task\FavoriteTable;

Loader::includeModule('tasks');

$result = FavoriteTable::add([
    'TASK_ID' => 1,
    'USER_ID' => 1,
]);
if ($result->isSuccess()) {
    $id = $result->getId();
} else {
    $errors = $result->getErrorMessages();
}

Поля сущности FavoriteTable

Поле	Тип	Свойства
`TASK_ID`	`int`	обязательное
`USER_ID`	`int`	обязательное

Список — из описания класса в исходном коде; точный состав в вашей версии вернёт FavoriteTable::getEntity()->getFields().

Собственные методы FavoriteTable

check() Проверяет, находится ли задача в избранном у конкретного (или текущего) пользователя. Эта функция НЕ…
deleteByTaskId() Удаляет задачу из избранного для всех пользователей. Эта функция НЕ проверяет права доступа.
deleteList()
getClass()
toggle() Переключает "избранность" определённой задачи для конкретного (или текущего) пользователя. Эта функция НЕ проверяет права…

add() есть и у других классов модуля «Задачи»: AccessTable, Agent, CheckListTable, DependenceTable, ElapsedTimeTable, EventManager, EventTable, LabelTable.

Исходный файл: source/tasks/lib/internals/task/favorite.php:105