https://github.com/erdiko/session
Erdiko session handler
https://github.com/erdiko/session
php session session-driver
Last synced: about 1 year ago
JSON representation
Erdiko session handler
- Host: GitHub
- URL: https://github.com/erdiko/session
- Owner: Erdiko
- License: mit
- Created: 2017-08-02T20:20:20.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-09-13T20:35:22.000Z (over 8 years ago)
- Last Synced: 2025-04-08T12:21:13.355Z (about 1 year ago)
- Topics: php, session, session-driver
- Language: PHP
- Homepage: http://erdiko.org
- Size: 33.2 KB
- Stars: 4
- Watchers: 5
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Erdiko Session Package
[](https://packagist.org/packages/erdiko/session)
[](https://circleci.com/gh/Erdiko/session)
[](https://packagist.org/packages/erdiko/session)
## Important: This package is currently on development, please don't use it until have a beta or stable version.
### Introduction
Erdiko Session is a package to handle in an easy and elastic way to persistent user data through the lifetime of your application.
### Official Documentation
Documentation for Erdiko Session Package can be found on the [Erdiko website](http://erdiko.org/session/).
### Installation
We recommend installing Erdiko Session Package with [Composer](https://getcomposer.org/). At the commandline simply run:
```
composer require erdiko/session
```
### Drivers
Current Drivers Available:
- File: SessionDriverFile
Coming Drivers in development:
- Redis: SessionDriverRedis
- Database: SessionDriverDatabase
- Cookie: SessionDriverCookie
### Dependencies
This package depends of Erdiko\Core
### Configuration
File Path
```
[site_root]/app/config/default/session.json
```
File format
```
{
"default": { // Driver Source
"driver": "file", // Driver Type
"path": "/tmp",
"lifetime": 60000
}
}
```
### Available Methods
You will find several methods that will satisfy your requirements for handling session data.
- get
- set
- has
- forget
- exists
### Basic Usage
For more details please see [*Advance Usage Detail*](/advanceUsage.md) Page.
#### Set Method
Set the value on session
```
Session::set('name', 'value');
```
#### Get method
Retrieves the value from the session
```
Session::get('name');
```
#### Has method
Verifies if the given key exists and has a value on the session
```
Session::get('name');
```
#### Exists method
Verifies if the given key exists, without verify if has or not value
```
Session::set('name', 'value');
```
#### Forget method
Removes the given key from the session
```
Session::set('name', 'value');
```
### Tests
*On development*
### Credits
* Mauricio Gastón
* John Arroyo
* Leo Daidone
[All Contributors](https://github.com/Erdiko/session/graphs/contributors)
* If you want to help, please do, we'd love more brainpower! Fork, commit your enhancements and do a pull request. If you want to get to even more involved please contact us!
### Sponsors
[Arroyo Labs](http://www.arroyolabs.com/)
### License
Erdiko is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT)