eden/session

Sever Side Persistent Data

Eden Session

• Install
• Introduction
• API
  • clear
  • get
  • getId
  • remove
  • set
  • setId
  • start
  • stop
• Contributing

====, _(*1)

, _(*2)

Install

composer install eden/session, _(*3)

====, _(*4)

, _(*5)

Introduction

Before using sessions, it's probably a good idea to start the session., _(*6)

$session = eden('session')->start();

The session returned is an array object and can be used like a normal array., _(*7)

$session['me']    = array('name' => 'John', 'age' => 31);
$session['you']    = array('name' => 'Jane', 'age' => 28);
$session['him']    = array('name' => 'Jack', 'age' => 35);

foreach($session as $key => $value) {
    echo $value['name'];
}

====, _(*8)

, _(*9)

clear

Removes all session data, _(*10)

Usage

eden('session')->clear();

Parameters

Returns Eden\Session\Index, _(*11)

====, _(*12)

, _(*13)

get

Returns data, _(*14)

Usage

eden('session')->get(string|null $key);

Parameters

• string|null $key - The key from the session

Returns scalar|null|array, _(*15)

Example

eden('session')->get();

====, _(*16)

, _(*17)

getId

Returns session id, _(*18)

Usage

eden('session')->getId();

Parameters

Returns int, _(*19)

====, _(*20)

, _(*21)

remove

Removes a session., _(*22)

Usage

eden('session')->remove(*string $name);

Parameters

• *string $name - session name

Returns Eden\Session\Index, _(*23)

Example

eden('session')->remove('foo');

====, _(*24)

, _(*25)

set

Sets data, _(*26)

Usage

eden('session')->set(*array|string $data, mixed $value);

Parameters

• *array|string $data - The array data to set
• mixed $value - If data is a key then this is the value

Returns Eden\Session\Index, _(*27)

Example

eden('session')->set(array('foo' => 'bar'));

====, _(*28)

, _(*29)

setId

Sets the session ID, _(*30)

Usage

eden('session')->setId(*int $id);

Parameters

• *int $id - The prescribed session ID to use

Returns int, _(*31)

Example

eden('session')->setId(123);

====, _(*32)

, _(*33)

start

Starts a session, _(*34)

Usage

eden('session')->start();

Parameters

Returns Eden\Session\Index, _(*35)

====, _(*36)

, _(*37)

stop

Starts a session, _(*38)

Usage

eden('session')->stop();

Parameters

Returns Eden\Session\Index, _(*39)

====, _(*40)

, _(*41)

Contributing to Eden

Contributions to Eden are following the Github work flow. Please read up before contributing., _(*42)

Setting up your machine with the Eden repository and your fork

1. Fork the repository
2. Fire up your local terminal create a new branch from the v4 branch of your fork with a branch name describing what your changes are. Possible branch name types:
   • bugfix
   • feature
   • improvement
3. Make your changes. Always make sure to sign-off (-s) on all commits made (git commit -s -m "Commit message")

Making pull requests

1. Please ensure to run phpunit before making a pull request.
2. Push your code to your remote forked version.
3. Go back to your forked version on GitHub and submit a pull request.
4. An Eden developer will review your code and merge it in when it has been classified as suitable.