Data Class Reference

Inheritance diagram for Data:

Public Member Functions
	__construct (\Magento\Framework\App\Helper\Context $context, \Magento\Framework\Escaper $escaper, \Magento\Framework\Filter\FilterManager $filter)
	getDetail ($origDetail)
	getDetailHtml ($origDetail)
	getIsGuestAllowToWrite ()
	getReviewStatuses ()
	getReviewStatusesOptionArray ()
Public Member Functions inherited from AbstractHelper
	__construct (Context $context)
	isModuleOutputEnabled ($moduleName=null)

Data Fields
const	XML_REVIEW_GUETS_ALLOW = 'catalog/review/allow_guest'

Protected Attributes
	$filter
	$_escaper
Protected Attributes inherited from AbstractHelper
	$_moduleName
	$_request
	$_moduleManager
	$_logger
	$_urlBuilder
	$_httpHeader
	$_eventManager
	$_remoteAddress
	$urlEncoder
	$urlDecoder
	$scopeConfig
	$_cacheConfig

Additional Inherited Members
Protected Member Functions inherited from AbstractHelper
	_getRequest ()
	_getModuleName ()
	_getUrl ($route, $params=[])

Detailed Description

Default review helper

@api

Since

100.0.2

Definition at line 15 of file Data.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\App\Helper\Context	$context,
		\Magento\Framework\Escaper	$escaper,
		\Magento\Framework\Filter\FilterManager	$filter
	)

Parameters

\Magento\Framework\App\Helper\Context	$context
\Magento\Framework\Escaper	$escaper
\Magento\Framework\Filter\FilterManager	$filter

Definition at line 38 of file Data.php.

      {
        $this->_escaper = $escaper;
        $this->filter = $filter;
        parent::__construct($context);
    }

Member Function Documentation

getDetail()

getDetail

(

$origDetail

)

Get review detail

Parameters

string

$origDetail

Returns

string

Definition at line 54 of file Data.php.

    {
        return nl2br($this->filter->truncate($origDetail, ['length' => 50]));
    }

getDetailHtml()

getDetailHtml

(

$origDetail

)

Return short detail info in HTML

Parameters

string

$origDetail

Full detail info

Returns

string

Definition at line 65 of file Data.php.

    {
        return nl2br($this->filter->truncate($this->_escaper->escapeHtml($origDetail), ['length' => 50]));
    }

getIsGuestAllowToWrite()

getIsGuestAllowToWrite

(

)

Return an indicator of whether or not guest is allowed to write

Returns

bool @SuppressWarnings(PHPMD.BooleanGetMethodName)

Definition at line 76 of file Data.php.

    {
        return $this->scopeConfig->isSetFlag(
            self::XML_REVIEW_GUETS_ALLOW,
            \Magento\Store\Model\ScopeInterface::SCOPE_STORE
        );
    }

getReviewStatuses()

getReviewStatuses

(

)

Get review statuses with their codes

Returns

array

Definition at line 89 of file Data.php.

    {
        return [
            \Magento\Review\Model\Review::STATUS_APPROVED => __('Approved'),
            \Magento\Review\Model\Review::STATUS_PENDING => __('Pending'),
            \Magento\Review\Model\Review::STATUS_NOT_APPROVED => __('Not Approved')
        ];
    }

getReviewStatusesOptionArray()

getReviewStatusesOptionArray

(

)

Get review statuses as option array

Returns

array

Definition at line 103 of file Data.php.

    {
        $result = [];
        foreach ($this->getReviewStatuses() as $value => $label) {
            $result[] = ['value' => $value, 'label' => $label];
        }

        return $result;
    }

Field Documentation

$_escaper

$_escaper

protected

Definition at line 31 of file Data.php.

$filter

$filter

protected

Definition at line 24 of file Data.php.

XML_REVIEW_GUETS_ALLOW

const XML_REVIEW_GUETS_ALLOW = 'catalog/review/allow_guest'

Definition at line 17 of file Data.php.

---

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

• vendor/magento/module-review/Helper/Data.php