method public static

FavoriteTable::getByPrimary()

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

Сигнатура

public static getByPrimary(mixed $primary[, array<string|int, mixed> $parameters = = '[]' ]) : EO_Favorite_Result

Описание

Возвращает выборку по первичному ключу сущности и необязательным параметрам для getList()

Параметры

$primary mixed

Первичный ключ сущности

$parameters array<string|int, mixed> = = '[]'

Дополнительные параметры для getList()

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

EO_Favorite_Result

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

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

То же, что getById(), но с параметрами getList() вторым аргументом. Для составного ключа FavoriteTable передаётся массивом.

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

Loader::includeModule('tasks');

$primary = [/*    */];
$row = FavoriteTable::getByPrimary($primary, [
    'select' => ['TASK_ID', 'USER_ID'],
])->fetch();

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

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

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

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

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

getByPrimary() есть и у других классов модуля «Задачи»: AccessTable, CheckListTable, CheckListTable, CheckListTreeTable, CheckListTreeTable, CounterTable, DependenceTable, DependenceTable.

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