How is the «web/secure/use_in_adminhtml» option implemented and used?

dmitry_fedyuk · May 30, 2016, 8:16pm

Implementation

magento/magento2/blob/a5fa3af3/app/code/Magento/Backend/etc/adminhtml/system.xml#L484-L489


<field id="use_in_adminhtml" translate="label" type="select" sortOrder="60" showInDefault="1" showInWebsite="0" showInStore="0" canRestore="1">
    <label>Use Secure URLs in Admin</label>
    <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
    <backend_model>Magento\Config\Model\Config\Backend\Secure</backend_model>
    <comment>Enter https protocol to use Secure URLs in Admin.</comment>
</field>

Usages

1. \Magento\Store\Model\Store::XML_PATH_SECURE_IN_ADMINHTML

github.com

magento/magento2/blob/a5fa3af3/app/code/Magento/Store/Model/Store.php#L70-L70


const XML_PATH_SECURE_IN_ADMINHTML = 'web/secure/use_in_adminhtml';

Details: How is the \Magento\Store\Model\Store::XML_PATH_SECURE_IN_ADMINHTML constant declared and used?

2. \Magento\Backend\Model\Url::_isSecure()

github.com

magento/magento2/blob/a5fa3af3/app/code/Magento/Backend/Model/Url.php#L146-L157


/**
 * Retrieve is secure mode for ULR logic
 *
 * @return bool
 */
protected function _isSecure()
{
    if ($this->hasData('secure_is_forced')) {
        return $this->getData('secure');
    }
    return $this->_scopeConfig->isSetFlag('web/secure/use_in_adminhtml');
}

3. \Magento\Captcha\Block\Adminhtml\Captcha\DefaultCaptcha::getRefreshUrl()

github.com

magento/magento2/blob/a5fa3af3/app/code/Magento/Captcha/Block/Adminhtml/Captcha/DefaultCaptcha.php#L45-L56


/**
 * Returns URL to controller action which returns new captcha image
 *
 * @return string
 */
public function getRefreshUrl()
{
    return $this->_url->getUrl(
        'adminhtml/refresh/refresh',
        ['_secure' => $this->_config->isSetFlag('web/secure/use_in_adminhtml'), '_nosecret' => true]
    );
}

dmitry_fedyuk · May 30, 2016, 8:21pm