NativeSessionStorage.php

Go to the documentation of this file.

<?php
namespace Elgg\Http;

class NativeSessionStorage implements \Elgg\Http\SessionStorage {

    protected $started = false;

    protected $closed = false;

    public function __construct(array $options = array(), \Elgg\Http\SessionHandler $handler = null) {
        $this->setOptions($options);
        $this->setHandler($handler);
    }

    public function start() {
        if ($this->started && !$this->closed) {
            return true;
        }

        if (!session_start()) {
            throw new \RuntimeException('Failed to start the session');
        }

        $this->started = true;
        $this->closed = false;

        return true;
    }

    public function regenerate($destroy = false, $lifetime = null) {
        if (null !== $lifetime) {
            ini_set('session.cookie_lifetime', $lifetime);
        }

        return session_regenerate_id($destroy);
    }

    public function save() {
        session_write_close();

        $this->closed = true;
    }

    public function isStarted() {
        return $this->started;
    }

    public function getId() {
        if (!$this->started) {
            return ''; // returning empty is consistent with session_id() behavior
        }

        return session_id();
    }

    public function setId($id) {
        if ($this->started) {
            throw new \RuntimeException('Cannot change the ID of an active session');
        }

        session_id($id);
    }

    public function getName() {
        return session_name();
    }

    public function setName($name) {
        session_name($name);
    }

    public function has($name) {
        if (!$this->started) {
            $this->start();
        }

        return array_key_exists($name, $_SESSION);
    }

    public function get($name, $default = null) {
        if (!$this->started) {
            $this->start();
        }
        return array_key_exists($name, $_SESSION) ? $_SESSION[$name] : $default;
    }

    public function set($name, $value) {
        if (!$this->started) {
            $this->start();
        }
        $_SESSION[$name] = $value;
    }

    public function all() {
        if (!$this->started) {
            $this->start();
        }
        return $_SESSION;
    }

    public function replace(array $attributes) {
        if (!$this->started) {
            $this->start();
        }
        $_SESSION = array();
        foreach ($attributes as $key => $value) {
            $this->set($key, $value);
        }
    }

    public function remove($name) {
        if (!$this->started) {
            $this->start();
        }
        $retval = null;
        if (array_key_exists($name, $_SESSION)) {
            $retval = $_SESSION[$name];
            unset($_SESSION[$name]);
        }

        return $retval;
    }

    public function clear() {
        if (!$this->started) {
            $this->start();
        }
        $_SESSION = array();
    }

    protected function setOptions(array $options) {
        $validOptions = array_flip(array(
            'cache_limiter', 'cookie_domain', 'cookie_httponly',
            'cookie_lifetime', 'cookie_path', 'cookie_secure',
            'entropy_file', 'entropy_length', 'gc_divisor',
            'gc_maxlifetime', 'gc_probability', 'hash_bits_per_character',
            'hash_function', 'name', 'referer_check',
            'serialize_handler', 'use_cookies',
            'use_only_cookies', 'use_trans_sid', 'upload_progress.enabled',
            'upload_progress.cleanup', 'upload_progress.prefix', 'upload_progress.name',
            'upload_progress.freq', 'upload_progress.min-freq', 'url_rewriter.tags',
        ));

        foreach ($options as $key => $value) {
            if (isset($validOptions[$key])) {
                ini_set('session.' . $key, $value);
            }
        }
    }

    protected function setHandler($handler) {
        session_set_save_handler(
            array($handler, 'open'),
            array($handler, 'close'),
            array($handler, 'read'),
            array($handler, 'write'),
            array($handler, 'destroy'),
            array($handler, 'gc'));
    }

}