Rating Class Reference

Inheritance diagram for Rating:

Public Member Functions
	__construct (\Magento\Framework\Model\ResourceModel\Db\Context $context, \Psr\Log\LoggerInterface $logger, \Magento\Framework\Module\Manager $moduleManager, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Review\Model\ResourceModel\Review\Summary $reviewSummary, $connectionName=null)
	getStores ($ratingId)
	getEntitySummary ($object, $onlyForCurrentStore=true)
	getReviewSummary ($object, $onlyForCurrentStore=true)
	getEntityIdByCode ($entityCode)
	deleteAggregatedRatingsByProductId ($productId)
Public Member Functions inherited from AbstractDb
	__construct (\Magento\Framework\Model\ResourceModel\Db\Context $context, $connectionName=null)
	__sleep ()
	__wakeup ()
	getIdFieldName ()
	getMainTable ()
	getTable ($tableName)
	getConnection ()
	load (\Magento\Framework\Model\AbstractModel $object, $value, $field=null)
	save (\Magento\Framework\Model\AbstractModel $object)
	delete (\Magento\Framework\Model\AbstractModel $object)
	addUniqueField ($field)
	resetUniqueField ()
	unserializeFields (\Magento\Framework\Model\AbstractModel $object)
	getUniqueFields ()
	hasDataChanged ($object)
	getChecksum ($table)
	afterLoad (\Magento\Framework\DataObject $object)
	beforeSave (\Magento\Framework\DataObject $object)
	afterSave (\Magento\Framework\DataObject $object)
	beforeDelete (\Magento\Framework\DataObject $object)
	afterDelete (\Magento\Framework\DataObject $object)
	serializeFields (\Magento\Framework\Model\AbstractModel $object)
Public Member Functions inherited from AbstractResource
	__construct ()
	getConnection ()
	beginTransaction ()
	addCommitCallback ($callback)
	commit ()
	rollBack ()
	getValidationRulesBeforeSave ()

Data Fields
const	RATING_STATUS_APPROVED = 'Approved'

Protected Member Functions
	_construct ()
	_initUniqueFields ()
	_getLoadSelect ($field, $value, $object)
	_afterLoad (\Magento\Framework\Model\AbstractModel $object)
	_afterSave (\Magento\Framework\Model\AbstractModel $object)
	processRatingCodes (\Magento\Framework\Model\AbstractModel $object)
	processRatingStores (\Magento\Framework\Model\AbstractModel $object)
	deleteRatingData ($ratingId, $table, array $storeIds)
	insertRatingData ($table, array $data)
	_afterDelete (\Magento\Framework\Model\AbstractModel $object)
	_getEntitySummaryData ($object)
Protected Member Functions inherited from AbstractDb
	_init ($mainTable, $idFieldName)
	_setResource ($connections, $tables=null)
	_setMainTable ($mainTable, $idFieldName=null)
	_getConnection ($resourceName)
	_getLoadSelect ($field, $value, $object)
	_initUniqueFields ()
	_prepareDataForSave (\Magento\Framework\Model\AbstractModel $object)
	_prepareValueForSave ($value, $type)
	_checkUnique (\Magento\Framework\Model\AbstractModel $object)
	_afterLoad (\Magento\Framework\Model\AbstractModel $object)
	_beforeSave (\Magento\Framework\Model\AbstractModel $object)
	_afterSave (\Magento\Framework\Model\AbstractModel $object)
	_beforeDelete (\Magento\Framework\Model\AbstractModel $object)
	_afterDelete (\Magento\Framework\Model\AbstractModel $object)
	_serializeFields (\Magento\Framework\Model\AbstractModel $object)
	prepareDataForUpdate ($object)
	isObjectNotNew (\Magento\Framework\Model\AbstractModel $object)
	saveNewObject (\Magento\Framework\Model\AbstractModel $object)
	updateObject (\Magento\Framework\Model\AbstractModel $object)
	processAfterSaves (\Magento\Framework\Model\AbstractModel $object)
	isModified (\Magento\Framework\Model\AbstractModel $object)
	processNotModifiedSave (\Magento\Framework\Model\AbstractModel $object)
Protected Member Functions inherited from AbstractResource
	_construct ()
	_serializeField (DataObject $object, $field, $defaultValue=null, $unsetEmpty=false)
	_unserializeField (DataObject $object, $field, $defaultValue=null)
	_prepareDataForTable (DataObject $object, $table)
	_prepareTableValueForSave ($value, $type)
	_getColumnsForEntityLoad (\Magento\Framework\Model\AbstractModel $object, $tableName)
	getSerializer ()

Protected Attributes
	$_storeManager
	$moduleManager
	$_logger
Protected Attributes inherited from AbstractDb
	$_resources
	$connectionName = \Magento\Framework\App\ResourceConnection::DEFAULT_CONNECTION
	$_connections = []
	$_resourceModel
	$_tables = []
	$_mainTable
	$_idFieldName
	$_isPkAutoIncrement = true
	$_useIsObjectNew = false
	$_mainTableFields
	$_uniqueFields = null
	$_serializableFields = []
	$transactionManager
	$objectRelationProcessor
Protected Attributes inherited from AbstractResource
	$serializer
	$_logger

Detailed Description

Rating resource model

@api

Author

Magento Core Team core@.nosp@m.mage.nosp@m.ntoco.nosp@m.mmer.nosp@m.ce.co.nosp@m.m

Since

100.0.2

Definition at line 16 of file Rating.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\Model\ResourceModel\Db\Context	$context,
		\Psr\Log\LoggerInterface	$logger,
		\Magento\Framework\Module\Manager	$moduleManager,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Review\Model\ResourceModel\Review\Summary	$reviewSummary,
			$connectionName = null
	)

Parameters

\Magento\Framework\Model\ResourceModel\Db\Context	$context
\Psr\Log\LoggerInterface	$logger
\Magento\Framework\Module\Manager	$moduleManager
\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Review\Model\ResourceModel\Review\Summary	$reviewSummary
string	$connectionName

Definition at line 45 of file Rating.php.

      {
        $this->moduleManager = $moduleManager;
        $this->_storeManager = $storeManager;
        $this->_logger = $logger;
        $this->_reviewSummary = $reviewSummary;
        parent::__construct($context, $connectionName);
    }

Member Function Documentation

_afterDelete()

_afterDelete ( \Magento\Framework\Model\AbstractModel  $object )

protected

Perform actions after object delete Prepare rating data for reaggregate all data for reviews

Parameters

\Magento\Framework\Model\AbstractModel

$object

Returns

$this

Definition at line 277 of file Rating.php.

    {
        parent::_afterDelete($object);
        if (!$this->moduleManager->isEnabled('Magento_Review')) {
            return $this;
        }
        $data = $this->_getEntitySummaryData($object);
        $summary = [];
        foreach ($data as $row) {
            $clone = clone $object;
            $clone->addData($row);
            $summary[$clone->getStoreId()][$clone->getEntityPkValue()] = $clone;
        }
        $this->_reviewSummary->reAggregate($summary);
        return $this;
    }

_afterLoad()

_afterLoad ( \Magento\Framework\Model\AbstractModel  $object )

protected

Actions after load

Parameters

\Magento\Framework\Model\AbstractModel | \Magento\Review\Model\Rating

$object

Returns

$this

Definition at line 113 of file Rating.php.

    {
        parent::_afterLoad($object);

        if (!$object->getId()) {
            return $this;
        }

        $connection = $this->getConnection();
        $bind = [':rating_id' => (int)$object->getId()];
        // load rating titles
        $select = $connection->select()->from(
            $this->getTable('rating_title'),
            ['store_id', 'value']
        )->where(
            'rating_id=:rating_id'
        );

        $result = $connection->fetchPairs($select, $bind);
        if ($result) {
            $object->setRatingCodes($result);
        }

        // load rating available in stores
        $object->setStores($this->getStores((int)$object->getId()));

        return $this;
    }

_afterSave()

_afterSave ( \Magento\Framework\Model\AbstractModel  $object )

protected

Actions after save

Parameters

\Magento\Framework\Model\AbstractModel | \Magento\Review\Model\Rating

$object

Returns

$this

Definition at line 166 of file Rating.php.

    {
        parent::_afterSave($object);
        if ($object->hasRatingCodes()) {
            $this->processRatingCodes($object);
        }

        if ($object->hasStores()) {
            $this->processRatingStores($object);
        }

        return $this;
    }

_construct()

_construct ( )

protected

Resource initialization

Returns

void

Definition at line 65 of file Rating.php.

    {
        $this->_init('rating', 'rating_id');
    }

_getEntitySummaryData()

_getEntitySummaryData (   $object )

protected

Return data of rating summary

Parameters

\Magento\Review\Model\Rating

$object

Returns

array

Definition at line 342 of file Rating.php.

    {
        $connection = $this->getConnection();

        $sumColumn = new \Zend_Db_Expr("SUM(rating_vote.{$connection->quoteIdentifier('percent')})");
        $countColumn = new \Zend_Db_Expr("COUNT(*)");

        $select = $connection->select()->from(
            ['rating_vote' => $this->getTable('rating_option_vote')],
            ['entity_pk_value' => 'rating_vote.entity_pk_value', 'sum' => $sumColumn, 'count' => $countColumn]
        )->join(
            ['review' => $this->getTable('review')],
            'rating_vote.review_id=review.review_id',
            []
        )->joinLeft(
            ['review_store' => $this->getTable('review_store')],
            'rating_vote.review_id=review_store.review_id',
            ['review_store.store_id']
        );
        if (!$this->_storeManager->isSingleStoreMode()) {
            $select->join(
                ['rating_store' => $this->getTable('rating_store')],
                'rating_store.rating_id = rating_vote.rating_id AND rating_store.store_id = review_store.store_id',
                []
            );
        }
        $select->join(
            ['review_status' => $this->getTable('review_status')],
            'review.status_id = review_status.status_id',
            []
        )->where(
            'review_status.status_code = :status_code'
        )->group(
            'rating_vote.entity_pk_value'
        )->group(
            'review_store.store_id'
        );
        $bind = [':status_code' => self::RATING_STATUS_APPROVED];

        $entityPkValue = $object->getEntityPkValue();
        if ($entityPkValue) {
            $select->where('rating_vote.entity_pk_value = :pk_value');
            $bind[':pk_value'] = $entityPkValue;
        }

        return $connection->fetchAll($select, $bind);
    }

_getLoadSelect()

_getLoadSelect (   $field,   $value,   $object  )

protected

Retrieve select object for load object data

Parameters

string	$field
mixed	$value
\Magento\Review\Model\Rating	$object

Returns

\Magento\Framework\DB\Select

Definition at line 89 of file Rating.php.

    {
        $connection = $this->getConnection();

        $table = $this->getMainTable();
        $storeId = (int)$this->_storeManager->getStore(\Magento\Store\Model\Store::ADMIN_CODE)->getId();
        $select = parent::_getLoadSelect($field, $value, $object);
        $codeExpr = $connection->getIfNullSql('title.value', "{$table}.rating_code");

        $select->joinLeft(
            ['title' => $this->getTable('rating_title')],
            $connection->quoteInto("{$table}.rating_id = title.rating_id AND title.store_id = ?", $storeId),
            ['rating_code' => $codeExpr]
        );

        return $select;
    }

_initUniqueFields()

_initUniqueFields ( )

protected

Initialize unique fields

Returns

$this

Definition at line 75 of file Rating.php.

    {
        $this->_uniqueFields = [['field' => 'rating_code', 'title' => '']];
        return $this;
    }

deleteAggregatedRatingsByProductId()

deleteAggregatedRatingsByProductId

(

$productId

)

Delete ratings by product id

Parameters

int

$productId

Returns

$this

Definition at line 486 of file Rating.php.

    {
        $entityId = $this->getEntityIdByCode(\Magento\Review\Model\Rating::ENTITY_PRODUCT_CODE);
        $connection = $this->getConnection();
        $select = $connection->select()->from($this->getMainTable(), 'rating_id')->where('entity_id = :entity_id');
        $ratingIds = $connection->fetchCol($select, [':entity_id' => $entityId]);

        if ($ratingIds) {
            $where = ['entity_pk_value = ?' => (int)$productId, 'rating_id IN(?)' => $ratingIds];
            $connection->delete($this->getTable('rating_option_vote_aggregated'), $where);
        }

        return $this;
    }

deleteRatingData()

deleteRatingData (   $ratingId,   $table, array  $storeIds  )

protected

Parameters

int	$ratingId
string	$table
array	$storeIds

Returns

void

Definition at line 232 of file Rating.php.

    {
        if (empty($storeIds)) {
            return;
        }
        $connection = $this->getConnection();
        $connection->beginTransaction();
        try {
            $where = ['rating_id = ?' => $ratingId, 'store_id IN(?)' => $storeIds];
            $connection->delete($table, $where);
            $connection->commit();
        } catch (\Exception $e) {
            $this->_logger->critical($e);
            $connection->rollBack();
        }
    }

getEntityIdByCode()

getEntityIdByCode

(

$entityCode

)

Get rating entity type id by code

Parameters

string

$entityCode

Returns

int

Definition at line 468 of file Rating.php.

    {
        $select = $this->getConnection()->select()->from(
            $this->getTable('rating_entity'),
            ['entity_id']
        )->where(
            'entity_code = :entity_code'
        );

        return $this->getConnection()->fetchOne($select, [':entity_code' => $entityCode]);
    }

getEntitySummary()

getEntitySummary	(		$object,
			$onlyForCurrentStore = true
	)

Return array of rating summary

Parameters

\Magento\Review\Model\Rating	$object
boolean	$onlyForCurrentStore

Returns

array

Definition at line 301 of file Rating.php.

    {
        $data = $this->_getEntitySummaryData($object);

        if ($onlyForCurrentStore) {
            foreach ($data as $row) {
                if ($row['store_id'] == $this->_storeManager->getStore()->getId()) {
                    $object->addData($row);
                }
            }
            return $object;
        }

        $stores = $this->_storeManager->getStores();

        $result = [];
        foreach ($data as $row) {
            $clone = clone $object;
            $clone->addData($row);
            $result[$clone->getStoreId()] = $clone;
        }

        $usedStoresId = array_keys($result);
        foreach ($stores as $store) {
            if (!in_array($store->getId(), $usedStoresId)) {
                $clone = clone $object;
                $clone->setCount(0);
                $clone->setSum(0);
                $clone->setStoreId($store->getId());
                $result[$store->getId()] = $clone;
            }
        }
        return array_values($result);
    }

getReviewSummary()

getReviewSummary	(		$object,
			$onlyForCurrentStore = true
	)

Review summary

Parameters

\Magento\Review\Model\Rating	$object
boolean	$onlyForCurrentStore

Returns

array

Definition at line 397 of file Rating.php.

    {
        $connection = $this->getConnection();

        $sumColumn = new \Zend_Db_Expr("SUM(rating_vote.{$connection->quoteIdentifier('percent')})");
        $countColumn = new \Zend_Db_Expr('COUNT(*)');
        $select = $connection->select()->from(
            ['rating_vote' => $this->getTable('rating_option_vote')],
            ['sum' => $sumColumn, 'count' => $countColumn]
        )->joinLeft(
            ['review_store' => $this->getTable('review_store')],
            'rating_vote.review_id = review_store.review_id',
            ['review_store.store_id']
        );
        if (!$this->_storeManager->isSingleStoreMode()) {
            $select->join(
                ['rating_store' => $this->getTable('rating_store')],
                'rating_store.rating_id = rating_vote.rating_id AND rating_store.store_id = review_store.store_id',
                []
            );
        }
        $select->where(
            'rating_vote.review_id = :review_id'
        )->group(
            'rating_vote.review_id'
        )->group(
            'review_store.store_id'
        );

        $data = $connection->fetchAll($select, [':review_id' => $object->getReviewId()]);

        if ($onlyForCurrentStore) {
            foreach ($data as $row) {
                if ($row['store_id'] == $this->_storeManager->getStore()->getId()) {
                    $object->addData($row);
                }
            }
            return $object;
        }

        $result = [];

        $stores = $this->_storeManager->getStore()->getResourceCollection()->load();

        foreach ($data as $row) {
            $clone = clone $object;
            $clone->addData($row);
            $result[$clone->getStoreId()] = $clone;
        }

        $usedStoresId = array_keys($result);

        foreach ($stores as $store) {
            if (!in_array($store->getId(), $usedStoresId)) {
                $clone = clone $object;
                $clone->setCount(0);
                $clone->setSum(0);
                $clone->setStoreId($store->getId());
                $result[$store->getId()] = $clone;
            }
        }

        return array_values($result);
    }

getStores()

getStores

(

$ratingId

)

Retrieve store IDs related to given rating

Parameters

int

$ratingId

Returns

array

Definition at line 148 of file Rating.php.

    {
        $select = $this->getConnection()->select()->from(
            $this->getTable('rating_store'),
            'store_id'
        )->where(
            'rating_id = ?',
            $ratingId
        );
        return $this->getConnection()->fetchCol($select);
    }

insertRatingData()

insertRatingData (   $table, array  $data  )

protected

Parameters

string	$table
array	$data

Returns

void

Definition at line 254 of file Rating.php.

    {
        if (empty($data)) {
            return;
        }
        $connection = $this->getConnection();
        $connection->beginTransaction();
        try {
            $connection->insertMultiple($table, $data);
            $connection->commit();
        } catch (\Exception $e) {
            $this->_logger->critical($e);
            $connection->rollBack();
        }
    }

processRatingCodes()

processRatingCodes ( \Magento\Framework\Model\AbstractModel  $object )

protected

Parameters

\Magento\Framework\Model\AbstractModel

$object

Returns

$this

Definition at line 184 of file Rating.php.

    {
        $connection = $this->getConnection();
        $ratingId = (int)$object->getId();
        $table = $this->getTable('rating_title');
        $select = $connection->select()->from($table, ['store_id', 'value'])
            ->where('rating_id = :rating_id');
        $old = $connection->fetchPairs($select, [':rating_id' => $ratingId]);
        $new = array_filter(array_map('trim', $object->getRatingCodes()));
        $this->deleteRatingData($ratingId, $table, array_keys(array_diff_assoc($old, $new)));

        $insert = [];
        foreach (array_diff_assoc($new, $old) as $storeId => $title) {
            $insert[] = ['rating_id' => $ratingId, 'store_id' => (int)$storeId, 'value' => $title];
        }
        $this->insertRatingData($table, $insert);
        return $this;
    }

processRatingStores()

processRatingStores ( \Magento\Framework\Model\AbstractModel  $object )

protected

Parameters

\Magento\Framework\Model\AbstractModel

$object

Returns

$this

Definition at line 207 of file Rating.php.

    {
        $connection = $this->getConnection();
        $ratingId = (int)$object->getId();
        $table = $this->getTable('rating_store');
        $select = $connection->select()->from($table, ['store_id'])
            ->where('rating_id = :rating_id');
        $old = $connection->fetchCol($select, [':rating_id' => $ratingId]);
        $new = $object->getStores();
        $this->deleteRatingData($ratingId, $table, array_diff($old, $new));

        $insert = [];
        foreach (array_diff($new, $old) as $storeId) {
            $insert[] = ['rating_id' => $ratingId, 'store_id' => (int)$storeId];
        }
        $this->insertRatingData($table, $insert);
        return $this;
    }

Field Documentation

$_logger

$_logger

protected

Definition at line 35 of file Rating.php.

$_storeManager

$_storeManager

protected

Definition at line 25 of file Rating.php.

$moduleManager

$moduleManager

protected

Definition at line 30 of file Rating.php.

RATING_STATUS_APPROVED

const RATING_STATUS_APPROVED = 'Approved'

Definition at line 18 of file Rating.php.

---

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

• vendor/magento/module-review/Model/ResourceModel/Rating.php