ilFavouritesManager Class Reference

Manages favourites, currently the interface for other components, needs discussion. More...

Collaboration diagram for ilFavouritesManager:

Public Member Functions
	__construct (ilFavouritesDBRepository $repo=null)
	Constructor. More...
	add (int $user_id, int $ref_id)
	Add favourite. More...
	remove (int $user_id, int $ref_id)
	Remove favourite. More...
	ifIsFavourite (int $user_id, int $ref_id)
	Is item favourite? More...
	loadData (int $user_id, array $ref_ids)
	Preloads data into cache. More...
	isGloballyActivated ()
	getFavouritesOfUser (int $user_id, array $a_types=null)
	Get favourits of user. More...
	removeFavouritesOfRefId (int $ref_id)
	Remove favourite entries of a repository item. More...
	removeFavouritesOfUser (int $user_id)
	Remove favourite entries of a user. More...

Protected Attributes
	$globally_activated
	$repo

Detailed Description

Manages favourites, currently the interface for other components, needs discussion.

Author

killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 10 of file class.ilFavouritesManager.php.

Constructor & Destructor Documentation

__construct()

ilFavouritesManager::__construct

(

ilFavouritesDBRepository

$repo = null

)

Constructor.

Definition at line 24 of file class.ilFavouritesManager.php.

References $DIC, and $repo.

    {
        global $DIC;

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

Member Function Documentation

add()

ilFavouritesManager::add	(	int	$user_id,
		int	$ref_id
	)

Add favourite.

Parameters

int	$user_id
int	$ref_id

Definition at line 39 of file class.ilFavouritesManager.php.

References ilCalendarCategories\deletePDItemsCache().

    {
        $this->repo->add($user_id, $ref_id);
        ilCalendarCategories::deletePDItemsCache($user_id);
    }

Here is the call graph for this function:

getFavouritesOfUser()

ilFavouritesManager::getFavouritesOfUser	(	int	$user_id,
		array	$a_types = null
	)

Get favourits of user.

Parameters

int	$user_id
array | null	$a_types

Returns

array

Definition at line 93 of file class.ilFavouritesManager.php.

References isGloballyActivated().

                                                                             : array
    {
        if (!$this->isGloballyActivated()) {
            return [];
        }
        return $this->repo->getFavouritesOfUser($user_id, $a_types);
    }

Here is the call graph for this function:

ifIsFavourite()

ilFavouritesManager::ifIsFavourite	(	int	$user_id,
		int	$ref_id
	)

Is item favourite?

Parameters

int	$user_id
int	$ref_id

Returns

bool

Definition at line 62 of file class.ilFavouritesManager.php.

References isGloballyActivated().

                                                             : bool
    {
        if (!$this->isGloballyActivated()) {
            return false;
        }
        return $this->repo->ifIsFavourite($user_id, $ref_id);
    }

Here is the call graph for this function:

isGloballyActivated()

ilFavouritesManager::isGloballyActivated

(

)

Definition at line 81 of file class.ilFavouritesManager.php.

References $globally_activated.

Referenced by getFavouritesOfUser(), and ifIsFavourite().

                                          : bool
    {
        return $this->globally_activated;
    }

Here is the caller graph for this function:

loadData()

ilFavouritesManager::loadData	(	int	$user_id,
		array	$ref_ids
	)

Preloads data into cache.

Parameters

int	$user_id
array	$ref_ids

Definition at line 76 of file class.ilFavouritesManager.php.

    {
        $this->repo->loadData($user_id, $ref_ids);
    }

remove()

ilFavouritesManager::remove	(	int	$user_id,
		int	$ref_id
	)

Remove favourite.

Parameters

int	$user_id
int	$ref_id

Definition at line 50 of file class.ilFavouritesManager.php.

References ilCalendarCategories\deletePDItemsCache().

    {
        $this->repo->remove($user_id, $ref_id);
        ilCalendarCategories::deletePDItemsCache($user_id);
    }

Here is the call graph for this function:

removeFavouritesOfRefId()

ilFavouritesManager::removeFavouritesOfRefId

(

int

$ref_id

)

Remove favourite entries of a repository item.

Parameters

int

$ref_id

Definition at line 106 of file class.ilFavouritesManager.php.

    {
        $this->repo->removeFavouritesOfRefId($ref_id);
    }

removeFavouritesOfUser()

ilFavouritesManager::removeFavouritesOfUser

(

int

$user_id

)

Remove favourite entries of a user.

Parameters

int

$user_id

Definition at line 116 of file class.ilFavouritesManager.php.

    {
        $this->repo->removeFavouritesOfRefId($user_id);
    }

Field Documentation

$globally_activated

ilFavouritesManager::$globally_activated

protected

Definition at line 15 of file class.ilFavouritesManager.php.

Referenced by isGloballyActivated().

$repo

ilFavouritesManager::$repo

protected

Definition at line 19 of file class.ilFavouritesManager.php.

Referenced by __construct().

---

The documentation for this class was generated from the following file:

• Services/Repository/Favourites/classes/class.ilFavouritesManager.php