Docs For Class Mage_Review_Model

Description

Review model

author: Magento Core Team <[email protected]>

Located in /Review/Model/Review.php (line 34)

Varien_Object
   |
   --Mage_Core_Model_Abstract
      |
      --Mage_Review_Model_Review

Class Constant Summary

ENTITY_CATEGORY_CODE = 'category'

ENTITY_CUSTOMER_CODE = 'customer'

ENTITY_PRODUCT = 1

ENTITY_PRODUCT_CODE = 'product'

STATUS_APPROVED = 1

STATUS_NOT_APPROVED = 3

STATUS_PENDING = 2

Variable Summary

string $_eventPrefix

Method Summary

void aggregate ()

Mage_Review_Model_Review appendSummary (Mage_Catalog_Model_Resource_Eav_Mysql4_Product_Collection $collection)

int|bool getEntityIdByCode (string $entityCode)

void getEntitySummary ( $product, [ $storeId = 0])

void getPendingStatus ()

void getProductCollection ()

void getReviewUrl ()

void getStatusCollection ()

void getTotalReviews ( $entityPkValue, [ $approvedOnly = false], [ $storeId = 0])

bool isApproved ()

bool isAvailableOnStore ([int|Mage_Core_Model_Store $store = null])

void validate ()

void _beforeDelete ()

void _construct ()

Variables

string $_eventPrefix = 'review' (line 42)

Event prefix for observer

access: protected

Redefinition of:

Mage_Core_Model_Abstract::$_eventPrefix: Prefix of model events names

Inherited Variables

Inherited from Mage_Core_Model_Abstract

Mage_Core_Model_Abstract::$_cacheTag
Mage_Core_Model_Abstract::$_dataSaveAllowed
Mage_Core_Model_Abstract::$_eventObject
Mage_Core_Model_Abstract::$_isObjectNew
Mage_Core_Model_Abstract::$_resource
Mage_Core_Model_Abstract::$_resourceCollectionName
Mage_Core_Model_Abstract::$_resourceName

Methods

aggregate (line 82)

access: public

void aggregate ()

appendSummary (line 138)

Append review summary to product collection

access: public

Mage_Review_Model_Review appendSummary (Mage_Catalog_Model_Resource_Eav_Mysql4_Product_Collection $collection)

Mage_Catalog_Model_Resource_Eav_Mysql4_Product_Collection $collection

getEntityIdByCode (line 203)

Get review entity type id by code

access: public

int|bool getEntityIdByCode (string $entityCode)

string $entityCode

getEntitySummary (line 88)

access: public

void getEntitySummary ( $product, [ $storeId = 0])

$product
$storeId

getPendingStatus (line 98)

access: public

void getPendingStatus ()

getProductCollection (line 67)

access: public

void getProductCollection ()

getReviewUrl (line 103)

access: public

void getReviewUrl ()

getStatusCollection (line 72)

access: public

void getStatusCollection ()

getTotalReviews (line 77)

access: public

void getTotalReviews ( $entityPkValue, [ $approvedOnly = false], [ $storeId = 0])

$entityPkValue
$approvedOnly
$storeId

isApproved (line 176)

Check if current review approved or not

access: public

bool isApproved ()

isAvailableOnStore (line 187)

Check if current review available on passed store

access: public

bool isAvailableOnStore ([int|Mage_Core_Model_Store $store = null])

int|Mage_Core_Model_Store $store

validate (line 108)

access: public

void validate ()

_beforeDelete (line 165)

access: protected

void _beforeDelete ()

Redefinition of:

Mage_Core_Model_Abstract::_beforeDelete(): Processing object before delete data

_construct (line 62)

access: protected

void _construct ()

Inherited Methods

Inherited From Mage_Core_Model_Abstract

Mage_Core_Model_Abstract::afterCommitCallback()
Mage_Core_Model_Abstract::afterLoad()
Mage_Core_Model_Abstract::cleanModelCache()
Mage_Core_Model_Abstract::clearInstance()
Mage_Core_Model_Abstract::delete()
Mage_Core_Model_Abstract::getCacheIdTags()
Mage_Core_Model_Abstract::getCacheTags()
Mage_Core_Model_Abstract::getCollection()
Mage_Core_Model_Abstract::getEntityId()
Mage_Core_Model_Abstract::getId()
Mage_Core_Model_Abstract::getIdFieldName()
Mage_Core_Model_Abstract::getResource()
Mage_Core_Model_Abstract::getResourceCollection()
Mage_Core_Model_Abstract::getResourceName()
Mage_Core_Model_Abstract::isObjectNew()
Mage_Core_Model_Abstract::load()
Mage_Core_Model_Abstract::save()
Mage_Core_Model_Abstract::setId()
Mage_Core_Model_Abstract::_afterDelete()
Mage_Core_Model_Abstract::_afterDeleteCommit()
Mage_Core_Model_Abstract::_afterLoad()
Mage_Core_Model_Abstract::_afterSave()
Mage_Core_Model_Abstract::_afterSaveCommit()
Mage_Core_Model_Abstract::_beforeDelete()
Mage_Core_Model_Abstract::_beforeLoad()
Mage_Core_Model_Abstract::_beforeSave()
Mage_Core_Model_Abstract::_clearData()
Mage_Core_Model_Abstract::_clearReferences()
Mage_Core_Model_Abstract::_getEventData()
Mage_Core_Model_Abstract::_getResource()
Mage_Core_Model_Abstract::_hasModelChanged()
Mage_Core_Model_Abstract::_init()
Mage_Core_Model_Abstract::_protectFromNonAdmin()
Mage_Core_Model_Abstract::_setResourceModel()

Class Constants

ENTITY_CATEGORY_CODE = 'category' (line 56)

ENTITY_CUSTOMER_CODE = 'customer' (line 55)

ENTITY_PRODUCT = 1 (line 48)

deprecated: after 1.3.2.4

ENTITY_PRODUCT_CODE = 'product' (line 54)

Review entity codes

STATUS_APPROVED = 1 (line 58)

STATUS_NOT_APPROVED = 3 (line 60)

STATUS_PENDING = 2 (line 59)

Class Mage_Review_Model_Review

Inherited Variables

Inherited Methods