https://github.com/petrknap/php-binary
Library for work with binary data and objects
https://github.com/petrknap/php-binary
base64 binary checksum compression decoder decompression encoder helper hexadecimal igbinary php php-library serializer zlib
Last synced: 7 months ago
JSON representation
Library for work with binary data and objects
- Host: GitHub
- URL: https://github.com/petrknap/php-binary
- Owner: petrknap
- License: lgpl-3.0
- Created: 2024-03-30T21:54:31.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-06T19:29:07.000Z (about 1 year ago)
- Last Synced: 2024-11-06T20:29:47.575Z (about 1 year ago)
- Topics: base64, binary, checksum, compression, decoder, decompression, encoder, helper, hexadecimal, igbinary, php, php-library, serializer, zlib
- Language: PHP
- Homepage:
- Size: 73.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: COPYING
- Authors: AUTHORS
Awesome Lists containing this project
README
# Library for work with binary data and objects
Simple library for work with binary data and objects in PHP.
See the examples below for more information, or check out [`Encoder`](./src/Encoder.php), [`Decoder`](./src/Decoder.php), [`Serializer`](./src/Serializer.php), [`Byter`](./src/Byter.php) and [`Ascii`](./src/Ascii.php).
## Coder
```php
namespace PetrKnap\Binary;
$data = base64_decode('hmlpFnFwbchsoQARSibVpfbWVfuwAHLbGxjFl9eC8fiGaWkWcXBtyGyhABFKJtWl9tZV+7AActsbGMWX14Lx+A==');
$encoded = Binary::encode($data)->checksum()->zlib()->base64(urlSafe: true)->data;
$decoded = Binary::decode($encoded)->base64()->zlib()->checksum()->data;
printf('Data was coded into `%s` %s.', $encoded, $decoded === $data ? 'successfully' : 'unsuccessfully');
```
## Serializer
```php
namespace PetrKnap\Binary;
$data = [
'type' => 'image/png',
'data' => base64_decode('iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAAAXNSR0IArs4c6QAAAA1JREFUGFdj+L+U4T8ABu8CpCYJ1DQAAAAASUVORK5CYII='),
];
$serialized = Binary::serialize($data);
$unserialized = Binary::unserialize($serialized);
printf('Data was serialized into `%s` %s.', base64_encode($serialized), $unserialized === $data ? 'successfully' : 'unsuccessfully');
```
## Self-serializer
```php
namespace PetrKnap\Binary;
class DataObject implements Serializer\SelfSerializerInterface
{
use Serializer\SelfSerializerTrait;
public function __construct(
public string $data,
) {
$this->referencesToConstructorArgs = [
&$this->data,
];
}
}
$instance = new DataObject('Lorem ipsum dolor sit amet, consectetur adipiscing elit.');
$instance->data .= ' Duis venenatis ultricies elementum.';
$binary = $instance->toBinary();
$binaryFromHelper = Binary::asBinary($instance);
printf(
'Data object was serialized into `%s` %s.',
base64_encode($binary),
$binary === $binaryFromHelper && $instance == DataObject::fromBinary($binary) ? 'successfully' : 'unsuccessfully',
);
```
## Byter
```php
namespace PetrKnap\Binary;
$data = base64_decode('hmlpFnFwbchsoQARSibVpfbWVfuwAHLbGxjFl9eC8fiGaWkWcXBtyGyhABFKJtWl9tZV+7AActsbGMWX14Lx+A==');
$sha1 = sha1($data, binary: true);
$md5 = md5($data, binary: true);
$unbitten = Binary::unbite($sha1, $md5, $data);
[$sha1Bite, $md5Bite, $dataBite] = Binary::bite($unbitten, 20, 16);
printf(
'Hashes and data was unbitten into `%s` %s.',
base64_encode($unbitten),
$sha1Bite === $sha1 && $md5Bite === $md5 && $dataBite === $data ? 'successfully' : 'unsuccessfully',
);
```
## ASCII
```php
namespace PetrKnap\Binary;
printf(Ascii::RecordSeparator->join(
Ascii::UnitSeparator->join('200', 'EUR', 'Maya Wilson'),
Ascii::UnitSeparator->join('1600', 'USD', 'Quinton Rice'),
));
```
---
Run `composer require petrknap/binary` to install it.
You can [support this project via donation](https://petrknap.github.io/donate.html).
The project is licensed under [the terms of the `LGPL-3.0-or-later`](./COPYING.LESSER).