Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/carry0987/sessionmanager
Modern PHP Session Management Library
https://github.com/carry0987/sessionmanager
composer php session-management
Last synced: about 2 months ago
JSON representation
Modern PHP Session Management Library
- Host: GitHub
- URL: https://github.com/carry0987/sessionmanager
- Owner: carry0987
- License: mit
- Created: 2024-01-09T04:43:37.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-07-20T15:45:05.000Z (7 months ago)
- Last Synced: 2024-10-05T14:15:20.549Z (4 months ago)
- Topics: composer, php, session-management
- Language: PHP
- Homepage:
- Size: 35.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SessionManager
[](https://packagist.org/packages/carry0987/session-manager)
Modern PHP Session Management Library
## Introduction
`SessionManager` is a modern PHP session management library that provides an object-oriented wrapper around PHP's native session handling functions. It implements the `SessionHandlerInterface`, allowing for easy integration with existing projects. Additionally, it offers extra features such as session encryption and database storage handlers for scalable applications.
## Features
- Object-oriented session management.
- Protection against session fixation attacks.
- Automatic handling of session expiration.
- CSRF token generation and validation mechanisms.
- Easy integration into existing projects or frameworks.
- Support for custom session names and cookie parameters.
## Installation
You can install `SessionManager` via Composer:
```bash
composer require carry0987/session-manager
```
## Usage
Here is a basic example of how to use `SessionManager`:
```php
require 'vendor/autoload.php';
use carry0987\SessionManager\SessionManager;
// Create a SessionManager instance, you may optionally supply a custom session name and cookie parameters
$sessionManager = new SessionManager('MY_SESSION_NAME', [
'lifetime' => 3600, // Cookie lifetime
'secure' => true, // Send only over HTTPS
'httponly' => true, // Accessible only through the HTTP protocol
'samesite' => 'Strict' // Strict same-site policy
]);
// Set a session variable
$sessionManager->set('username', 'user123');
// Retrieve a session variable
$username = $sessionManager->get('username');
// Destroy the session
$sessionManager->destroy();
// Renew the session
$sessionManager->renew('MY_SESSION_NAME');
```
## Security Features
- Session fixation attack protection: `SessionManager` regenerates the session ID periodically.
- Session expiration mechanism: Sessions automatically expire after a period of inactivity.
- CSRF protection: Generates and validates CSRF tokens.
- Secure cookie parameters: Cookies are marked as HttpOnly and Secure by default to enhance security.
## API Reference
Here is a list of methods provided by `SessionManager`:
- `set($key, $value)`: Set a session variable.
- `get($key)`: Get a session variable.
- `exists($key)`: Check if a session variable exists.
- `remove($key)`: Remove a session variable.
- `destroy()`: Destroy the session.
- For more detailed methods and usage instructions, see the code comments.
## Contributing
If you have any suggestions for improvement or feature requests, please open an issue or submit a pull request.
## License
This project is licensed under the MIT License. See the LICENSE file for more information.