The SessionHandlerInterface class

(PHP 5 >= 5.4.0, PHP 7)

简介

SessionHandlerInterfaceis aninterfacewhich defines a prototype for creating a custom session handler. In order to pass a custom session handler tosession_set_save_handler()using itsOOPinvocation, the class must implement this interface.

Please note the callback methods of this class are designed to be called internally by PHP and are not meant to be called from user-space code.

类摘要

SessionHandlerInterface{abstract public close(void): bool abstract public destroy(string $session_id): bool abstract public gc(int $maxlifetime): int abstract public open(string $save_path , string $session_name): bool abstract public read(string $session_id): string abstract public write(string $session_id , string $session_data): bool}

Example #1 Example usingSessionHandlerInterface

The following example provides file based session storage similar to the PHP sessions default save handlerfiles. This example could easily be extended to cover database storage using your favorite PHP supported database engine.

Note we use the OOP prototype withsession_set_save_handler()and register the shutdown function using the function's parameter flag. This is generally advised when registering objects as session save handlers.

For brevity, this example omits input validation. However, the$idparameters are actually user supplied values which require proper validation/sanitization to avoid vulnerabilities, such as path traversal issues.So do not use this example unmodified in production environments.
<?php
class MySessionHandler implements SessionHandlerInterface
{
    private $savePath;

    public function open($savePath, $sessionName)
    {
        $this->savePath = $savePath;
        if (!is_dir($this->savePath)) {
            mkdir($this->savePath, 0777);
        }

        return true;
    }

    public function close()
    {
        return true;
    }

    public function read($id)
    {
        return (string)@file_get_contents("$this->savePath/sess_$id");
    }

    public function write($id, $data)
    {
        return file_put_contents("$this->savePath/sess_$id", $data) === false ? false : true;
    }

    public function destroy($id)
    {
        $file = "$this->savePath/sess_$id";
        if (file_exists($file)) {
            unlink($file);
        }

        return true;
    }

    public function gc($maxlifetime)
    {
        foreach (glob("$this->savePath/sess_*") as $file) {
            if (filemtime($file) + $maxlifetime < time() && file_exists($file)) {
                unlink($file);
            }
        }

        return true;
    }
}

$handler = new MySessionHandler();
session_set_save_handler($handler, true);
session_start();

// proceed to set and retrieve values by key from $_SESSION