class.ilFavouritesManager.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilFavouritesManager
{
    protected ilFavouritesDBRepository $repo;
    protected bool $globally_activated;

    public function __construct(?ilFavouritesDBRepository $repo = null)
    {
        global $DIC;

        $this->globally_activated = ($DIC->settings()->get('rep_favourites', '0') === '1');
        $this->repo = is_null($repo)
            ? new ilFavouritesDBRepository()
            : $repo;
    }

    // Add favourite
    public function add(int $user_id, int $ref_id): void
    {
        $this->repo->add($user_id, $ref_id);
        ilCalendarCategories::deletePDItemsCache($user_id);
    }

    // Remove favourite
    public function remove(int $user_id, int $ref_id): void
    {
        $this->repo->remove($user_id, $ref_id);
        ilCalendarCategories::deletePDItemsCache($user_id);
    }

    // Is item favourite?
    public function ifIsFavourite(int $user_id, int $ref_id): bool
    {
        if (!$this->isGloballyActivated()) {
            return false;
        }
        return $this->repo->ifIsFavourite($user_id, $ref_id);
    }

    public function loadData(int $user_id, array $ref_ids): void
    {
        $this->repo->loadData($user_id, $ref_ids);
    }

    public function isGloballyActivated(): bool
    {
        return $this->globally_activated;
    }

    public function getFavouritesOfUser(int $user_id, ?array $a_types = null): array
    {
        if (!$this->isGloballyActivated()) {
            return [];
        }
        return $this->repo->getFavouritesOfUser($user_id, $a_types);
    }

    // Remove favourite entries of a repository item
    public function removeFavouritesOfRefId(int $ref_id): void
    {
        $this->repo->removeFavouritesOfRefId($ref_id);
    }

    // Remove favourite entries of a user
    public function removeFavouritesOfUser(int $user_id): void
    {
        $this->repo->removeFavouritesOfRefId($user_id);
    }
}