core_favourites\local\repository\favourite_repository_interface Interface Reference

The favourite_repository interface, defining the basic CRUD operations for favourite type items within core_favourites. More...

Inheritance diagram for core_favourites\local\repository\favourite_repository_interface:

Public Member Functions
	add (favourite $item)
	Add one item to this repository. More...
	add_all (array $items)
	Add all the items in the list to this repository. More...
	count ()
	Return the total number of items in this repository. More...
	count_by (array $criteria)
	Return the number of favourites matching the specified criteria. More...
	delete (int $id)
	Delete an item by id. More...
	delete_by (array $criteria)
	Delete all favourites matching the specified criteria. More...
	exists (int $id)
	Check whether an item exists in this repository, based on its id. More...
	exists_by (array $criteria)
	Check whether an item exists in this repository, based on the specified criteria. More...
	find (int $id)
	Find an item in this repository based on its id. More...
	find_all (int $limitfrom=0, int $limitnum=0)
	Find all items in this repository. More...
	find_by (array $criteria, int $limitfrom=0, int $limitnum=0)
	Find all items with attributes matching certain values. More...
	find_favourite (int $userid, string $component, string $itemtype, int $itemid, int $contextid)
	Find a single favourite, based on it's unique identifiers. More...
	update (favourite $item)
	Update an item within this repository. More...

Detailed Description

The favourite_repository interface, defining the basic CRUD operations for favourite type items within core_favourites.

Member Function Documentation

add()

core_favourites\local\repository\favourite_repository_interface::add

(

favourite

$item

)

Add one item to this repository.

Parameters

favourite

$item

the item to add.

Return values

favourite

the item which was added.

Implemented in core_favourites\local\repository\favourite_repository.

add_all()

core_favourites\local\repository\favourite_repository_interface::add_all

(

array

$items

)

Add all the items in the list to this repository.

Parameters

array

$items

the list of items to add.

Return values

array

the list of items added to this repository.

Implemented in core_favourites\local\repository\favourite_repository.

count()

core_favourites\local\repository\favourite_repository_interface::count

(

)

Return the total number of items in this repository.

Return values

int	the total number of items.

Implemented in core_favourites\local\repository\favourite_repository.

count_by()

core_favourites\local\repository\favourite_repository_interface::count_by

(

array

$criteria

)

Return the number of favourites matching the specified criteria.

Parameters

array

$criteria

the list of key/value criteria pairs.

Return values

int	the number of favourites matching the criteria.

Implemented in core_favourites\local\repository\favourite_repository.

delete()

core_favourites\local\repository\favourite_repository_interface::delete

(

int

$id

)

Delete an item by id.

Parameters

int

$id

the id of the item to delete.

Return values

void

Implemented in core_favourites\local\repository\favourite_repository.

delete_by()

core_favourites\local\repository\favourite_repository_interface::delete_by

(

array

$criteria

)

Delete all favourites matching the specified criteria.

Parameters

array

$criteria

the list of key/value criteria pairs.

Return values

void.

Implemented in core_favourites\local\repository\favourite_repository.

exists()

core_favourites\local\repository\favourite_repository_interface::exists

(

int

$id

)

Check whether an item exists in this repository, based on its id.

Parameters

int

$id

the id to search for.

Return values

bool	true if the item could be found, false otherwise.

Implemented in core_favourites\local\repository\favourite_repository.

exists_by()

core_favourites\local\repository\favourite_repository_interface::exists_by

(

array

$criteria

)

Check whether an item exists in this repository, based on the specified criteria.

Parameters

array

$criteria

the list of key/value criteria pairs.

Return values

bool	true if the favourite exists, false otherwise.

Implemented in core_favourites\local\repository\favourite_repository.

find()

core_favourites\local\repository\favourite_repository_interface::find

(

int

$id

)

Find an item in this repository based on its id.

Parameters

int

$id

the id of the item.

Return values

favourite

the item.

Implemented in core_favourites\local\repository\favourite_repository.

find_all()

core_favourites\local\repository\favourite_repository_interface::find_all	(	int	$limitfrom = 0,
		int	$limitnum = 0
	)

Find all items in this repository.

Parameters

int	$limitfrom	optional pagination control for returning a subset of records, starting at this point.
int	$limitnum	optional pagination control for returning a subset comprising this many records.

Return values

array

list of all items in this repository.

Implemented in core_favourites\local\repository\favourite_repository.

find_by()

core_favourites\local\repository\favourite_repository_interface::find_by	(	array	$criteria,
		int	$limitfrom = 0,
		int	$limitnum = 0
	)

Find all items with attributes matching certain values.

Parameters

array	$criteria	the array of attribute/value pairs.
int	$limitfrom	optional pagination control for returning a subset of records, starting at this point.
int	$limitnum	optional pagination control for returning a subset comprising this many records.

Return values

array

the list of items matching the criteria.

Implemented in core_favourites\local\repository\favourite_repository.

find_favourite()

core_favourites\local\repository\favourite_repository_interface::find_favourite	(	int	$userid,
		string	$component,
		string	$itemtype,
		int	$itemid,
		int	$contextid
	)

Find a single favourite, based on it's unique identifiers.

Parameters

int	$userid	the id of the user to which the favourite belongs.
string	$component	the frankenstyle component name.
string	$itemtype	the type of the favourited item.
int	$itemid	the id of the item which was favourited (not the favourite's id).
int	$contextid	the contextid of the item which was favourited.

Return values

favourite

the favourite.

Implemented in core_favourites\local\repository\favourite_repository.

update()

core_favourites\local\repository\favourite_repository_interface::update

(

favourite

$item

)

Update an item within this repository.

Parameters

favourite

$item

the item to update.

Return values

favourite

the updated item.

Implemented in core_favourites\local\repository\favourite_repository.

---

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

• favourites/classes/local/repository/favourite_repository_interface.php