session_set_save_handler - PHP code example

The php Function Session_Set_Save_Handler

The php function session_set_save_handler allows you to set a custom save handler. This allows you to store your session data outside the standard $_SESSION array and avoid storing the same information multiple times in different locations on the server (such as in memory or in databases).

The handler should be a class that implements the SessionHandlerInterface. You can use the __autoload() method to automatically register your handler when a new object of your class is created. This is useful when your class needs to be registered as a session handler (or any other kind of handling).

If you need to read a value from a variable in the $_SESSION array, you can use the getvalue() method of your class. This will return a string that is serialized by the internal engine of php. You should not try to serialize objects in PHP directly by calling the serialize() method, this may result in problems if you have other functions in your class that are called on it such as destructors or constructors.

If you want to write values to a database, make sure that you call addslashes() on the serialized data sent to your custom handler. Without adding slashes, MySQL will not be able to understand the values and will truncate them when they are saved. This is especially important if you are using the MEMORY storage engine with PHP and magic_quotes enabled.

session_set_save_handler example

$saveHandler = new SessionHandlerProxy($saveHandler);
        } elseif (!$saveHandler instanceof AbstractProxy) {
            $saveHandler = new SessionHandlerProxy(new StrictSessionHandler(new \SessionHandler()));
        }
        $this->saveHandler = $saveHandler;

        if (headers_sent() || \PHP_SESSION_ACTIVE === session_status()) {
            return;
        }

        if ($this->saveHandler instanceof SessionHandlerProxy) {
            session_set_save_handler($this->saveHandler, false);
        }
    }

    /** * Load the session with attributes. * * After starting the session, PHP retrieves the session from whatever handlers * are set to (either PHP's internal, or a custom save handler set with session_set_save_handler()). * PHP takes the return value from the read() handler, unserializes it * and populates $_SESSION with the result automatically. * * @return void */

<?php
require __DIR__.'/common.inc';

setcookie('abc', 'def');

session_set_save_handler(new TestSessionHandler('abc|i:123;'), false);
session_start();
session_write_close();
session_start();

$_SESSION['abc'] = 234;
unset($_SESSION['abc']);

            // should be used as session id.             session_id('');
        }

        $sessionOptions = $this->getSessionOptions();
        $saveHandler = $this->createSaveHandler(Shopware()->Container());
        $storage = new NativeSessionStorage($sessionOptions);

        if (!empty($sessionOptions['unitTestEnabled'])) {
            $storage = new MockArraySessionStorage();
        } elseif ($saveHandler) {
            session_set_save_handler($saveHandler);
        }

        if (isset($sessionOptions['save_path'])) {
            ini_set('session.save_path', (string) $sessionOptions['save_path']);
        }

        if (isset($sessionOptions['save_handler'])) {
            ini_set('session.save_handler', (string) $sessionOptions['save_handler']);
        }

        $session = new Enlight_Components_Session_Namespace($storage, new NamespacedAttributeBag('ShopwareBackend'));

$sessionOptions['name'] = $name;

        if ($mainShop->getSecure()) {
            $sessionOptions['cookie_secure'] = true;
        }

        $basePath = $mainShop->getBasePath();
        $sessionOptions['cookie_path'] = empty($basePath) ? '/' : $basePath;

        if ($saveHandler) {
            if (empty($sessionOptions['unitTestEnabled'])) {
                session_set_save_handler($saveHandler);
            }
            unset($sessionOptions['save_handler']);
        }

        unset($sessionOptions['locking']);

        if (isset($sessionOptions['save_path'])) {
            ini_set('session.save_path', (string) $sessionOptions['save_path']);
        }

        if (isset($sessionOptions['save_handler'])) {

        return $keys;
    }

    /** * Sets the driver as the session handler in PHP. * Extracted for easier testing. */
    protected function setSaveHandler()
    {
        session_set_save_handler($this->driver, true);
    }

    /** * Starts the session. * Extracted for testing reasons. */
    protected function startSession()
    {
        if (ENVIRONMENT === 'testing') {
            $_SESSION = [];

<?php
require __DIR__.'/common.inc';

session_set_save_handler(new TestSessionHandler('abc|i:123;'), false);
session_start();

echo $_SESSION['abc'];

<?php
require __DIR__.'/common.inc';

session_set_save_handler(new TestSessionHandler('abc|i:123;'), false);
session_start();

session_regenerate_id(true);

ob_start(fn ($buffer) => str_replace(session_id(), 'random_session_id', $buffer));

<?php
require __DIR__.'/common.inc';

session_set_save_handler(new TestSessionHandler('abc|i:123;'), false);
session_start();

setcookie('abc', 'def');

<?php
require __DIR__.'/common.inc';

session_set_save_handler(new TestSessionHandler('abc|i:123;'), false);
session_start();

unset($_SESSION['abc']);