cyndaron/binary-handler

Read and write binary files easily

v2 2023-12-14 13:24 UTC

Requires

• php: >=8.1

Requires (Dev)

• friendsofphp/php-cs-fixer: *
• phpstan/phpstan: *

MIT

README

Simple project to read and write binary files in PHP.

Background

The project was created out of a desire to have a solution that was a bit simpler than mdurrant’s Binary Reader, and which supported writing binary files. Some of the differences:

• This project only works on whole bytes. You will have to do any bitmasking yourself.
• This project allows writing binary files, in addition to reading them.
• This project allows creating the reader and writer from a filename, in addition to a string or a resource.

Which one is the best fit for your project will depend on your use cases, obviously.

Usage

Both the BinaryReader and BinaryWriter take a resource. Helper functions are provided to create them from an already existing string or from a filename.

Extending

The project is set up with extensibility in mind, as it is very well possible you’ll want to be able to read or write structures specific to your file type. You can quite easily build your own reader/writer using the provided traits and interfaces - even the default BinaryReader and BinaryWriter classes are only built using these.

Future plans

• Adding a test suite.