erdiko/session

Session Handler

0.1.1 2017-09-13 20:34 UTC

This package is not auto-updated.

Last update: 2021-01-15 02:41:55 UTC


README

Package version CircleCI License

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.

Installation

We recommend installing Erdiko Session Package with Composer. 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 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

  • 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

License

Erdiko is open-sourced software licensed under the MIT license