iRateSystem Interface Reference

Public Member Functions
	addThumbs ($entityPath, $userId, $upOrDown)
	addStars ($entityPath, $userId, $numberOfStars)
	removeThumbs ($entityPath, $userId)
	removeStars ($entityPath, $userId)

Data Fields
const	iType = "RateSystem"
const	iShort = "rs"
const	iVersion = "1.0"
const	iWidgets

Member Function Documentation

addStars	(		$entityPath,
			$userId,
			$numberOfStars
	)

Call this to add a star rating.

Parameters

string	$entityPath	The path of the entity to add the rating to.
int	$userId	The user id to associate the rating with. Use -1 for system.
int	$numberOfStars	1-5.

addThumbs	(		$entityPath,
			$userId,
			$upOrDown
	)

Call this to add a thumbs up true, or a thumbs down false.

Parameters

string	$entityPath	The path of the entity to add the rating to.
int	$userId	The user id to associate the rating with. Use -1 for system.
boolean	$upOrDown	True for up, false for down.

Field Documentation

const iWidgets

Initial value:

= [
        "Thumbs(string entityPath, bool locked = false)" => "A like/dislike widget thats small and shows the amount of likes minus the dislikes."

Must have all constants and $[Widget name] variables.

---

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

• Standards/Standards.php