User_favourite_pages_Model Class Reference

Inheritance diagram for User_favourite_pages_Model:

Public Member Functions
	is_users_favourite ($user_id, $page)
	Checks if user have given page in his favourites.
	add_page_to_favourite ($user_id, $page, $title, $default)
	Insert page to users favourites.
	remove_page_from_favourites ($id)
	Removes page from users favourites by ID.
	get_users_favourites ($user_id, $limit_from=0, $limit_results=50, $order_by= 'title', $order_by_direction= 'asc')
	Returns all favourites of given user.
	edit_favourites ($user_id, $id, $title, $default)
	Updates user favourite page details.
	remove_user_default_page ($user_id)
	Removes default page tag from users favourites.
	set_user_default_page_by_id ($id)
	Sets default page tag.
	get_favourite_page_details ($user_id, $page)
	Get favourite page details.
	get_user_default_page ($user_id)
	Get users default page.

Protected Attributes
	$table_names_plural = FALSE

Member Function Documentation

User_favourite_pages_Model::add_page_to_favourite	(		$user_id,
			$page,
			$title,
			$default
	)

Insert page to users favourites.

Parameters

int	$user_id	User ID
string	$title	Favourite page title
string	$page	Page address
int	$default	Is default page

Returns

boolean TRUE if insert was successfull

User_favourite_pages_Model::edit_favourites	(		$user_id,
			$id,
			$title,
			$default
	)

Updates user favourite page details.

Parameters

int	$user_id	User ID
int	$id	Favourite page ID
string	$page	Page address
string	$title	Favourite page title
boolean	$default	Is default page

Returns

boolean

User_favourite_pages_Model::get_favourite_page_details	(		$user_id,
			$page
	)

Get favourite page details.

Parameters

int	$user_id	User Id
string	$page	Page URL

Returns

ORM object

User_favourite_pages_Model::get_user_default_page

(

$user_id

)

Get users default page.

Parameters

int

$user_id

User Id

Returns

ORM object

User_favourite_pages_Model::get_users_favourites	(		$user_id,
			$limit_from = 0,
			$limit_results = 50,
			$order_by = 'title',
			$order_by_direction = 'asc'
	)

Returns all favourites of given user.

Parameters

int

$user_id

User ID

Returns

ORM object

User_favourite_pages_Model::is_users_favourite	(		$user_id,
			$page
	)

Checks if user have given page in his favourites.

Parameters

int	$user_id
string	$page

Returns

bool TRUE if page is favourite

User_favourite_pages_Model::remove_page_from_favourites

(

$id

)

Removes page from users favourites by ID.

Parameters

int

$id

Favourite page ID

Returns

ORM object

User_favourite_pages_Model::remove_user_default_page

(

$user_id

)

Removes default page tag from users favourites.

Parameters

int

$user_id

User Id

Returns

ORM object

User_favourite_pages_Model::set_user_default_page_by_id

(

$id

)

Sets default page tag.

Parameters

int

$id

Favourite page ID

Returns

ORM object

---

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

• models/user_favourite_pages.php