Inheritance diagram for oxRating:
Collaboration diagram for oxRating:
Public Member Functions | |
| __construct () | |
| allowRating ($sUserId, $sType, $sObjectId) | |
| getRatingAverage ($sObjectId, $sType, $aIncludedObjectsIds=null) | |
| getRatingCount ($sObjectId, $sType, $aIncludedObjectsIds=null) | |
Protected Member Functions | |
| _insert () | |
Protected Attributes | |
| $_blDisableShopCheck = true | |
| $_sClassName = 'oxrating' | |
Detailed Description
Article rate manager. Performs loading, updating, inserting of article rates.
Definition at line 7 of file oxrating.php.
Constructor & Destructor Documentation
| oxRating.__construct | ( | ) |
Class constructor, initiates parent constructor (parent.oxBase()).
Reimplemented from oxBase.
Definition at line 26 of file oxrating.php.
Member Function Documentation
| oxRating._insert | ( | ) | [protected] |
Inserts object data fiels in DB. Returns true on success.
- Returns:
- bool
Reimplemented from oxBase.
Definition at line 37 of file oxrating.php.
| 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 54 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 81 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 118 of file oxrating.php.
Member Data Documentation
oxRating.$_blDisableShopCheck = true [protected] |
Definition at line 14 of file oxrating.php.
oxRating.$_sClassName = 'oxrating' [protected] |
Reimplemented from oxBase.
Definition at line 21 of file oxrating.php.
The documentation for this class was generated from the following file:
- core/oxrating.php
