ilFavouritesManager Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilFavouritesManager:

Public Member Functions
	__construct (ilFavouritesDBRepository $repo=null)
	add (int $user_id, int $ref_id)
	remove (int $user_id, int $ref_id)
	ifIsFavourite (int $user_id, int $ref_id)
	loadData (int $user_id, array $ref_ids)
	Preloads data into cache. More...
	isGloballyActivated ()
	getFavouritesOfUser (int $user_id, ?array $a_types=null)
	Get favourites of user. More...
	removeFavouritesOfRefId (int $ref_id)
	removeFavouritesOfUser (int $user_id)

Protected Attributes
ilFavouritesDBRepository	$repo
bool	$globally_activated

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Manages favourites, currently the interface for other components, needs discussion

Author

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

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

Constructor & Destructor Documentation

__construct()

ilFavouritesManager::__construct

(

ilFavouritesDBRepository

$repo = null

)

Definition at line 29 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
	)

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

References ilCalendarCategories\deletePDItemsCache().

                                                  : void
    {
        $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 favourites of user.

Parameters

?string[]

$a_types

Definition at line 80 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
	)

Definition at line 54 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 71 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[]

$ref_ids

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

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

remove()

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

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

References $ref_id, and ilCalendarCategories\deletePDItemsCache().

                                                     : void
    {
        $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

)

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

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

removeFavouritesOfUser()

ilFavouritesManager::removeFavouritesOfUser

(

int

$user_id

)

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

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

Field Documentation

$globally_activated

bool ilFavouritesManager::$globally_activated

protected

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

Referenced by isGloballyActivated().

$repo

ilFavouritesDBRepository ilFavouritesManager::$repo

protected

Definition at line 26 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