pinga/pingsess

A PHP session handler

v0.1.1 2023-03-10 13:17 UTC

Requires

• php: ^8.1
• pinga/cookie: ^0.2
• psr/http-message: ^1
• psr/http-server-handler: ^1
• psr/http-server-middleware: ^1

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3
• middlewares/utils: ^3
• nyholm/psr7: ^1.5
• phpstan/phpstan: ^1
• phpunit/phpunit: ^7 || ^8 || ^9
• squizlabs/php_codesniffer: ^3
• symfony/console: 6.0.*
• symfony/event-dispatcher: 6.0.*
• symfony/filesystem: 6.0.*
• symfony/finder: 6.0.*

Suggests

• ext-memcached: *
• ext-pdo: *
• league/flysystem: ^3.0

MIT

• session
• slim

README

A middleware (PSR-15) oriented session and flash message handler for PHP, based on the wonderful odan/session. For basic documentation, check:

Common example

// Start the session
$session->start();

// Set a session variable
$session->set('user_id', 123);

// Get a session variable
$user_id = $session->get('user_id');

// Check if a session variable exists
if ($session->has('user_id')) {
    // ...
}

// Delete a session variable
$session->delete('user_id');

// Clear all session variables
$session->clear();

// Regenerate the session ID
$session->regenerateId();

// Destroy the session
$session->destroy();

Specific examples

$config = [
    'name' => 'app',
];

// Create a standard session handler
$session = new \Odan\Session\PhpSession($config);

use Odan\Session\MemorySession;

$session = new MemorySession();

use League\Flysystem\Filesystem;
use League\Flysystem\Adapter\Local;
use Odan\Session\FilesystemSession;

// Create a Filesystem instance
$adapter = new Local(__DIR__.'/sessions');
$filesystem = new Filesystem($adapter);

// Create a FilesystemSession instance
$session = new FilesystemSession($filesystem, [
    'name' => 'my_session',
]);

use Odan\Session\RedisSession;
use Redis;

$redis = new Redis();
$redis->connect('127.0.0.1', 6379);

$session = new RedisSession($redis, [
    'name' => 'my_app_session',
    'lifetime' => 3600,
]);

use Odan\Session\MemcachedSession;
use Memcached;

$memcached = new Memcached();
$memcached->addServer('localhost', 11211);

$session = new MemcachedSession($memcached, [
    'name' => 'my_app_session',
    'lifetime' => 3600,
]);

use Odan\Session\PdoSession;
use PDO;

$dsn = 'mysql:host=localhost;dbname=my_database';
$username = 'my_username';
$password = 'my_password';

$pdo = new PDO($dsn, $username, $password);
$pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);

$session = new PdoSession($pdo, [
    'name' => 'my_app_session',
    'lifetime' => 3600,
    'db_table' => 'my_sessions',
]);