LegalThings\MongodbSessionHandler

Complexity

Total Complexity

12

Size/Duplication

Total Lines	137
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	open()	0	4	1
A	read()	0	16	3
A	close()	0	5	1
A	write()	0	10	2
A	destroy()	0	9	2
A	gc()	0	3	1
A	create_sid()	0	7	1

<?php

namespace LegalThings;

/**
 * A class that implements SessionHandlerInterface and can be used to store sessions as structured data in MongoDB
 */
class MongodbSessionHandler implements \SessionHandlerInterface
{
    /**
     * Session collection
     * @var \MongoDB\Collection
     */
    protected $collection;

    /**
     * Never store changes to a session
     * @var boolean
     */
    protected $readonly = false;


    /**
     * Class constructor
     * 
     * @param \MongoDB\Collection $collection
     * @param string              $mode        'w' for read-write or 'r' for read-only
     */
    public function __construct(\MongoDB\Collection $collection, $mode = 'w')
    {
        $this->collection = $collection;
        $this->readonly = ($mode === 'r');
    }
    
    /**
     * Initialize session
     * @link http://php.net/manual/en/sessionhandlerinterface.open.php
     * 
     * @param string $save_path  The path where to store/retrieve the session.
     * @param string $name       The session name.
     * @return boolean
     */
    public function open($save_path, $name)
    {
        return true;
    }

    /**
     * Close the session
     * @link http://php.net/manual/en/sessionhandlerinterface.close.php
     * 
     * @return boolean
     */
    public function close()
    {
        unset($_SESSION);
        return true;
    }

    /**
     * (PHP 5 &gt;= 5.4.0)<br/>
     * Read session data
     * @link http://php.net/manual/en/sessionhandlerinterface.read.php
     * @param string $session_id  The session id.
     * @return string
     */
    public function read($session_id)
    {
        $values = $this->collection->findOne(['_id' => $session_id]);
        
        if (empty($values)) {
            return '';
        }
        
        unset($values['_id']);

        foreach ($values as $key => $value) {
            $_SESSION[$key] = $value;
        }

        return '';
    }

    /**
     * (PHP 5 &gt;= 5.4.0)<br/>
     * Write session data
     * @link http://php.net/manual/en/sessionhandlerinterface.write.php
     * @param string $session_id    The session id.
     * @param string $session_data  The encoded session data.
     * @return boolean
     */
    public function write($session_id, $session_data)
    {
        if ($this->readonly) {
            return true;
        }
        
        $this->collection->insertOne(['_id' => $session_id] + $_SESSION);

        return true;
    }

    /**
     * (PHP 5 &gt;= 5.4.0)<br/>
     * Destroy a session
     * @link http://php.net/manual/en/sessionhandlerinterface.destroy.php
     * @param string $session_id The session ID being destroyed.
     * @return boolean
     */
    public function destroy($session_id)
    {
        if ($this->readonly) {
            return true;
        }
        
        $this->collection->deleteOne(['_id' => $session_id]);
        return true;
    }

    /**
     * This method must be implemented for the interface, but isn't used. Instead use a MongoDB tty index.
     * @link http://php.net/manual/en/sessionhandlerinterface.gc.php
     * @link https://docs.mongodb.com/manual/core/index-ttl/
     * 
     * @param int $maxlifetime
     */
    public function gc($maxlifetime)
    {
    }
    
    /**
     * This callback is executed when a new session ID is required. No parameters are provided, and the return value
     * should be a string that is a valid session ID for your handler.
     * 
     * @return string
     */
    public function create_sid()

Method name "MongodbSessionHandler::create_sid" is not in camel caps format

    {
        $hex = bin2hex(random_bytes(16));
        $id = base_convert($hex, 16, 36);
        
        return sprintf('%024s', substr($id, -24));
    }
}