DbTable.php

Go to the documentation of this file.

<?php
namespace Magento\Framework\Session\SaveHandler;

use Magento\Framework\Exception\SessionException;
use Magento\Framework\Phrase;

class DbTable extends \SessionHandler
{
    protected $_sessionTable;

    protected $connection;

    public function __construct(\Magento\Framework\App\ResourceConnection $resource)
    {
        $this->_sessionTable = $resource->getTableName('session');
        $this->connection = $resource->getConnection();
        $this->checkConnection();
    }

    protected function checkConnection()
    {
        if (!$this->connection) {
            throw new SessionException(
                new Phrase("The write connection to the database isn't available. Please try again later.")
            );
        }
        if (!$this->connection->isTableExists($this->_sessionTable)) {
            throw new SessionException(
                new Phrase("The database storage table doesn't exist. Verify the table and try again.")
            );
        }
    }

    public function open($savePath, $sessionName)
    {
        return true;
    }

    public function close()
    {
        return true;
    }

    public function read($sessionId)
    {
        // need to use write connection to get the most fresh DB sessions
        $select = $this->connection->select()->from(
            $this->_sessionTable,
            ['session_data']
        )->where(
            'session_id = :session_id'
        );
        $bind = ['session_id' => $sessionId];
        $data = $this->connection->fetchOne($select, $bind);

        // check if session data is a base64 encoded string
        $decodedData = base64_decode($data, true);
        if ($decodedData !== false) {
            $data = $decodedData;
        }
        return $data;
    }

    public function write($sessionId, $sessionData)
    {
        // need to use write connection to get the most fresh DB sessions
        $bindValues = ['session_id' => $sessionId];
        $select = $this->connection->select()->from($this->_sessionTable)->where('session_id = :session_id');
        $exists = $this->connection->fetchOne($select, $bindValues);

        // encode session serialized data to prevent insertion of incorrect symbols
        $sessionData = base64_encode($sessionData);
        $bind = ['session_expires' => time(), 'session_data' => $sessionData];

        if ($exists) {
            $this->connection->update($this->_sessionTable, $bind, ['session_id=?' => $sessionId]);
        } else {
            $bind['session_id'] = $sessionId;
            $this->connection->insert($this->_sessionTable, $bind);
        }
        return true;
    }

    public function destroy($sessionId)
    {
        $where = ['session_id = ?' => $sessionId];
        $this->connection->delete($this->_sessionTable, $where);
        return true;
    }

    public function gc($maxLifeTime)
    {
        $where = ['session_expires < ?' => time() - $maxLifeTime];
        $this->connection->delete($this->_sessionTable, $where);
        return true;
    }
}