How to programmatically build a store's URL with the forced HTTPS protocol using the «_secure» parameter?

dmitry_fedyuk · May 31, 2016, 7:00am

Examples

1. \Magento\Authorizenet\Helper\Data::_getUrl()

magento/magento2/blob/a5fa3af3/app/code/Magento/Authorizenet/Helper/Data.php#L81-L97


/**
 * Set secure url checkout is secure for current store.
 *
 * @param string $route
 * @param array $params
 * @return string
 */
protected function _getUrl($route, $params = [])
{
    $params['_type'] = \Magento\Framework\UrlInterface::URL_TYPE_LINK;
    if (isset($params['is_secure'])) {
        $params['_secure'] = (bool)$params['is_secure'];
    } elseif ($this->storeManager->getStore()->isCurrentlySecure()) {
        $params['_secure'] = true;
    }
    return parent::_getUrl($route, $params);
}

2. Magento_Authorizenet::directpost/info.phtml

github.com

magento/magento2/blob/a5fa3af3/app/code/Magento/Authorizenet/view/adminhtml/templates/directpost/info.phtml#L121-L129


directPostModel = new directPost(
    '<?php /* @noEscape */ echo $code; ?>',
    'directpost-iframe',
    '<?php /* @noEscape */ echo $controller; ?>',
    '<?php /* @noEscape */ echo $orderUrl; ?>',
    '<?php echo $block->escapeUrl($method->getCgiUrl()); ?>',
    '<?php echo $block->escapeUrl($block->getUrl('*/*/save', [
        '_secure' => $block->getRequest()->isSecure()
    ]));?>');

3. \Magento\Braintree\Block\Paypal\Button::getActionSuccess()

github.com

magento/magento2/blob/a5fa3af3/app/code/Magento/Braintree/Block/Paypal/Button.php#L157-L163


/**
 * @return string
 */
public function getActionSuccess()
{
    return $this->getUrl(ConfigProvider::CODE . '/paypal/review', ['_secure' => true]);
}

4. \Magento\Braintree\Controller\Paypal\PlaceOrder::execute()

github.com

magento/magento2/blob/a5fa3af3/app/code/Magento/Braintree/Controller/Paypal/PlaceOrder.php#L47-L65


public function execute()
{
    $resultRedirect = $this->resultFactory->create(ResultFactory::TYPE_REDIRECT);
    $agreement = array_keys($this->getRequest()->getPostValue('agreement', []));
    $quote = $this->checkoutSession->getQuote();


    try {
        $this->validateQuote($quote);


        $this->orderPlace->execute($quote, $agreement);


        /** @var \Magento\Framework\Controller\Result\Redirect $resultRedirect */
        return $resultRedirect->setPath('checkout/onepage/success', ['_secure' => true]);
    } catch (\Exception $e) {
        $this->messageManager->addExceptionMessage($e, $e->getMessage());
    }


    return $resultRedirect->setPath('checkout/cart', ['_secure' => true]);
}

5. \Magento\Braintree\Controller\Paypal\Review::execute()

github.com

magento/magento2/blob/a5fa3af3/app/code/Magento/Braintree/Controller/Paypal/Review.php#L77-L80


/** @var \Magento\Framework\Controller\Result\Redirect $resultRedirect */
$resultRedirect = $this->resultFactory->create(ResultFactory::TYPE_REDIRECT);


return $resultRedirect->setPath('checkout/cart', ['_secure' => true]);

6. \Magento\Braintree\Controller\Paypal\SaveShippingMethod::execute()

github.com

magento/magento2/blob/a5fa3af3/app/code/Magento/Braintree/Controller/Paypal/SaveShippingMethod.php#L73-L73


$path = $this->_url->getUrl('*/*/review', ['_secure' => true]);

7. \Magento\Braintree\Model\Ui\TokenUiComponentProvider::getNonceRetrieveUrl()

github.com

magento/magento2/blob/a5fa3af3/app/code/Magento/Braintree/Model/Ui/TokenUiComponentProvider.php#L63-L70


/**
 * Get url to retrieve payment method nonce
 * @return string
 */
private function getNonceRetrieveUrl()
{
    return $this->urlBuilder->getUrl(ConfigProvider::CODE . '/payment/getnonce', ['_secure' => true]);
}

8. \Magento\Braintree\Model\Ui\Adminhtml\TokenUiComponentProvider::getNonceRetrieveUrl()

github.com

magento/magento2/blob/a5fa3af3/app/code/Magento/Braintree/Model/Ui/Adminhtml/TokenUiComponentProvider.php#L64-L71


/**
 * Get url to retrieve payment method nonce
 * @return string
 */
private function getNonceRetrieveUrl()
{
    return $this->urlBuilder->getUrl(ConfigProvider::CODE . '/payment/getnonce', ['_secure' => true]);
}

9. \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]
    );
}

10. \Magento\Captcha\Block\Captcha\DefaultCaptcha::getRefreshUrl()

github.com

magento/magento2/blob/a5fa3af3/app/code/Magento/Captcha/Block/Captcha/DefaultCaptcha.php#L54-L63


/**
 * Returns URL to controller action which returns new captcha image
 *
 * @return string
 */
public function getRefreshUrl()
{
    $store = $this->_storeManager->getStore();
    return $store->getUrl('captcha/refresh', ['_secure' => $store->isCurrentlySecure()]);
}

11. \Magento\Captcha\Model\Checkout\ConfigProvider::getRefreshUrl()

github.com

magento/magento2/blob/a5fa3af3/app/code/Magento/Captcha/Model/Checkout/ConfigProvider.php#L96-L105


/**
 * Returns URL to controller action which returns new captcha image
 *
 * @return string
 */
protected function getRefreshUrl()
{
    $store = $this->storeManager->getStore();
    return $store->getUrl('captcha/refresh', ['_secure' => $store->isCurrentlySecure()]);
}

12. \Magento\Catalog\Block\Adminhtml\Rss\NotifyStock::getRssData()

github.com

magento/magento2/blob/a5fa3af3/app/code/Magento/Catalog/Block/Adminhtml/Rss/NotifyStock.php#L55-L73


public function getRssData()
{
    $newUrl = $this->rssUrlBuilder->getUrl(['_secure' => true, '_nosecret' => true, 'type' => 'notifystock']);
    $title = __('Low Stock Products');
    $data = ['title' => $title, 'description' => $title, 'link' => $newUrl, 'charset' => 'UTF-8'];


    foreach ($this->rssModel->getProductsCollection() as $item) {
        /* @var $item \Magento\Catalog\Model\Product */
        $url = $this->getUrl(
            'catalog/product/edit',
            ['id' => $item->getId(), '_secure' => true, '_nosecret' => true]
        );
        $qty = 1 * $item->getQty();
        $description = __('%1 has reached a quantity of %2.', $item->getName(), $qty);
        $data['entries'][] = ['title' => $item->getName(), 'link' => $url, 'description' => $description];
    }


    return $data;
}

13. \Magento\Catalog\Helper\Product\Compare::getAddToCartUrl()

github.com

magento/magento2/blob/a5fa3af3/app/code/Magento/Catalog/Helper/Product/Compare.php#L195-L211


/**
 * Retrieve add to cart url
 *
 * @param Product $product
 * @return string
 */
public function getAddToCartUrl($product)
{
    $beforeCompareUrl = $this->_catalogSession->getBeforeCompareUrl();
    $params = [
        'product' => $product->getId(),
        \Magento\Framework\App\ActionInterface::PARAM_NAME_URL_ENCODED => $this->getEncodedUrl($beforeCompareUrl),
        '_secure' => $this->_getRequest()->isSecure()
    ];


    return $this->_getUrl('checkout/cart/add', $params);
}

14. \Magento\Checkout\Block\Cart::getCheckoutUrl()

github.com

magento/magento2/blob/a5fa3af3/app/code/Magento/Checkout/Block/Cart.php#L147-L154


/**
 * @codeCoverageIgnore
 * @return string
 */
public function getCheckoutUrl()
{
    return $this->getUrl('checkout', ['_secure' => true]);
}

dmitry_fedyuk · May 31, 2016, 7:06am