AbstractHelper Class Reference

Inheritance diagram for AbstractHelper:

Public Member Functions
	__construct (Context $context)
	isModuleOutputEnabled ($moduleName=null)

Protected Member Functions
	_getRequest ()
	_getModuleName ()
	_getUrl ($route, $params=[])

Protected Attributes
	$_moduleName
	$_request
	$_moduleManager
	$_logger
	$_urlBuilder
	$_httpHeader
	$_eventManager
	$_remoteAddress
	$urlEncoder
	$urlDecoder
	$scopeConfig
	$_cacheConfig

Detailed Description

Abstract helper

@SuppressWarnings(PHPMD.NumberOfChildren)

Definition at line 13 of file AbstractHelper.php.

Constructor & Destructor Documentation

__construct()

__construct

(

Context

$context

)

Parameters

Context

$context

Definition at line 84 of file AbstractHelper.php.

    {
        $this->_moduleManager = $context->getModuleManager();
        $this->_logger = $context->getLogger();
        $this->_request = $context->getRequest();
        $this->_urlBuilder = $context->getUrlBuilder();
        $this->_httpHeader = $context->getHttpHeader();
        $this->_eventManager = $context->getEventManager();
        $this->_remoteAddress = $context->getRemoteAddress();
        $this->_cacheConfig = $context->getCacheConfig();
        $this->urlEncoder = $context->getUrlEncoder();
        $this->urlDecoder = $context->getUrlDecoder();
        $this->scopeConfig = $context->getScopeConfig();
    }

Member Function Documentation

_getModuleName()

_getModuleName ( )

protected

Retrieve helper module name

Returns

string

Definition at line 114 of file AbstractHelper.php.

    {
        if (!$this->_moduleName) {
            $class = get_class($this);
            $this->_moduleName = substr($class, 0, strpos($class, '\\Helper'));
        }
        return str_replace('\\', '_', $this->_moduleName);
    }

_getRequest()

_getRequest ( )

protected

Retrieve request object

Returns

\Magento\Framework\App\RequestInterface

Definition at line 104 of file AbstractHelper.php.

    {
        return $this->_request;
    }

_getUrl()

_getUrl (   $route,   $params = []  )

protected

Retrieve url

Parameters

string	$route
array	$params

Returns

string

Definition at line 145 of file AbstractHelper.php.

    {
        return $this->_urlBuilder->getUrl($route, $params);
    }

isModuleOutputEnabled()

isModuleOutputEnabled

(

$moduleName = null

)

Check whether or not the module output is enabled in Configuration

Parameters

string

$moduleName

Full module name

Returns

boolean use \Magento\Framework\Module\Manager::isOutputEnabled()

Definition at line 130 of file AbstractHelper.php.

    {
        if ($moduleName === null) {
            $moduleName = $this->_getModuleName();
        }
        return $this->_moduleManager->isOutputEnabled($moduleName);
    }

Field Documentation

$_cacheConfig

$_cacheConfig

protected

Definition at line 79 of file AbstractHelper.php.

$_eventManager

$_eventManager

protected

Definition at line 54 of file AbstractHelper.php.

$_httpHeader

$_httpHeader

protected

Definition at line 47 of file AbstractHelper.php.

$_logger

$_logger

protected

Definition at line 37 of file AbstractHelper.php.

$_moduleManager

$_moduleManager

protected

Definition at line 32 of file AbstractHelper.php.

$_moduleName

$_moduleName

protected

Definition at line 20 of file AbstractHelper.php.

$_remoteAddress

$_remoteAddress

protected

Definition at line 59 of file AbstractHelper.php.

$_request

$_request

protected

Definition at line 27 of file AbstractHelper.php.

$_urlBuilder

$_urlBuilder

protected

Definition at line 42 of file AbstractHelper.php.

$scopeConfig

$scopeConfig

protected

Definition at line 74 of file AbstractHelper.php.

$urlDecoder

$urlDecoder

protected

Definition at line 69 of file AbstractHelper.php.

$urlEncoder

$urlEncoder

protected

Definition at line 64 of file AbstractHelper.php.

---

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

• vendor/magento/framework/App/Helper/AbstractHelper.php