Magento 2 – How to Create and Delete Cookies

cookiemagento2

I've followed this question but set method mentioned there is outdated (Reference: Magento\Framework\App\PageCache\FormKey::set()).

So, a cookie is created like this:

public function set($value, PublicCookieMetadata $metadata)
{
    $this->cookieManager->setPublicCookie(
        self::COOKIE_NAME,
        $value,
        $metadata
    );
}

Where $metadata should be an instance of PublicCookieMetadata.

In one of the plugin I'm using $this->customerCountry->set('India', 10); I know I'm doing wrong here. Instead of passing 10 as the second parameter I need to pass instance of PublicCookieMetadata. How I can do that? I've tried $this->customerCountry->set('India', PublicCookieMetadata $metadat =null); which seems to be wrong. How I can creat and set duration of the cookie?

Best Answer

you need to declare in your class constructor an instance of \Magento\Framework\Stdlib\Cookie\CookieMetadataFactory like this:

protected $cookieMetadataFactory;
public function __construct(
    ....
    \Magento\Framework\Stdlib\Cookie\CookieMetadataFactory $cookieMetadataFactory,
    ....
) {
    ....
    $this->cookieMetadataFactory = $cookieMetadataFactory;
    ....
}

Then you can get generate the PublicCookieMetadata like this

$cookieMetadata = $this->cookieMetadataFactory->createPublicCookieMetadata()
            ->setDuration(lifetime goes here)
            ->setPath(cookie path goes here)
            ->setDomain(domain goes here)
            ->setSecure(is secure goes here)
            ->setHttpOnly(http only flag goes here);

then use the variable $cookieMetadata as your parameter.

You can find examples of you to generate the cookie metadata in

\Magento\Backend\Model\Auth\Session::prolong()
\Magento\Persistent\Model\Session::setCookie()
\Magento\Sales\Helper\Guest::setGuestViewCookie()
\Magento\Store\Model\StoreCookieManager::setStoreCookie()

Related Solutions

Magento – Set New Cookie Value

First, security:

This pattern is extremely dangerous:

$cookieVal = Mage::app()->getRequest()->getParam('source');
$theCookie = $model->set($cookieName, $cookieVal);

You should never accept user input and shove to a cookie - it gives a would-be attacker the instant ability to set any cookie they want from your domain.

Secondly, cookies:

[Insert "How do they work" meme here]

Cookies are sent back to a user session with the Response object. If you try to set a cookie after the header of the response you'll likely get this warning in the system.log or the general PHP log:

Cannot modify header information - headers already sent by //...

The only place you should be setting cookies is from within a controller action and before it loads the layout. If you're attempting to set cookies from anywhere else in the application you may have unexpected results.

Finally, your real issue:

Okay, so enough browbeating.

getParam is a method returned from Zend_Controller_Request_Http and does a series of tests:

public function getParam($key, $default = null)
{
    $keyName = (null !== ($alias = $this->getAlias($key))) ? $alias : $key;

    $paramSources = $this->getParamSources();
    if (isset($this->_params[$keyName])) {
        return $this->_params[$keyName];
    } elseif (in_array('_GET', $paramSources) && (isset($_GET[$keyName]))) {
        return $_GET[$keyName];
    } elseif (in_array('_POST', $paramSources) && (isset($_POST[$keyName]))) {
        return $_POST[$keyName];
    }

    return $default;
}

As you can see, the $default return value is null but you can change this with the second parameter. Try testing your return value. If it's null, pass a second parameter to getParam.

Alternatively, use of getParams (plural) will return all set parameters in the current request, regardless of the set method - e.g. GET or POST. Try doing a var_dump of getParams to test if your value is set.

I would also advise against using Mage::app()->getRequest() if you are within the scope of a controller action - instead use $this->getRequest().

Edit:

As @vinai pointed out in your other question, var_dump and echo push content to the browser and thus preclude your ability to set cookies.

Magento – Cookie Value Not Set

Solved; thanks to @vinai for pointing out the following:

Using var_dump will trigger the headers to be sent, so trying to set a cookie after that point will obviously fail.

This is not explicitly defined in the PHP manual, but if you think about it, it makes sense! They do say ...as with anything that outputs its result directly to the browser...

Best Answer

Related Solutions

Magento – Set New Cookie Value

Magento – Cookie Value Not Set

Related Topic