protonlabs/buffertools

Toolbox for working with binary and hex data. Similar to NodeJS Buffer.

v0.5.8 2023-07-17 08:19 UTC

This package is auto-updated.

Last update: 2024-10-17 11:05:41 UTC


README

This library provides a Buffer and Parser class to make dealing with binary data in PHP easier. Templates extend this by offering a read/write interface for larger serialized structures.

Build Status Code Coverage Scrutinizer Code Quality Latest Stable Version Total Downloads License

Requirements:

  • PHP 7.0+
  • Composer
  • ext-gmp

Installation

You can install this library via Composer: composer require bitwasp/buffertools

Examples

Buffer's are immutable classes to store binary data. Buffer::hex can be used to initialize from hex Buffer::int can be used to initialize from a positive decimal integer (int|string)

Buffer's main methods are:

  • getBinary()
  • getHex()
  • getInt()

Parser will read Buffers. Parser's main methods are:

  • readBytes()
  • writeBytes()
  • readArray()
  • writeArray()

In most cases, the interface offered by Parser should not be used directly. Instead, Templates expose read/write access to larger serialized structures.