How does a customer persistence work?

dmitry_fedyuk · January 3, 2016, 10:11pm

magento/magento2/blob/c58d2dacaf6931cc7ca73d32b6fba97ecb2a9f3f/app/code/Magento/Persistent/etc/frontend/events.xml#L31-L33


<event name="layout_generate_blocks_after">
    <observer name="persistent" instance="Magento\Persistent\Observer\ApplyPersistentDataObserver" />
</event>

github.com

magento/magento2/blob/c58d2dacaf6931cc7ca73d32b6fba97ecb2a9f3f/app/code/Magento/Persistent/Observer/ApplyPersistentDataObserver.php#L75


public function execute(\Magento\Framework\Event\Observer $observer)
{
    if (!$this->_persistentData->canProcess($observer)
        || !$this->_persistentSession->isPersistent()
        || $this->_customerSession->isLoggedIn()
    ) {
        return $this;
    }
    /** @var \Magento\Persistent\Model\Persistent\Config $persistentConfig */
    $persistentConfig = $this->_persistentConfigFactory->create();
    $persistentConfig->setConfigFilePath($this->_persistentData->getPersistentConfigFilePath())->fire();
    return $this;
}
}

github.com

magento/magento2/blob/c58d2dacaf6931cc7ca73d32b6fba97ecb2a9f3f/app/code/Magento/Persistent/Model/Persistent/Config.php#L207


 */
public function fire()
{
    foreach ($this->collectInstancesToEmulate() as $type => $elements) {
        if (!is_array($elements)) {
            continue;
        }
        foreach ($elements as $info) {
            switch ($type) {
                case 'blocks':
                    $this->fireOne($info, $this->_layout->getBlock($info['name_in_layout']));
                    break;
            }
        }
    }
    return $this;
}


/**
 * Run one method by given method info
 *

github.com

magento/magento2/blob/c58d2dacaf6931cc7ca73d32b6fba97ecb2a9f3f/app/code/Magento/Persistent/Model/Persistent/Config.php#L239


    ) || !isset(
        $info['method']
    )
    ) {
        return $this;
    }
    $object = $this->_persistentFactory->create($info['class']);
    $method = $info['method'];


    if (method_exists($object, $method)) {
        $object->{$method}($instance);
    } elseif ($this->_appState->getMode() == \Magento\Framework\App\State::MODE_DEVELOPER) {
        throw new \Magento\Framework\Exception\LocalizedException(
            __('Method "%1" is not defined in "%2"', $method, get_class($object))
        );
    }


    return $this;
}
}

github.com

magento/magento2/blob/c58d2dacaf6931cc7ca73d32b6fba97ecb2a9f3f/app/code/Magento/Persistent/etc/persistent.xml#L11-L16


<reference id="welcome">
    <name_in_layout>header</name_in_layout>
    <class>Magento\Persistent\Model\Observer</class>
    <method>emulateWelcomeBlock</method>
    <block_type>Magento\Theme\Block\Html\Header</block_type>
</reference>

github.com

magento/magento2/blob/c58d2dacaf6931cc7ca73d32b6fba97ecb2a9f3f/app/code/Magento/Persistent/Model/Observer.php#L81-L101


/**
 * Emulate 'welcome' block with persistent data
 *
 * @param \Magento\Framework\View\Element\AbstractBlock $block
 * @return $this
 */
public function emulateWelcomeBlock($block)
{
    $escapedName = $this->_escaper->escapeHtml(
        $this->_customerViewHelper->getCustomerName(
            $this->customerRepository->getById($this->_persistentSession->getSession()->getCustomerId())
        ),
        null
    );


    $this->_applyAccountLinksPersistentData();
    $welcomeMessage = __('Welcome, %1!', $escapedName)
        . ' ' . $this->_layout->getBlock('header.additional')->toHtml();
    $block->setWelcome($welcomeMessage);
    return $this;
}