AdminPathConfig Class Reference

Inheritance diagram for AdminPathConfig:

Public Member Functions
	__construct (\Magento\Framework\App\Config\ScopeConfigInterface $coreConfig, \Magento\Backend\App\ConfigInterface $backendConfig, \Magento\Framework\UrlInterface $url)
	getCurrentSecureUrl (\Magento\Framework\App\RequestInterface $request)
	shouldBeSecure ($path)
	getDefaultPath ()

Protected Attributes
	$coreConfig
	$backendConfig
	$url

Detailed Description

Path config to be used in adminhtml area @api

Since

100.0.2

Definition at line 16 of file AdminPathConfig.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\App\Config\ScopeConfigInterface	$coreConfig,
		\Magento\Backend\App\ConfigInterface	$backendConfig,
		\Magento\Framework\UrlInterface	$url
	)

Constructor

Parameters

\Magento\Framework\App\Config\ScopeConfigInterface	$coreConfig
\Magento\Backend\App\ConfigInterface	$backendConfig
\Magento\Framework\UrlInterface	$url

Definition at line 40 of file AdminPathConfig.php.

      {
        $this->coreConfig = $coreConfig;
        $this->backendConfig = $backendConfig;
        $this->url = $url;
    }

Member Function Documentation

getCurrentSecureUrl()

getCurrentSecureUrl

(

\Magento\Framework\App\RequestInterface

$request

)

{Retrieve secure url for current request

Parameters

\Magento\Framework\App\RequestInterface

$request

Returns

string

}

Parameters

\Magento\Framework\App\RequestInterface

$request

Returns

string

Implements PathConfigInterface.

Definition at line 56 of file AdminPathConfig.php.

    {
        return $this->url->getBaseUrl('link', true) . ltrim($request->getPathInfo(), '/');
    }

getDefaultPath()

getDefaultPath

(

)

{Get router default request path

Returns

string

}

Returns

string

Implements PathConfigInterface.

Definition at line 85 of file AdminPathConfig.php.

    {
        return $this->backendConfig->getValue('web/default/admin');
    }

shouldBeSecure()

shouldBeSecure

(

$path

)

{Check whether given path should be secure according to configuration security requirements for URL "Secure" should not be confused with https protocol, it is about web/secure/*_url settings usage only

Parameters

string

$path

Returns

bool

}

Parameters

string

$path

Returns

bool

Implements PathConfigInterface.

Definition at line 67 of file AdminPathConfig.php.

    {
        return parse_url(
            (string)$this->coreConfig->getValue(Store::XML_PATH_UNSECURE_BASE_URL, 'default'),
            PHP_URL_SCHEME
        ) === 'https'
        || $this->backendConfig->isSetFlag(Store::XML_PATH_SECURE_IN_ADMINHTML)
        && parse_url(
            (string)$this->coreConfig->getValue(Store::XML_PATH_SECURE_BASE_URL, 'default'),
            PHP_URL_SCHEME
        ) === 'https';
    }

Field Documentation

$backendConfig

$backendConfig

protected

Definition at line 26 of file AdminPathConfig.php.

$coreConfig

$coreConfig

protected

Definition at line 21 of file AdminPathConfig.php.

$url

$url

protected

Definition at line 31 of file AdminPathConfig.php.

---

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

• vendor/magento/module-backend/Model/AdminPathConfig.php