https://github.com/wikimedia/php-session-serializer
Mirror of https://gerrit.wikimedia.org/g/php-session-serializer See https://www.mediawiki.org/wiki/Developer_access for contributing
https://github.com/wikimedia/php-session-serializer
Last synced: 3 months ago
JSON representation
Mirror of https://gerrit.wikimedia.org/g/php-session-serializer See https://www.mediawiki.org/wiki/Developer_access for contributing
- Host: GitHub
- URL: https://github.com/wikimedia/php-session-serializer
- Owner: wikimedia
- License: gpl-2.0
- Created: 2015-10-14T15:28:21.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2025-03-27T14:07:38.000Z (3 months ago)
- Last Synced: 2025-03-29T02:03:51.772Z (3 months ago)
- Language: PHP
- Homepage:
- Size: 131 KB
- Stars: 18
- Watchers: 14
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: COPYING
Awesome Lists containing this project
README
[![Latest Stable Version]](https://packagist.org/packages/wikimedia/php-session-serializer) [![License]](https://packagist.org/packages/wikimedia/php-session-serializer)
php-session-serializer
======================
php-session-serializer is a PHP library that provides methods that work like
PHP's [session_encode][phpencode] and [session_decode][phpdecode]
functions, but don't mess with the `$_SESSION` superglobal.
It supports the `php`, `php_binary`, and `php_serialize` serialize handlers.
`wddx` is not supported, since it is inferior to `php` and `php_binary`.
Usage
-----
```php
use Wikimedia\PhpSessionSerializer;
// (optional) Send logs to a PSR-3 logger
PhpSessionSerializer::setLogger( $logger )
// (optional) Ensure that session.serialize_handler is set to a usable value
PhpSessionSerializer::setSerializeHandler();
// Encode session data
$string = PhpSessionSerializer::encode( $array );
// Decode session data
$array = PhpSessionSerializer::decode( $string );
```
Running tests
-------------
composer install --prefer-dist
composer test
History
-------
This library was created to support custom session handler [read][] and
[write][] methods that are more useful than blindly storing the serialized data
that PHP gives to custom handlers.
---
[phpencode]: https://php.net/manual/en/function.session-encode.php
[phpdecode]: https://php.net/manual/en/function.session-decode.php
[read]: https://php.net/manual/en/sessionhandlerinterface.read.php
[write]: https://php.net/manual/en/sessionhandlerinterface.write.php
[Latest Stable Version]: https://poser.pugx.org/wikimedia/php-session-serializer/v/stable.svg
[License]: https://poser.pugx.org/wikimedia/php-session-serializer/license.svg