Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cs-eliseev/helpers-session
The helpers allows you to easily manage session data. START, SET, GET DELETE, HAS method session - all this is available in this library.
https://github.com/cs-eliseev/helpers-session
collection collections cse framework helper helpers library php session sessions tool tools utilities utility utils
Last synced: 11 days ago
JSON representation
The helpers allows you to easily manage session data. START, SET, GET DELETE, HAS method session - all this is available in this library.
- Host: GitHub
- URL: https://github.com/cs-eliseev/helpers-session
- Owner: cs-eliseev
- License: mit
- Created: 2019-02-01T19:55:04.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2019-05-12T15:50:52.000Z (over 5 years ago)
- Last Synced: 2024-09-19T01:51:04.153Z (3 months ago)
- Topics: collection, collections, cse, framework, helper, helpers, library, php, session, sessions, tool, tools, utilities, utility, utils
- Language: PHP
- Size: 53.7 KB
- Stars: 8
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
English | [Русский](https://github.com/cs-eliseev/helpers-session/blob/master/README.ru_RU.md)
SESSION CSE HELPERS
=======
[](https://travis-ci.org/cs-eliseev/helpers-session)
[](https://codecov.io/gh/cs-eliseev/helpers-session)
[](https://scrutinizer-ci.com/g/cs-eliseev/helpers-session/?branch=master)
[](https://packagist.org/packages/cse/helpers-session)
[](https://packagist.org/packages/cse/helpers-session)
[](https://github.com/cs-eliseev/helpers-session/blob/master/LICENSE.md)
[](https://github.com/cs-eliseev/helpers-session/archive/master.zip)
The helpers allows you to easily manage session data. START, SET, GET DELETE, HAS method session - all this is available in this library.
Project repository: https://github.com/cs-eliseev/helpers-session
**DEMO**
```php
Session::set(
'example_key',
Session::getNotEmpty('example_key', 'default_value')
);
if (is_int(Session::get('example_key'))) {
Session::remove('example_key');
}
$is_not_int = Session::has('example_key');
```
***
## Introduction
[CSE HELPERS](https://github.com/cs-eliseev/helpers/blob/master/README.md) is a collection of several libraries with simple functions written in PHP for people.
Despite using PHP as the main programming language for the Internet, its functions are not enough. SESSION CSE HELPERS allows you to easy START, SET, GET DELETE session.
[CSE HELPERS](https://github.com/cs-eliseev/helpers/blob/master/README.md) was created for the rapid development of web applications.
**CSE Helpers project:**
* [Array CSE helpers](https://github.com/cs-eliseev/helpers-arrays)
* [Cookie CSE helpers](https://github.com/cs-eliseev/helpers-cookie)
* [Date CSE helpers](https://github.com/cs-eliseev/helpers-date)
* [Email CSE helpers](https://github.com/cs-eliseev/helpers-email)
* [IP CSE helpers](https://github.com/cs-eliseev/helpers-ip)
* [Json CSE helpers](https://github.com/cs-eliseev/helpers-json)
* [Math Converter CSE helpers](https://github.com/cs-eliseev/helpers-math-converter)
* [Phone CSE helpers](https://github.com/cs-eliseev/helpers-phone)
* [Request CSE helpers](https://github.com/cs-eliseev/helpers-request)
* [Session CSE helpers](https://github.com/cs-eliseev/helpers-session)
* [Word CSE helpers](https://github.com/cs-eliseev/helpers-word)
Below you will find some information on how to init library and perform common commands.
## Install
You can find the most recent version of this project [here](https://github.com/cs-eliseev/helpers-session).
### Composer
Execute the following command to get the latest version of the package:
```bash
composer require cse/helpers-session
```
Or file composer.json should include the following contents:
```json
{
"require": {
"cse/helpers-session": "*"
}
}
```
### Git
Clone this repository locally:
```bash
git clone https://github.com/cs-eliseev/helpers-session.git
```
### Download
[Download the latest release here](https://github.com/cs-eliseev/helpers-session/archive/master.zip).
## Usage
The class consists of static methods that are conveniently used in any project. See example [examples-session.php](https://github.com/cs-eliseev/helpers-session/blob/master/examples/examples-session.php).
**START session**
Example:
```php
Session::start();
// true
```
**SET session**
Example:
```php
Session::set('example_key', 'example_value');
// ['example_key' => 'example_value']
```
Use multi key:
```php
Session::setMultiKey('cse');
Session::set('example_key_2', 'example_value_2');
// ['cse' => ['example_key_2' => 'example_value_2']]
```
**HAS session**
Example:
```php
Session::set('example_key', 'example_value');
Session::has('example_key');
// true
```
Use multi key:
```php
Session::setMultiKey('cse');
Session::has('example_key');
// false
```
**GET session**
Example:
```php
Session::set('example_key', 'example_value');
Session::get('example_key');
// example_value
```
Use multi key:
```php
Session::setMultiKey('cse');
Session::set('example_key_2', 'example_value_2');
Session::get('example_key_2');
// example_value_2
```
Set default value is not exist session:
```php
Cookie::get('example_key_3', 'example_default_value_3');
// example_default_value_3
```
**GET NOT EMPTY session**
Example:
```php
Session::set('example_key', 'example_value');
Session::getNotEmpty('example_key', 'example_default_value');
// example_value
```
Use multi key:
```php
Session::setMultiKey('cse');
Session::set('example_key_2', 'example_value_2');
Session::getNotEmpty('example_key_2');
// example_value_2
```
Set default value is not exist session:
```php
Cookie::getNotEmpty('example_key_3', 'example_default_value_3');
// example_default_value_3
```
Set default value empty session data:
```php
Session::set('example_key_4', '');
Cookie::getNotEmpty('example_key_4', 'example_default_value_4');
// example_default_value_4
```
**REMOVE session**
Example:
```php
Session::set('example_key', 'example_value');
Session::remove('example_key');
Session::has('example_key');
// false
```
Use multi key:
```php
Session::setMultiKey('cse');
Session::set('example_key_2', 'example_value_2');
Session::remove('example_key_2');
Session::has('example_key_2');
// false
```
**SET MULTI KEY session**
Example:
```php
Session::set('example_key', 'example_value');
// ['example_key' => 'example_value']
Session::setMultiKey('cse');
Session::set('example_key_2', 'example_value_2');
/**
* [
* 'example_key' => 'example_value',
* 'cse' => [
* 'example_key_2' => 'example_value_2'
* ]
* ]
*/
Session::set('example_key_3', 'example_value_3');
/**
* [
* 'example_key' => 'example_value',
* 'cse' => [
* 'example_key_2' => 'example_value_2',
* 'example_key_3' => 'example_value_3'
* ]
* ]
*/
Session::setMultiKey();
Session::set('example_key_4', 'example_value_4');
/**
* [
* 'example_key' => 'example_value',
* 'cse' => [
* 'example_key_2' => 'example_value_2',
* 'example_key_3' => 'example_value_3'
* ],
* 'example_key_4' => 'example_value_4',
* 'example' => [
* 'example_key_5' => 'example_value_5'
* ],
* ]
*/
Session::setMultiKey('example');
Session::set('example_key_5', 'example_value_5');
```
Global use:
```php
class DefaultSessionData
{
public function setSessionData(): void
{
Session::setMultiKey();
Session::set('example_key_2', 'example_value_2');
}
}
class CseSessionData
{
public function setSessionData(): void
{
Session::setMultiKey('cse');
Session::set('example_key_1', 'example_value_1');
}
}
class ExtendSessionData
{
public function setSessionData(string $key, string $value): void
{
Session::set($key, $value);
}
}
$default = new DefaultSessionData();
$cse = new CseSessionData();
$extend = new ExtendSessionData();
$extend->setSessionData('example_key_0', 'example_value_0');
// ['example_key_0' => 'example_value_0']
$cse->setSessionData();
/**
* [
* 'example_key_0' => 'example_value_0',
* 'cse' => [
* 'example_key_1' => 'example_value_1'
* ]
* ]
*/
$extend->setSessionData('example_key_1_1', 'example_value_1_1');
/**
* [
* 'example_key_0' => 'example_value_0',
* 'cse' => [
* 'example_key_1' => 'example_value_1',
* 'example_key_1_1' => 'example_value_1_1'
* ]
* ]
*/
$default->setSessionData();
/**
* [
* 'example_key_0' => 'example_value_0',
* 'cse' => [
* 'example_key_1' => 'example_value_1',
* 'example_key_1_1' => 'example_value_1_1'
* ],
* 'example_key_2' => 'example_value_2'
* ]
*/
$extend->setSessionData('example_key_2_1', 'example_value_2_1');
/**
* [
* 'example_key_0' => 'example_value_0',
* 'cse' => [
* 'example_key_1' => 'example_value_1',
* 'example_key_1_1' => 'example_value_1_1'
* ],
* 'example_key_2' => 'example_value_2',
* 'example_key_2_1' => 'example_value_2_1'
* ]
*/
```
**Get ALL session data**
Example:
```php
Session::set('example_key', 'example_value');
Session::setMultiKey('cse');
Session::set('example_key_2', 'example_value_2');
Session::setMultiKey();
Session::all();
/**
* [
* 'example_key' => 'example_key',
* 'cse' => [
* 'example_key_2' => 'example_value_2'
* ]
* ]
*/
```
Use multi key:
```php
Session::set('example_key', 'example_value');
Session::setMultiKey('cse');
Session::set('example_key_2', 'example_value_2');
Session::all();
// ['example_key_2' => 'example_value_2']
```
**CLEAR session data**
Example:
```php
Session::set('example_key', 'example_value');
Session::setMultiKey('cse');
Session::set('example_key_2', 'example_value_2');
Session::setMultiKey();
Session::claer();
// []
```
Use multi key:
```php
Session::set('example_key', 'example_value');
Session::setMultiKey('cse');
Session::set('example_key_2', 'example_value_2');
Session::claer();
// ['example_key' => 'example_value']
```
**DESTROY session**
Example:
```php
Session::start();
// session_status() === PHP_SESSION_ACTIVE => true
Session::destroy();
// session_status() === PHP_SESSION_ACTIVE => false
```
**IS START session**
Example:
```php
Session::start();
Session::isStart();
// true
Session::destroy();
Session::isStart();
// false
```
## Testing & Code Coverage
PHPUnit is used for unit testing. Unit tests ensure that class and methods does exactly what it is meant to do.
General PHPUnit documentation can be found at https://phpunit.de/documentation.html.
To run the PHPUnit unit tests, execute:
```bash
phpunit PATH/TO/PROJECT/tests/
```
If you want code coverage reports, use the following:
```bash
phpunit --coverage-html ./report PATH/TO/PROJECT/tests/
```
Used PHPUnit default config:
```bash
phpunit --configuration PATH/TO/PROJECT/phpunit.xml
```
## Donating
You can support this project [here](https://www.paypal.me/cseliseev/10usd).
You can also help out by contributing to the project, or reporting bugs.
Even voicing your suggestions for features is great. Anything to help is much appreciated.
## License
The SESSION CSE HELPERS is open-source PHP library licensed under the MIT license. Please see [License File](https://github.com/cs-eliseev/helpers-session/blob/master/LICENSE.md) for more information.
***
> GitHub [@cs-eliseev](https://github.com/cs-eliseev)