Download the PHP package oire/serializer without Composer
On this page you can find all versions of the php package oire/serializer. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download oire/serializer
More information about oire/serializer
Files in oire/serializer
Package serializer
Short Description Data serializer for better storage and exchange.
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package serializer
Oiré Serializer — Data Serializer for Better Storage and Exchange
Serializes various data to different formats. There is also a possibility to additionally encode the output to URL-and filename-safe base64.
Depends on Oirë Base64 for encoding binary data to a storable format.
Requirements
Requires PHP 7.1 or later with JSON support enabled.
Requires additional PECL extensions for certain serialization modes, see below. If no PECL is available and none of the required extensions is installed in your environment (such a shared hosting), you can freely use Oirë Serializer with JSON.
Installation
Via Composer:
composer require oire/serializer
Or manually. Note that you will need base64.php from Oirë Base64:
Running Tests
Run phpunit in the projects directory.
Usage Examples
Serialization to JSON. Note that you can either call methods consequently or chain them, like this:
This will output:
Now unserializing:
This will return the original array. If you want to get an object instead, pass false as the third parameter to unserialize().
If you pass true as the second parameter to serialize(), the serialized data will be additionally encoded to URL-and filename-safe base64. This might be particularly useful if you choose a binary format such as MessagePack:
This will output:
Supported Serialization Modes
Currently the following modes are supported. Note, if the mode is binary, a raw binary string is returned if $base64 parameter is left as false during serialization which can be uncomfortable for reading or storage.
- JSON, non-binary. Pass
1,"j"or"json"tosetMode()to set this mode. - MessagePack, binary. Pass
2,"m","mp","msgpack"or"messagepack"tosetMode()to set this mode. Note that the corresponding PECL extension should be installed for this to work. - Igbinary, binary. Pass
3,"i","ib","ig"or"igbinary"tosetMode()to set this mode. Note that the corresponding PECL extension should be installed for this to work.
Methods
The methods are documented in the source file, but their description is given below.
We recommend to wrap every call in try...catch since Oirë Serializer throws exceptions in case of errors.
- Class constructor— you might provide a serialization mode when calling the constructor or directly call
setMode(). setMode(int|string $mode)— accepts either a numeric representation of the mode or a readable string such as"json". See the Supported Modes section above. Chainable, so returns the current class instance.getMode(bool $asString = false): int|string— gets the current serialization mode set bysetMode(). If$asStringis set totrue, returns a readable mode name such as"json", a numeric representation is returned otherwise (it is the default behavior). Throws an exception if the mode is not set or if it could not be found.getAvailableModes(bool $json = false): array|string— gets all available serialization modes. If the$jsonparameter is set totrue, returns them as a JSON string, an associative array is returned otherwise (this is the default behavior).serialize(mixed $data, bool $base64 = false): string— serializes given data according to the serialization mode set withsetMode(). If$base64is set totrue, additionally encodes the serialized data to URL-and filename-safe base64 (particularly useful for binary serialization formats such as MessagePack). If set tofalse(default), the serialized data is returned as a string, be it binary or not.unserialize(string $data, bool $base64 = false, bool $assoc = true): mixed— unserializes given data according to the serialization mode set withsetMode(). If$base64is set totrue, assumes that the data had been additionally encoded to URL-safe base64 after serialization. If$associs set totrue(default), returns an associative array, an object is returned otherwise. Note that the last parameter is applicable only to JSON serialization.
License
Copyright © 2017, Andre Polykanine also known as Menelion Elensúlë.
This software is licensed under an MIT license.
