Public Member Functions | Protected Attributes

oxRating Class Reference

Inheritance diagram for oxRating:
Collaboration diagram for oxRating:

List of all members.

Public Member Functions

 __construct ()
 allowRating ($sUserId, $sType, $sObjectId)
 getRatingAverage ($sObjectId, $sType, $aIncludedObjectsIds=null)
 getRatingCount ($sObjectId, $sType, $aIncludedObjectsIds=null)
 getObjectType ()
 getObjectId ()

Protected Attributes

 $_blDisableShopCheck = true
 $_sClassName = 'oxrating'

Detailed Description

Article rate manager. Performs loading, updating, inserting of article rates.

Definition at line 8 of file oxrating.php.


Constructor & Destructor Documentation

oxRating.__construct (  ) 

Class constructor, initiates parent constructor (parent.oxBase()).

Reimplemented from oxBase.

Definition at line 27 of file oxrating.php.


Member Function Documentation

oxRating.allowRating ( sUserId,
sType,
sObjectId 
)

Checks if user can rate product.

Parameters:
string $sUserId user id
string $sType object type
string $sObjectId object id
Returns:
bool

Definition at line 42 of file oxrating.php.

oxRating.getObjectId (  ) 

Retuns review object id

Returns:
string

Definition at line 147 of file oxrating.php.

oxRating.getObjectType (  ) 

Retuns review object type

Returns:
string

Definition at line 137 of file oxrating.php.

oxRating.getRatingAverage ( sObjectId,
sType,
aIncludedObjectsIds = null 
)

calculates and return objects rating

Parameters:
string $sObjectId object id
string $sType object type
array $aIncludedObjectsIds array of ids
Returns:
float

Definition at line 69 of file oxrating.php.

oxRating.getRatingCount ( sObjectId,
sType,
aIncludedObjectsIds = null 
)

calculates and return objects rating count

Parameters:
string $sObjectId object id
string $sType object type
array $aIncludedObjectsIds array of ids
Returns:
integer

Definition at line 106 of file oxrating.php.


Member Data Documentation

oxRating.$_blDisableShopCheck = true [protected]

Definition at line 15 of file oxrating.php.

oxRating.$_sClassName = 'oxrating' [protected]

Reimplemented from oxBase.

Definition at line 22 of file oxrating.php.


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