StrictSessionHandler

class StrictSessionHandler extends AbstractSessionHandler

Adds basic SessionUpdateTimestampHandlerInterface behaviors to another SessionHandlerInterface.

Methods

public open($savePath, $sessionName) {@inheritdoc}
protected string doRead(string $sessionId) No description
protected bool doWrite(string $sessionId, string $data) No description
protected bool doDestroy(string $sessionId) No description
public validateId($sessionId) {@inheritdoc} from AbstractSessionHandler
public read($sessionId) {@inheritdoc} from AbstractSessionHandler
public write($sessionId, $data) {@inheritdoc} from AbstractSessionHandler
public destroy($sessionId) {@inheritdoc}
public __construct(SessionHandlerInterface $handler) No description
public updateTimestamp($sessionId, $data) {@inheritdoc}
public close() {@inheritdoc}
public gc($maxlifetime) {@inheritdoc}

Details

at line 36

open()

public open($savePath, $sessionName)

{@inheritdoc}

Parameters

$savePath
$sessionName
at line 46

doRead()

protected string doRead(string $sessionId)

Parameters

string $sessionId

Return Value

string
at line 62

doWrite()

protected bool doWrite(string $sessionId, string $data)

Parameters

string $sessionId
string $data

Return Value

bool
at line 81

doDestroy()

protected bool doDestroy(string $sessionId)

Parameters

string $sessionId

Return Value

bool
in AbstractSessionHandler at line 67

validateId()

public validateId($sessionId)

{@inheritdoc}

Parameters

$sessionId
in AbstractSessionHandler at line 78

read()

public read($sessionId)

{@inheritdoc}

Parameters

$sessionId
in AbstractSessionHandler at line 101

write()

public write($sessionId, $data)

{@inheritdoc}

Parameters

$sessionId
$data
at line 70

destroy()

public destroy($sessionId)

{@inheritdoc}

Parameters

$sessionId
at line 24

__construct()

public __construct(SessionHandlerInterface $handler)

Parameters

SessionHandlerInterface $handler
at line 54

updateTimestamp()

public updateTimestamp($sessionId, $data)

{@inheritdoc}

Parameters

$sessionId
$data
at line 91

close()

public close()

{@inheritdoc}

at line 99

gc()

public gc($maxlifetime)

{@inheritdoc}

Parameters

$maxlifetime

Source code

<?php

/*
 * This file is part of the Symfony package.
 *
 * (c) Fabien Potencier <fabien@symfony.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Symfony\Component\HttpFoundation\Session\Storage\Handler;

/**
 * Adds basic `SessionUpdateTimestampHandlerInterface` behaviors to another `SessionHandlerInterface`.
 *
 * @author Nicolas Grekas <p@tchwork.com>
 */
class StrictSessionHandler extends AbstractSessionHandler
{
    private $handler;
    private $doDestroy;

    public function __construct(\SessionHandlerInterface $handler)
    {
        if ($handler instanceof \SessionUpdateTimestampHandlerInterface) {
            throw new \LogicException(sprintf('"%s" is already an instance of "SessionUpdateTimestampHandlerInterface", you cannot wrap it with "%s".', get_class($handler), self::class));
        }

        $this->handler = $handler;
    }

    /**
     * {@inheritdoc}
     */
    public function open($savePath, $sessionName)
    {
        parent::open($savePath, $sessionName);

        return $this->handler->open($savePath, $sessionName);
    }

    /**
     * {@inheritdoc}
     */
    protected function doRead($sessionId)
    {
        return $this->handler->read($sessionId);
    }

    /**
     * {@inheritdoc}
     */
    public function updateTimestamp($sessionId, $data)
    {
        return $this->write($sessionId, $data);
    }

    /**
     * {@inheritdoc}
     */
    protected function doWrite($sessionId, $data)
    {
        return $this->handler->write($sessionId, $data);
    }

    /**
     * {@inheritdoc}
     */
    public function destroy($sessionId)
    {
        $this->doDestroy = true;
        $destroyed = parent::destroy($sessionId);

        return $this->doDestroy ? $this->doDestroy($sessionId) : $destroyed;
    }

    /**
     * {@inheritdoc}
     */
    protected function doDestroy($sessionId)
    {
        $this->doDestroy = false;

        return $this->handler->destroy($sessionId);
    }

    /**
     * {@inheritdoc}
     */
    public function close()
    {
        return $this->handler->close();
    }

    /**
     * {@inheritdoc}
     */
    public function gc($maxlifetime)
    {
        return $this->handler->gc($maxlifetime);
    }
}