LibertyRecommends Class Reference

Inheritance diagram for LibertyRecommends:

[legend]List of all members.

Public Member Functions
	expunge ()
	getList (&$pListHash)
	getRecommending ($pContentId=NULL)
	getRecommendingDetails ($pExtras=FALSE)
	getRecommendingSummary ($pContentId=NULL)
	getUserRecommending ($pContentId=NULL)
	isValid ()
	LibertyRecommends ($pContentId=NULL)
	load ()
	store (&$pParamHash)
	verify (&$pParamHash)
Public Attributes
	$mContentId

---

Detailed Description

Definition at line 24 of file LibertyRecommends.php.

---

Member Function Documentation

LibertyRecommends::expunge

(

)

This function removes a recommends entry

public

Returns:

TRUE on success, FALSE on failure - mErrors will contain reason for failure

Definition at line 374 of file LibertyRecommends.php.

References $query, $result, $ret, FALSE, isValid(), mContentId, and mDb.

Here is the call graph for this function:

LibertyRecommends::getList

(

&$

pListHash

)

get list of all recommended content

Parameters:

	$pListHash	contains array of items used to limit search results
	$pListHash[sort_mode]	column and orientation by which search results are sorted
	$pListHash[find]	search for a pigeonhole title - case insensitive
	$pListHash[max_records]	maximum number of rows to return
	$pListHash[offset]	number of results data is offset by public

Returns:

array of recommended content

Definition at line 70 of file LibertyRecommends.php.

References $gBitSystem, $gBitUser, $gLibertySystem, $query, $result, $ret, $type, mDb, mPackages, BitBase::postGetList(), LibertyContent::prepGetList(), and title.

Here is the call graph for this function:

LibertyRecommends::getRecommending

(

$

pContentId = NULL

)

Get the recommending for the specified content

Parameters:

array

$pContentId public

Returns:

TRUE on success, FALSE on failure - mErrors will contain reason for failure

Definition at line 341 of file LibertyRecommends.php.

References $gBitSystem, $gBitUser, $query, $ret, FALSE, isValid(), mContentId, mDb, and BitBase::verifyId().

Referenced by store().

Here is the call graph for this function:

LibertyRecommends::getRecommendingDetails

(

$

pExtras = FALSE

)

Get the recommending history of a loaded content

Parameters:

boolean

$pExtras loading the extras will get all users who have recommended in the past and their recommendings public

Returns:

TRUE on success, FALSE on failure

Definition at line 169 of file LibertyRecommends.php.

References $gBitSystem, $query, LibertyBase::getLibertyObject(), isValid(), mContentId, mDb, and mInfo.

Here is the call graph for this function:

LibertyRecommends::getRecommendingSummary

(

$

pContentId = NULL

)

Quick method to get a nice summary of past recommendings for a given content

Parameters:

array

$pContentId public

Returns:

usable hash with a summary of recommendings of a given content id

Definition at line 200 of file LibertyRecommends.php.

References $query, $result, $ret, isValid(), mContentId, mDb, and BitBase::verifyId().

Here is the call graph for this function:

LibertyRecommends::getUserRecommending

(

$

pContentId = NULL

)

Get the recommending of the currently active user for the specified content

Parameters:

array

$pContentId public

Returns:

TRUE on success, FALSE on failure - mErrors will contain reason for failure

Definition at line 317 of file LibertyRecommends.php.

References $gBitSystem, $gBitUser, $query, $ret, FALSE, isValid(), mContentId, mDb, mUserId, and BitBase::verifyId().

Referenced by store().

Here is the call graph for this function:

LibertyRecommends::isValid

(

)

Check if the mContentId is set and valid

public

Returns:

TRUE on success, FALSE on failure - mErrors will contain reason for failure

Definition at line 364 of file LibertyRecommends.php.

References mContentId, and BitBase::verifyId().

Referenced by expunge(), getRecommending(), getRecommendingDetails(), getRecommendingSummary(), getUserRecommending(), load(), and verify().

Here is the call graph for this function:

LibertyRecommends::LibertyRecommends

(

$

pContentId = NULL

)

Initiate Liberty Recommends

Parameters:

array

$pContentId Content id of the item being recommended public

Returns:

void

Definition at line 34 of file LibertyRecommends.php.

References LibertyBase::LibertyBase(), and mContentId.

Here is the call graph for this function:

LibertyRecommends::load

(

)

Load the data from the database

public

Returns:

TRUE on success, FALSE on failure - mErrors will contain reason for failure

Definition at line 45 of file LibertyRecommends.php.

References $gBitSystem, $gBitUser, $query, isValid(), mContentId, mDb, mInfo, and mUserId.

Referenced by verify().

Here is the call graph for this function:

LibertyRecommends::store

(

&$

pParamHash

)

Parameters:

array

pParams hash of values that will be used to store the page

Returns:

bool TRUE on success, FALSE if store could not occur. If FALSE, $this->mErrors will have reason why public

Definition at line 230 of file LibertyRecommends.php.

References $gBitSystem, $gBitUser, $pParamHash, $result, getRecommending(), getUserRecommending(), mDb, and verify().

Here is the call graph for this function:

LibertyRecommends::verify

(

&$

pParamHash

)

Make sure the data is safe to store

Parameters:

array

pParams reference to hash of values that will be used to store the page, they will be modified where necessary

Returns:

bool TRUE on success, FALSE if verify failed. If FALSE, $this->mErrors will have reason why private

Definition at line 276 of file LibertyRecommends.php.

References $gBitSystem, $gBitUser, $pParamHash, BitDate::getUTCTime(), isValid(), load(), mContentId, mInfo, mUserId, and tra().

Referenced by store().

Here is the call graph for this function:

---

Member Data Documentation

LibertyRecommends::$mContentId

Definition at line 25 of file LibertyRecommends.php.

---

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

• LibertyRecommends.php

---