https://github.com/et-nik/binn-php
Binary Serialization. PHP Class for serialize to binary string.
https://github.com/et-nik/binn-php
bin binary php-library serialization symfony-component
Last synced: about 1 year ago
JSON representation
Binary Serialization. PHP Class for serialize to binary string.
- Host: GitHub
- URL: https://github.com/et-nik/binn-php
- Owner: et-nik
- License: gpl-3.0
- Created: 2016-04-29T17:40:35.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2023-07-20T19:28:09.000Z (almost 3 years ago)
- Last Synced: 2025-04-06T23:39:42.368Z (about 1 year ago)
- Topics: bin, binary, php-library, serialization, symfony-component
- Language: PHP
- Homepage:
- Size: 119 KB
- Stars: 7
- Watchers: 0
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Binn
====
[](https://travis-ci.comd/et-nik/binn-php)
[](https://scrutinizer-ci.com/g/et-nik/binn-php/?branch=master)
[](https://scrutinizer-ci.com/g/et-nik/binn-php/?branch=master)
PHP Class for serialize to binary string.
Original C Binn Library: https://github.com/liteserver/binn
Binn Specification: https://github.com/liteserver/binn/blob/master/spec.md
## Installation
```bash
composer require knik/binn
```
## Examples
### Binn
Sequential arrays:
```php
use Knik\Binn\Binn;
$binn = new Binn();
// List
$array = [123, -456, 789];
$binnString = $binn->serialize($array);
$unserialized = $binn->unserialize($binnString); // Equal with $array
```
Numeric keys array:
```php
$binn = new Binn();
// Map
$array = [1 => "add", 2 => [-12345, 6789]];
$binnString = $binn->serialize($array);
$unserialized = $binn->unserialize($binnString); // Equal with $array
```
String keys array:
```php
$binn = new Binn();
// Object
$array = ["hello" => "world"];
$binnString = $binn->serialize($array);
$unserialized = $binn->unserialize($binnString); // Equal with $array
```
Mixed arrays:
```php
$binn = new Binn();
$array = [ ["id" => 1, "name" => "John"], ["id" => 2, "name" => "Eric"] ]
// A list of objects
$binnString = $binn->serialize($array);
$unserialized = $binn->unserialize($binnString); // Equal with $array
```
Blob:
```php
$binn = new Binn();
$file = fopen('/path/to/file.jpg', 'rb');
// Filedata in binn structure
$bin1 = $binn->serialize($file);
// Filedata in binn list structure
$bin2 = $binn->serialize(['file' => $file]);
```
### Symfony Serializer
You can use BinnEncoder with Symfony Serializer
```php
use Knik\Binn\Encoder\BinnEncoder;
use Symfony\Component\Serializer\Serializer;
$encoders = [new BinnEncoder()];
$serializer = new Serializer([], $encoders);
$serializer->serialize("\x40\xD0\x06", 'binn');
```
### Original C library style
```php
$binn = new BinnList();
$binn->addUint8(4);
$binn->addInt16(-8875);
$binn->addStr('text');
$serialized = $binn->serialize(); // \xE0\x0F\x03\x20\x04\x41\xDD\x55\xA0\x04text\x00
```
### Nested arrays
```php
$array = [2, true, [123, -456, 789]];
$binn = new BinnList();
// \xE0\x11\x03\x20\x02\x01\xE0\x0B\x03\x20\x7B\x41\xFE\x38\x40\x03\x15
$serialized = $binn->serialize($array);
```