Magento 2: cookies, registry, session20.05.2016 13:03

Иногда при обработке запросов в web-приложениях возникает необходимость в кратковременном сохранении промежуточной информации. Для записи информации в браузер клиента используется механизм cookies, для сохранения данных в пределах одного запроса — реестр, для сохранения данных между запросами — сессии. Под катом — примеры для Magento 2.

Cookies

CookieManagerInterface

class CookieHandler
{
    const COOKIE_REFERRAL = 'referral';
    protected $_cookieManager;

    public function __construct(
        \Magento\Framework\Stdlib\CookieManagerInterface $cookieManager
    ) {
        $this->_cookieManager = $cookieManager;
    }

    public function getCookie()
    {
        $result = $this->_cookieManager->getCookie(self::COOKIE_REFERRAL, 'default value');
        return $result;
    }

    public function setCookie($value)
    {
        // set public cookie (can be accessed by JS)
        $meta = new \Magento\Framework\Stdlib\Cookie\PublicCookieMetadata();
        $meta->setPath('/'); // use meta to define cookie props: domain, duration, security, ...
        $meta->setDurationOneYear();
        $this->_cookieManager->setPublicCookie(self::COOKIE_REFERRAL, $value, $meta);

        // or set HTTP only cookie (is not accessible from JavaScript )
        /** @var \Magento\Framework\Stdlib\Cookie\SensitiveCookieMetadata $meta */
        $meta = null; // use meta to define cookie props: domain, duration, security, ...
        $this->_cookieManager->setSensitiveCookie(self::COOKIE_REFERRAL, $value, $meta);
    }
}

Registry

Реестр выбрасывает исключение при попытке записать в него данные с уже существующим ключом (если параметр $graceful = false) или просто игнорирует перезапись (если $graceful = true):

class RegistryHandler
{
    const REG_REFERRAL = 'referral';
    protected $_registry;

    public function __construct(
        \Magento\Framework\Registry $registry
    ) {
        $this->_registry = $registry;
    }

    public function process()
    {
        // save value into the registry
        $value = 'u54321';
        $graceful = true; // don't throw exception if variable with the same name exists
        $this->_registry->register(self::REG_REFERRAL, $value, $graceful);

        // get value from registry
        $registered = $this->_registry->registry(self::REG_REFERRAL);

        // replace value 
        if ($this->_registry->registry(static::REG_REFERRAL)) {
            $this->_registry->unregister(static::REG_REFERRAL);
        }
        $this->_registry->register(static::REG_REFERRAL, $value);
    }
}

Почему-то метода для перезаписи какого-либо значения в реестре Magento не предоставляет, хотя, на мой взгляд, эта функция — логичное продолжение пары «register/unregister».

Session

SessionManagerInterface позволяет записывать и считывать данные в/из хранилища (StorageInterface). Хранилище представляет из себя DataObject, поэтому для сессии работают акцессоры get/set (через «магический» метод __call):

class SessionHandler
{
    protected $_sessionManager;

    public function __construct(
        \Magento\Framework\Session\SessionManagerInterface $sessionManager
    ) {
        $this->_sessionManager = $sessionManager;
    }

    public function process()
    {
        // save variable with name 'referral_code' into the session (using 'magic' methods)
        $this->_sessionManager->setReferralCode('u54321');

        // restore saved value from the session
        $saved = $this->_sessionManager->getReferralCode();
    }
}