Output Class Reference

Inheritance diagram for Output:

Public Member Functions
	__construct (\Magento\Framework\App\Helper\Context $context, \Magento\Eav\Model\Config $eavConfig, Data $catalogData, \Magento\Framework\Escaper $escaper, $directivePatterns=[])
	addHandler ($method, $handler)
	getHandlers ($method)
	process ($method, $result, $params)
	productAttribute ($product, $attributeHtml, $attributeName)
	categoryAttribute ($category, $attributeHtml, $attributeName)
	isDirectivesExists ($attributeHtml)
Public Member Functions inherited from AbstractHelper
	__construct (Context $context)
	isModuleOutputEnabled ($moduleName=null)

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

Protected Attributes
	$_handlers
	$_templateProcessor = null
	$_catalogData = null
	$_eavConfig
	$_escaper
Protected Attributes inherited from AbstractHelper
	$_moduleName
	$_request
	$_moduleManager
	$_logger
	$_urlBuilder
	$_httpHeader
	$_eventManager
	$_remoteAddress
	$urlEncoder
	$urlDecoder
	$scopeConfig
	$_cacheConfig

Detailed Description

Definition at line 14 of file Output.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\App\Helper\Context	$context,
		\Magento\Eav\Model\Config	$eavConfig,
		Data	$catalogData,
		\Magento\Framework\Escaper	$escaper,
			$directivePatterns = []
	)

Output constructor.

Parameters

\Magento\Framework\App\Helper\Context	$context
\Magento\Eav\Model\Config	$eavConfig
Data	$catalogData
\Magento\Framework\Escaper	$escaper
array	$directivePatterns

Definition at line 62 of file Output.php.

      {
        $this->_eavConfig = $eavConfig;
        $this->_catalogData = $catalogData;
        $this->_escaper = $escaper;
        $this->directivePatterns = $directivePatterns;
        parent::__construct($context);
    }

Member Function Documentation

_getTemplateProcessor()

_getTemplateProcessor ( )

protected

Returns

Template

Definition at line 79 of file Output.php.

    {
        if (null === $this->_templateProcessor) {
            $this->_templateProcessor = $this->_catalogData->getPageTemplateProcessor();
        }

        return $this->_templateProcessor;
    }

addHandler()

addHandler	(		$method,
			$handler
	)

Adding method handler

Parameters

string	$method
object	$handler

Returns

$this

Definition at line 95 of file Output.php.

    {
        if (!is_object($handler)) {
            return $this;
        }
        $method = strtolower($method);

        if (!isset($this->_handlers[$method])) {
            $this->_handlers[$method] = [];
        }

        $this->_handlers[$method][] = $handler;
        return $this;
    }

categoryAttribute()

categoryAttribute	(		$category,
			$attributeHtml,
			$attributeName
	)

Prepare category attribute html output

Parameters

ModelCategory	$category
string	$attributeHtml
string	$attributeName

Returns

string

Exceptions

Definition at line 192 of file Output.php.

    {
        $attribute = $this->_eavConfig->getAttribute(ModelCategory::ENTITY, $attributeName);

        if ($attribute &&
            $attribute->getFrontendInput() != 'image' &&
            (!$attribute->getIsHtmlAllowedOnFront() &&
            !$attribute->getIsWysiwygEnabled())
        ) {
            $attributeHtml = $this->_escaper->escapeHtml($attributeHtml);
        }
        if ($attributeHtml !== null
            && $attribute->getIsHtmlAllowedOnFront()
            && $attribute->getIsWysiwygEnabled()
            && $this->isDirectivesExists($attributeHtml)

        ) {
            $attributeHtml = $this->_getTemplateProcessor()->filter($attributeHtml);
        }
        $attributeHtml = $this->process(
            'categoryAttribute',
            $attributeHtml,
            ['category' => $category, 'attribute' => $attributeName]
        );
        return $attributeHtml;
    }

getHandlers()

getHandlers

(

$method

)

Get all handlers for some method

Parameters

string

$method

Returns

array

Definition at line 116 of file Output.php.

    {
        $method = strtolower($method);
        return $this->_handlers[$method] ?? [];
    }

isDirectivesExists()

isDirectivesExists

(

$attributeHtml

)

Check if string has directives

Parameters

string

$attributeHtml

Returns

bool

Definition at line 225 of file Output.php.

    {
        $matches = false;
        foreach ($this->directivePatterns as $pattern) {
            if (preg_match($pattern, $attributeHtml)) {
                $matches = true;
                break;
            }
        }
        return $matches;
    }

process()

process	(		$method,
			$result,
			$params
	)

Process all method handlers

Parameters

string	$method
mixed	$result
array	$params

Returns

mixed

Definition at line 130 of file Output.php.

    {
        foreach ($this->getHandlers($method) as $handler) {
            if (method_exists($handler, $method)) {
                $result = $handler->{$method}($this, $result, $params);
            }
        }
        return $result;
    }

productAttribute()

productAttribute	(		$product,
			$attributeHtml,
			$attributeName
	)

Prepare product attribute html output

Parameters

ModelProduct	$product
string	$attributeHtml
string	$attributeName

Returns

string @SuppressWarnings(PHPMD.CyclomaticComplexity)

Exceptions

Definition at line 150 of file Output.php.

    {
        $attribute = $this->_eavConfig->getAttribute(ModelProduct::ENTITY, $attributeName);
        if ($attribute &&
            $attribute->getId() &&
            $attribute->getFrontendInput() != 'media_image' &&
            (!$attribute->getIsHtmlAllowedOnFront() &&
            !$attribute->getIsWysiwygEnabled())
        ) {
            if ($attribute->getFrontendInput() != 'price') {
                $attributeHtml = $this->_escaper->escapeHtml($attributeHtml);
            }
            if ($attribute->getFrontendInput() == 'textarea') {
                $attributeHtml = nl2br($attributeHtml);
            }
        }
        if ($attributeHtml !== null
            && $attribute->getIsHtmlAllowedOnFront()
            && $attribute->getIsWysiwygEnabled()
            && $this->isDirectivesExists($attributeHtml)
        ) {
            $attributeHtml = $this->_getTemplateProcessor()->filter($attributeHtml);
        }

        $attributeHtml = $this->process(
            'productAttribute',
            $attributeHtml,
            ['product' => $product, 'attribute' => $attributeName]
        );

        return $attributeHtml;
    }

Field Documentation

$_catalogData

$_catalogData = null

protected

Definition at line 35 of file Output.php.

$_eavConfig

$_eavConfig

protected

Definition at line 42 of file Output.php.

$_escaper

$_escaper

protected

Definition at line 47 of file Output.php.

$_handlers

$_handlers

protected

Definition at line 21 of file Output.php.

$_templateProcessor

$_templateProcessor = null

protected

Definition at line 28 of file Output.php.

---

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

• vendor/magento/module-catalog/Helper/Output.php