Data Class Reference

Inheritance diagram for Data:

Public Member Functions
	__construct (\Magento\Framework\App\Helper\Context $context, \Magento\Framework\App\Route\Config $routeConfig, \Magento\Framework\Locale\ResolverInterface $locale, \Magento\Backend\Model\UrlInterface $backendUrl, \Magento\Backend\Model\Auth $auth, \Magento\Backend\App\Area\FrontNameResolver $frontNameResolver, \Magento\Framework\Math\Random $mathRandom)
	getPageHelpUrl ()
	setPageHelpUrl ($url=null)
	addPageHelpUrl ($suffix)
	getUrl ($route='', $params=[])
	getCurrentUserId ()
	prepareFilterString ($filterString)
	generateResetPasswordLinkToken ()
	getHomePageUrl ()
	getAreaFrontName ($checkHost=false)
Public Member Functions inherited from AbstractHelper
	__construct (Context $context)
	isModuleOutputEnabled ($moduleName=null)

Data Fields
const	XML_PATH_USE_CUSTOM_ADMIN_URL = 'admin/url/use_custom'

Protected Attributes
	$_pageHelpUrl
	$_routeConfig
	$_locale
	$_backendUrl
	$_auth
	$_frontNameResolver
	$mathRandom
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

@api

Deprecated:

100.2.0 @SuppressWarnings(PHPMD.LongVariable)

Since

100.0.2

Definition at line 16 of file Data.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\App\Helper\Context	$context,
		\Magento\Framework\App\Route\Config	$routeConfig,
		\Magento\Framework\Locale\ResolverInterface	$locale,
		\Magento\Backend\Model\UrlInterface	$backendUrl,
		\Magento\Backend\Model\Auth	$auth,
		\Magento\Backend\App\Area\FrontNameResolver	$frontNameResolver,
		\Magento\Framework\Math\Random	$mathRandom
	)

Parameters

\Magento\Framework\App\Helper\Context	$context
\Magento\Framework\App\Route\Config	$routeConfig
\Magento\Framework\Locale\ResolverInterface	$locale
\Magento\Backend\Model\UrlInterface	$backendUrl
\Magento\Backend\Model\Auth	$auth
\Magento\Backend\App\Area\FrontNameResolver	$frontNameResolver
\Magento\Framework\Math\Random	$mathRandom

Definition at line 64 of file Data.php.

      {
        parent::__construct($context);
        $this->_routeConfig = $routeConfig;
        $this->_locale = $locale;
        $this->_backendUrl = $backendUrl;
        $this->_auth = $auth;
        $this->_frontNameResolver = $frontNameResolver;
        $this->mathRandom = $mathRandom;
    }

Member Function Documentation

addPageHelpUrl()

addPageHelpUrl

(

$suffix

)

Parameters

string

$suffix

Returns

$this

Definition at line 127 of file Data.php.

    {
        $this->_pageHelpUrl = $this->getPageHelpUrl() . $suffix;
        return $this;
    }

generateResetPasswordLinkToken()

generateResetPasswordLinkToken

(

)

Generate unique token for reset password confirmation link

Returns

string

Definition at line 186 of file Data.php.

    {
        return $this->mathRandom->getUniqueHash();
    }

getAreaFrontName()

getAreaFrontName

(

$checkHost = false

)

Return Backend area front name

Parameters

bool

$checkHost

Returns

bool|string

Definition at line 207 of file Data.php.

    {
        return $this->_frontNameResolver->getFrontName($checkHost);
    }

getCurrentUserId()

getCurrentUserId

(

)

Returns

int|bool

Definition at line 146 of file Data.php.

    {
        if ($this->_auth->getUser()) {
            return $this->_auth->getUser()->getId();
        }
        return false;
    }

getHomePageUrl()

getHomePageUrl

(

)

Get backend start page URL

Returns

string

Definition at line 196 of file Data.php.

    {
        return $this->_backendUrl->getRouteUrl('adminhtml');
    }

getPageHelpUrl()

getPageHelpUrl

(

)

Returns

string

Definition at line 85 of file Data.php.

    {
        if (!$this->_pageHelpUrl) {
            $this->setPageHelpUrl();
        }
        return $this->_pageHelpUrl;
    }

getUrl()

getUrl	(		$route = '',
			$params = []
	)

Parameters

string	$route
array	$params

Returns

string

Definition at line 138 of file Data.php.

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

prepareFilterString()

prepareFilterString

(

$filterString

)

Decode filter string

Parameters

string

$filterString

Returns

array

Decodes URL-encoded string and trims whitespaces from the beginning and end of a string

Parameters

string

$value

Definition at line 160 of file Data.php.

    {
        $data = [];
        $filterString = base64_decode($filterString);
        parse_str($filterString, $data);
        array_walk_recursive(
            $data,
            // @codingStandardsIgnoreStart
            // @codingStandardsIgnoreEnd
            function (&$value) {
                $value = trim(rawurldecode($value));
            }
        );
        return $data;
    }

setPageHelpUrl()

setPageHelpUrl

(

$url = null

)

Parameters

string | null

$url

Returns

$this

Definition at line 97 of file Data.php.

    {
        if ($url === null) {
            $request = $this->_request;
            $frontModule = $request->getControllerModule();
            if (!$frontModule) {
                $frontModule = $this->_routeConfig->getModulesByFrontName($request->getModuleName());
                if (empty($frontModule) === false) {
                    $frontModule = $frontModule[0];
                } else {
                    $frontModule = null;
                }
            }
            $url = 'http://www.magentocommerce.com/gethelp/';
            $url .= $this->_locale->getLocale() . '/';
            $url .= $frontModule . '/';
            $url .= $request->getControllerName() . '/';
            $url .= $request->getActionName() . '/';

            $this->_pageHelpUrl = $url;
        }
        $this->_pageHelpUrl = $url;

        return $this;
    }

Field Documentation

$_auth

$_auth

protected

Definition at line 43 of file Data.php.

$_backendUrl

$_backendUrl

protected

Definition at line 38 of file Data.php.

$_frontNameResolver

$_frontNameResolver

protected

Definition at line 48 of file Data.php.

$_locale

$_locale

protected

Definition at line 33 of file Data.php.

$_pageHelpUrl

$_pageHelpUrl

protected

Definition at line 23 of file Data.php.

$_routeConfig

$_routeConfig

protected

Definition at line 28 of file Data.php.

$mathRandom

$mathRandom

protected

Definition at line 53 of file Data.php.

XML_PATH_USE_CUSTOM_ADMIN_URL

const XML_PATH_USE_CUSTOM_ADMIN_URL = 'admin/url/use_custom'

Definition at line 18 of file Data.php.

---

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

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