Inheritance diagram for Review:

Public Member Functions
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Review\Model\ResourceModel\Review\Product\CollectionFactory $productFactory, \Magento\Review\Model\ResourceModel\Review\Status\CollectionFactory $statusFactory, \Magento\Review\Model\ResourceModel\Review\Summary\CollectionFactory $summaryFactory, \Magento\Review\Model\Review\SummaryFactory $summaryModFactory, \Magento\Review\Model\Review\Summary $reviewSummary, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Framework\UrlInterface $urlModel, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])

	getProductCollection ()

	getStatusCollection ()

	getTotalReviews ($entityPkValue, $approvedOnly=false, $storeId=0)

	aggregate ()

	getEntitySummary ($product, $storeId=0)

	getPendingStatus ()

	getReviewUrl ()

	getProductUrl ($productId, $storeId)

	validate ()

	afterDeleteCommit ()

	appendSummary ($collection)

	isApproved ()

	isAvailableOnStore ($store=null)

	getEntityIdByCode ($entityCode)

	getIdentities ()

Public Member Functions inherited from AbstractModel
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])

	__sleep ()

	__wakeup ()

	setIdFieldName ($name)

	getIdFieldName ()

	getId ()

	setId ($value)

	isDeleted ($isDeleted=null)

	hasDataChanges ()

	setData ($key, $value=null)

	unsetData ($key=null)

	setDataChanges ($value)

	getOrigData ($key=null)

	setOrigData ($key=null, $data=null)

	dataHasChangedFor ($field)

	getResourceName ()

	getResourceCollection ()

	getCollection ()

	load ($modelId, $field=null)

	beforeLoad ($identifier, $field=null)

	afterLoad ()

	isSaveAllowed ()

	setHasDataChanges ($flag)

	save ()

	afterCommitCallback ()

	isObjectNew ($flag=null)

	beforeSave ()

	validateBeforeSave ()

	getCacheTags ()

	cleanModelCache ()

	afterSave ()

	delete ()

	beforeDelete ()

	afterDelete ()

	afterDeleteCommit ()

	getResource ()

	getEntityId ()

	setEntityId ($entityId)

	clearInstance ()

	getStoredData ()

	getEventPrefix ()

Public Member Functions inherited from DataObject
	__construct (array $data=[])

	addData (array $arr)

	setData ($key, $value=null)

	unsetData ($key=null)

	getData ($key='', $index=null)

	getDataByPath ($path)

	getDataByKey ($key)

	setDataUsingMethod ($key, $args=[])

	getDataUsingMethod ($key, $args=null)

	hasData ($key='')

	toArray (array $keys=[])

	convertToArray (array $keys=[])

	toXml (array $keys=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	convertToXml (array $arrAttributes=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	toJson (array $keys=[])

	convertToJson (array $keys=[])

	toString ($format='')

	__call ($method, $args)

	isEmpty ()

	serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')

	debug ($data=null, &$objects=[])

	offsetSet ($offset, $value)

	offsetExists ($offset)

	offsetUnset ($offset)

	offsetGet ($offset)

Data Fields
const	CACHE_TAG = 'review_block'

const	ENTITY_PRODUCT_CODE = 'product'

const	ENTITY_CUSTOMER_CODE = 'customer'

const	ENTITY_CATEGORY_CODE = 'category'

const	STATUS_APPROVED = 1

const	STATUS_PENDING = 2

const	STATUS_NOT_APPROVED = 3

Protected Member Functions
	_construct ()

Protected Member Functions inherited from AbstractModel
	_construct ()

	_init ($resourceModel)

	_setResourceModel ($resourceName, $collectionName=null)

	_getResource ()

	_getEventData ()

	_beforeLoad ($modelId, $field=null)

	_afterLoad ()

	_hasModelChanged ()

	_getValidatorBeforeSave ()

	_createValidatorBeforeSave ()

	_getValidationRulesBeforeSave ()

	_clearReferences ()

	_clearData ()

Protected Member Functions inherited from DataObject
	_getData ($key)

	_underscore ($name)

Protected Attributes
	$_eventPrefix = 'review'

	$productCollectionFactory

	$_statusFactory

	$_summaryFactory

	$_summaryModFactory

	$_reviewSummary

	$_storeManager

	$_urlModel

Protected Attributes inherited from AbstractModel
	$_eventPrefix = 'core_abstract'

	$_eventObject = 'object'

	$_idFieldName = 'id'

	$_hasDataChanges = false

	$_origData

	$_isDeleted = false

	$_resource

	$_resourceCollection

	$_resourceName

	$_collectionName

	$_cacheTag = false

	$_dataSaveAllowed = true

	$_isObjectNew = null

	$_validatorBeforeSave = null

	$_eventManager

	$_cacheManager

	$_registry

	$_logger

	$_appState

	$_actionValidator

	$storedData = []

Protected Attributes inherited from DataObject
	$_data = []

Additional Inherited Members
Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Review model

@api @method string getCreatedAt() @method \Magento\Review\Model\Review setCreatedAt(string $value) @method \Magento\Review\Model\Review setEntityId(int $value) @method int getEntityPkValue() @method \Magento\Review\Model\Review setEntityPkValue(int $value) @method int getStatusId() @method \Magento\Review\Model\Review setStatusId(int $value) @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Since: 100.0.2

Definition at line 27 of file Review.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\Model\Context	$context,
		\Magento\Framework\Registry	$registry,
		\Magento\Review\Model\ResourceModel\Review\Product\CollectionFactory	$productFactory,
		\Magento\Review\Model\ResourceModel\Review\Status\CollectionFactory	$statusFactory,
		\Magento\Review\Model\ResourceModel\Review\Summary\CollectionFactory	$summaryFactory,
		\Magento\Review\Model\Review\SummaryFactory	$summaryModFactory,
		\Magento\Review\Model\Review\Summary	$reviewSummary,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Framework\UrlInterface	$urlModel,
		\Magento\Framework\Model\ResourceModel\AbstractResource	$resource = `null`,
		\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection = `null`,
		array	$data = `[]`
	)

Parameters

\Magento\Framework\Model\Context	$context
\Magento\Framework\Registry	$registry
\Magento\Review\Model\ResourceModel\Review\Product\CollectionFactory	$productFactory
\Magento\Review\Model\ResourceModel\Review\Status\CollectionFactory	$statusFactory
\Magento\Review\Model\ResourceModel\Review\Summary\CollectionFactory	$summaryFactory
\Magento\Review\Model\Review\SummaryFactory	$summaryModFactory
\Magento\Review\Model\Review\Summary	$reviewSummary
\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Framework\UrlInterface	$urlModel
\Magento\Framework\Model\ResourceModel\AbstractResource	$resource
\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection
array	$data	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 135 of file Review.php.

       {
         $this->productCollectionFactory = $productFactory;
         $this->_statusFactory = $statusFactory;
         $this->_summaryFactory = $summaryFactory;
         $this->_summaryModFactory = $summaryModFactory;
         $this->_reviewSummary = $reviewSummary;
         $this->_storeManager = $storeManager;
         $this->_urlModel = $urlModel;
         parent::__construct($context, $registry, $resource, $resourceCollection, $data);
     }

Member Function Documentation

◆ _construct()

_construct ( )

protected

Initialization

Returns: void

Definition at line 164 of file Review.php.

     {
         $this->_init(\Magento\Review\Model\ResourceModel\Review::class);
     }

◆ afterDeleteCommit()

afterDeleteCommit ( )

Perform actions after object delete

Returns: \Magento\Framework\Model\AbstractModel

Definition at line 296 of file Review.php.

     {
         $this->getResource()->afterDeleteCommit($this);
         return parent::afterDeleteCommit();
     }

◆ aggregate()

aggregate ( )

Aggregate reviews

Returns: $this

Definition at line 207 of file Review.php.

     {
         $this->getResource()->aggregate($this);
         return $this;
     }

◆ appendSummary()

appendSummary ( $collection )

Append review summary to product collection

Parameters

ProductCollection $collection

Returns: $this

Definition at line 308 of file Review.php.

     {
         $entityIds = [];
         foreach ($collection->getItems() as $item) {
             $entityIds[] = $item->getEntityId();
         }
 
         if (sizeof($entityIds) == 0) {
             return $this;
         }
 
         $summaryData = $this->_summaryFactory->create()
             ->addEntityFilter($entityIds)
             ->addStoreFilter($this->_storeManager->getStore()->getId())
             ->load();
 
         foreach ($collection->getItems() as $item) {
             foreach ($summaryData as $summary) {
                 if ($summary->getEntityPkValue() == $item->getEntityId()) {
                     $item->setRatingSummary($summary);
                 }
             }
         }
 
         return $this;
     }

◆ getEntityIdByCode()

getEntityIdByCode ( $entityCode )

Get review entity type id by code

Parameters

string $entityCode

Returns: int|bool

Definition at line 366 of file Review.php.

     {
         return $this->getResource()->getEntityIdByCode($entityCode);
     }

◆ getEntitySummary()

getEntitySummary	(	$product,
		$storeId = `0`
	)

Get entity summary

Parameters

Product	$product
int	$storeId

Returns: void

Definition at line 220 of file Review.php.

     {
         $summaryData = $this->_summaryModFactory->create()->setStoreId($storeId)->load($product->getId());
         $summary = new \Magento\Framework\DataObject();
         $summary->setData($summaryData->getData());
         $product->setRatingSummary($summary);
     }

◆ getIdentities()

getIdentities ( )

Return unique ID(s) for each object in system

Returns: array

Implements IdentityInterface.

Definition at line 376 of file Review.php.

     {
         $tags = [];
         if ($this->getEntityPkValue()) {
             $tags[] = Product::CACHE_TAG . '_' . $this->getEntityPkValue();
         }
         return $tags;
     }

◆ getPendingStatus()

getPendingStatus ( )

Get pending status

Returns: int

Definition at line 233 of file Review.php.

     {
         return self::STATUS_PENDING;
     }

◆ getProductCollection()

getProductCollection ( )

Get product collection

Returns: ProductCollection

Definition at line 174 of file Review.php.

     {
         return $this->productCollectionFactory->create();
     }

◆ getProductUrl()

getProductUrl	(	$productId,
		$storeId
	)

Get product view url

Parameters

string \| int	$productId
string \| int	$storeId

Returns: string

Definition at line 255 of file Review.php.

     {
         if ($storeId) {
             $this->_urlModel->setScope($storeId);
         }
 
         return $this->_urlModel->getUrl('catalog/product/view', ['id' => $productId]);
     }

◆ getReviewUrl()

getReviewUrl ( )

Get review product view url

Returns: string

Definition at line 243 of file Review.php.

     {
         return $this->_urlModel->getUrl('review/product/view', ['id' => $this->getReviewId()]);
     }

◆ getStatusCollection()

getStatusCollection ( )

Get status collection

Returns: StatusCollection

Definition at line 184 of file Review.php.

     {
         return $this->_statusFactory->create();
     }

◆ getTotalReviews()

getTotalReviews	(	$entityPkValue,
		$approvedOnly = `false`,
		$storeId = `0`
	)

Get total reviews

Parameters

int	$entityPkValue
bool	$approvedOnly
int	$storeId

Returns: int

Definition at line 197 of file Review.php.

     {
         return $this->getResource()->getTotalReviews($entityPkValue, $approvedOnly, $storeId);
     }

◆ isApproved()

isApproved ( )

Check if current review approved or not

Returns: bool

Definition at line 340 of file Review.php.

     {
         return $this->getStatusId() == self::STATUS_APPROVED;
     }

◆ isAvailableOnStore()

isAvailableOnStore ( $store = null )

Check if current review available on passed store

Parameters

int | \Magento\Store\Model\Store $store

Returns: bool

Definition at line 351 of file Review.php.

     {
         $store = $this->_storeManager->getStore($store);
         if ($store) {
             return in_array($store->getId(), (array) $this->getStores());
         }
         return false;
     }

◆ validate()

validate ( )

Validate review summary fields

Returns: bool|string[]

Definition at line 269 of file Review.php.

     {
         $errors = [];
 
         if (!\Zend_Validate::is($this->getTitle(), 'NotEmpty')) {
             $errors[] = __('Please enter a review summary.');
         }
 
         if (!\Zend_Validate::is($this->getNickname(), 'NotEmpty')) {
             $errors[] = __('Please enter a nickname.');
         }
 
         if (!\Zend_Validate::is($this->getDetail(), 'NotEmpty')) {
             $errors[] = __('Please enter a review.');
         }
 
         if (empty($errors)) {
             return true;
         }
         return $errors;
     }

Field Documentation

◆ $_eventPrefix

$_eventPrefix = 'review'

protected

Definition at line 34 of file Review.php.

◆ $_reviewSummary

$_reviewSummary

protected

Definition at line 104 of file Review.php.

◆ $_statusFactory

$_statusFactory

protected

Definition at line 83 of file Review.php.

◆ $_storeManager

$_storeManager

protected

Definition at line 111 of file Review.php.

◆ $_summaryFactory

$_summaryFactory

protected

Definition at line 90 of file Review.php.

◆ $_summaryModFactory

$_summaryModFactory

protected

Definition at line 97 of file Review.php.

◆ $_urlModel

$_urlModel

protected

Definition at line 118 of file Review.php.

◆ $productCollectionFactory

$productCollectionFactory

protected

Definition at line 76 of file Review.php.

◆ CACHE_TAG

const CACHE_TAG = 'review_block'

Cache tag

Definition at line 39 of file Review.php.

◆ ENTITY_CATEGORY_CODE

const ENTITY_CATEGORY_CODE = 'category'

Category entity review code

Definition at line 54 of file Review.php.

◆ ENTITY_CUSTOMER_CODE

const ENTITY_CUSTOMER_CODE = 'customer'

Customer entity review code

Definition at line 49 of file Review.php.

◆ ENTITY_PRODUCT_CODE

const ENTITY_PRODUCT_CODE = 'product'

Product entity review code

Definition at line 44 of file Review.php.

◆ STATUS_APPROVED

const STATUS_APPROVED = 1

Approved review status code

Definition at line 59 of file Review.php.

◆ STATUS_NOT_APPROVED

const STATUS_NOT_APPROVED = 3

Not Approved review status code

Definition at line 69 of file Review.php.

◆ STATUS_PENDING

const STATUS_PENDING = 2

Pending review status code

Definition at line 64 of file Review.php.

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

vendor/magento/module-review/Model/Review.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _construct()

◆ afterDeleteCommit()

◆ aggregate()

◆ appendSummary()

◆ getEntityIdByCode()

◆ getEntitySummary()

◆ getIdentities()

◆ getPendingStatus()

◆ getProductCollection()

◆ getProductUrl()

◆ getReviewUrl()

◆ getStatusCollection()

◆ getTotalReviews()

◆ isApproved()

◆ isAvailableOnStore()

◆ validate()

Field Documentation

◆ $_eventPrefix

◆ $_reviewSummary

◆ $_statusFactory

◆ $_storeManager

◆ $_summaryFactory

◆ $_summaryModFactory

◆ $_urlModel

◆ $productCollectionFactory

◆ CACHE_TAG

◆ ENTITY_CATEGORY_CODE

◆ ENTITY_CUSTOMER_CODE

◆ ENTITY_PRODUCT_CODE

◆ STATUS_APPROVED

◆ STATUS_NOT_APPROVED

◆ STATUS_PENDING