README

简介

SessionStorage 是一个PHP库，它提供了一个简单的 SessionStorageInterface 实现。它允许开发者以方便的方式处理PHP会话，提供了获取、设置、检查和删除会话数据的方法。此库需要PHP版本7.4或更高。

安装

使用Composer

Composer要求

composer require devcoder-xyz/php-session

用法

要开始使用 SessionStorage，您需要创建一个 NativeSessionStorage 类的实例。以下是一个示例：

use DevCoder\Session\Storage\NativeSessionStorage;

// Create a new session storage instance
$sessionStorage = new NativeSessionStorage();

使用场景

SessionStorage 库提供了以下方法来与PHP会话交互

1. 检查会话中是否存在键

if ($sessionStorage->has('user_id')) {
    // Do something with the user_id
}

2. 获取会话键的值

$userName = $sessionStorage->get('username', 'Guest');
// If the 'username' key exists in the session, $userName will be set to its value,
// otherwise, it will be set to 'Guest'.

3. 在会话中设置值

$userId = 123;
$sessionStorage->put('user_id', $userId);

4. 从会话中删除键

$sessionStorage->remove('user_id');

5. 以数组形式获取所有会话数据

$allData = $sessionStorage->all();

接口实现

NativeSessionStorage 类实现了 SessionStorageInterface，它扩展了 ArrayAccess 接口。因此，实现 SessionStorageInterface 的任何类也应实现 ArrayAccess 接口中定义的方法。以下是如何在自定义类中实现 SessionStorageInterface 的示例：

use DevCoder\Session\Storage\SessionStorageInterface;

class MyCustomSessionStorage implements SessionStorageInterface
{
    private array $storage;

    public function __construct()
    {
        // Initialize your custom storage mechanism here
        // For example, you could use a database, Redis, or any other storage solution.
        // In this example, we will use an array as a simple custom storage mechanism.
        $this->storage = [];
    }

    public function get(string $key, $default = null)
    {
        return $this->storage[$key] ?? $default;
    }

    public function put(string $key, $value = null): void
    {
        $this->storage[$key] = $value;
    }

    public function all(): array
    {
        return $this->storage;
    }

    public function has(string $key): bool
    {
        return isset($this->storage[$key]);
    }

    public function remove(string $key): void
    {
        unset($this->storage[$key]);
    }

    // Implementing ArrayAccess methods

    public function offsetExists($offset): bool
    {
        return isset($this->storage[$offset]);
    }

    public function offsetGet($offset)
    {
        return $this->get($offset);
    }

    public function offsetSet($offset, $value): void
    {
        $this->put($offset, $value);
    }

    public function offsetUnset($offset): void
    {
        $this->remove($offset);
    }
}

在这个示例中，我们创建了一个自定义会话存储类 MyCustomSessionStorage，它实现了 SessionStorageInterface。它使用一个简单的数组来存储会话数据，但您可以根据具体的使用场景将其替换为任何自定义存储机制，如数据库、Redis等。

结论

SessionStorage 库通过提供一个干净且易于使用的接口简化了与PHP会话的工作。它非常适合需要高效管理会话数据的应用程序。请随意探索该库的源代码，并在GitHub上为其开发做出贡献。

devcoder-xyz / php-session

维护者

详细信息