PhpBinaryReader
, (*1)
Why?
You probably wouldn't be here if you hadn't run into a scenario where you needed to leverage PHP to read a stream of
binary data. The honest truth is PHP really stinks at this stuff, but as long as we're going to be using it we may as
well do our best to make it as painless as possible., (*2)
The purpose of this binary reader is to accept a string of file contents or file resource and provide a set of methods
inspired by .NET to traverse it., (*3)
Note on Endians
The reader is designed to work on little endian machines, which is going to apply to most scenarios as all x86 and x86-64
machines are little endian. If you have somehow found yourself on a big endian machine, you need to inform the class or
you may not be able to properly read signed integers in the file you're parsing., (*4)
$fileData = file_get_contents('somefile.bin');
$br = new BinaryReader($fileData);
$br->setMachineByteOrder(Endian::ENDIAN_BIG);
...
Example Usage
$fileData = file_get_contents('somefile.bin');
$br = new BinaryReader($fileData, Endian::ENDIAN_LITTLE);
// or
$fileResource = fopen('somefile.bin', 'rb');
$br = new BinaryReader($fileResource, Endian::ENDIAN_LITTLE);
$magic = $br->readUInt32();
$offset = $br->readUInt16();
$length = $br->readUInt16();
...
Methods
__construct($input, $endian) a string or file resource must be provided to use this class, an endian is optional (string [big|little], or use the constants in the Endian class), it will default to little if not provided., (*5)
readUInt8() returns a single 8 bit byte as an unsigned integer, (*6)
readInt8() returns a single 8 bit byte as a signed integer, (*7)
readUInt16() returns a 16-bit short as an unsigned integer, (*8)
readInt16() returns a 16-bit short as a signed integer, (*9)
readUInt32() returns a 32-bit unsigned integer, (*10)
readInt32() returns a 32-bit signed integer, (*11)
readUInt64() returns a 64-bit unsigned integer, (*12)
readInt64() returns a 64-bit signed integer, (*13)
readSingle() returns a 4-bytes floating-point, (*14)
readUBits($length) returns a variable length of bits (unsigned), (*15)
readBits($length) returns a variable length of bits (signed), (*16)
readBytes($length) returns a variable length of bytes, (*17)
readString($length) returns a variable length string, (*18)
readAlignedString($length) aligns the pointer to 0 bits and returns a variable length string, (*19)
align() aligns the pointer back to 0 bits, (*20)
isEof() returns true if the pointer is on the last byte of the file, (*21)
getPosition() returns the current byte position in the file, (*22)
setPosition($position) sets the current byte position, (*23)
getCurrentBit() returns the current bit position in the file, (*24)
setCurrentBit($currentBit) sets the current bit position, (*25)
Contributing
Contributions must follow the PSR2 coding standards and must not degrade 100% coverage., (*26)
Acknowledgements
Significant portions of the work is based on Graylin Kim's Python bit/byte reader in sc2reader_, (*27)
.. _sc2reader: https://github.com/GraylinKim/sc2reader, (*28)
Wallogit.com
