ddrv/extra-pack

Extras for pack() and unpack() functions

0.9.6-beta 2018-02-15 18:25 UTC

Requires

• php: >=5.0.0

Requires (Dev)

• phpunit/phpunit: >=4.8

MIT

• Ivan Dudarev

• pack
• Extras
• binary
• unpack
• binary-data
• binary-string

README

ExtraPack

Extras for pack() and unpack() functions.

Install

composer require ddrv/extra-pack

<?php
require ('vendor/autoload.php');

Usage

<?php
$data = array(
    'key1' => 'string',
    'key2' => 5,
    'key3' => .0001
);
$format = 'A6key1/Ckey2/t4key3';
$binary = \Ddrv\Extra\Pack::pack($format, $data);
$result = \Ddrv\Extra\Pack::unpack($format, $binary);
print_r($result);

Array
(
    [key1] => string
    [key2] => 5
    [key3] => .0001
)

Format

character[+number]+key[+:added]

Elements are separated by a slash

Examples:

Format	Key	Result
A6name	name	string with length 6
Coffset:2000	offset	Number from 0 to 255 + 2000

Format characters

Currently implemented formats are:

Character	Is extras	Description	Support from PHP version	Number	Added
@	No	NUL-fill to absolute position	5.0	Position	No using
~	Yes	NUL-ended string	5.0	No using	No using
Z	No	NUL-padded string	5.5.0	Length of string	No using
x	No	NUL byte	5.0	Count iterations	No using
X	No	Back up one byte	5.0	Length of reserved string	No using
a	No	NUL-padded string	5.0	Length of string may be *	No using
A	No	SPACE-padded string	5.0	Length of string may be *	No using
h	No	Hex string, low nibble first	5.0	No using	No using
H	No	Hex string, high nibble first	5.0	No using	No using
c	No	signed char	5.0	No using	Added number
C	No	unsigned char	5.0	No using	Added number
s	No	signed short (always 16 bit, machine byte order)	5.0	No using	Added number
S	No	unsigned short (always 16 bit, machine byte order)	5.0	No using	Added number
n	No	unsigned short (always 16 bit, big endian byte order)	5.0	No using	Added number
v	No	unsigned short (always 16 bit, little endian byte order)	5.0	No using	Added number
m	Yes	signed medium (always 24 bit, machine byte order)	5.0	No using	Added number
M	Yes	unsigned medium (always 24 bit, machine byte order)	5.0	No using	Added number
l	No	signed long (always 32 bit, machine byte order)	5.0	No using	Added number
L	No	unsigned long (always 32 bit, machine byte order)	5.0	No using	Added number
N	No	unsigned long (always 32 bit, big endian byte order)	5.0	No using	Added number
V	No	unsigned long (always 32 bit, little endian byte order)	5.0	No using	Added number
q	No	signed long long (always 64 bit, machine byte order)	5.6.3	No using	Added number
Q	No	unsigned long long (always 64 bit, machine byte order)	5.6.3	No using	Added number
J	No	unsigned long long (always 64 bit, big endian byte order)	5.6.3	No using	Added number
P	No	unsigned long long (always 64 bit, little endian byte order)	5.6.3	No using	Added number
i	No	signed integer (machine dependent size and byte order)	5.0	No using	Added number
I	No	unsigned integer (machine dependent size and byte order)	5.0	No using	Added number
f	No	float (machine dependent size and representation)	5.0	No using	Added number
g	No	float (machine dependent size, little endian byte order)	7.0.15, 7.1.1	No using	Added number
G	No	float (machine dependent size, big endian byte order)	7.0.15, 7.1.1	No using	Added number
d	No	double (machine dependent size and representation)	5.0	No using	Added number
e	No	double (machine dependent size, little endian byte order)	7.0.15, 7.1.1	No using	Added number
E	No	double (machine dependent size, big endian byte order)	7.0.15, 7.1.1	No using	Added number
t	Yes	signed tiny rounded (always 8 bit, machine byte order)	5.0	Number of digits after the decimal point	Added number
T	Yes	unsigned tiny rounded (always 8 bit, machine byte order)	5.0	Number of digits after the decimal point	Added number
o	Yes	signed short rounded (always 16 bit, machine byte order)	5.0	Number of digits after the decimal point	Added number
O	Yes	unsigned short rounded (always 16 bit, machine byte order)	5.0	Number of digits after the decimal point	Added number
r	Yes	signed medium rounded (always 24 bit, machine byte order)	5.0	Number of digits after the decimal point	Added number
R	Yes	unsigned medium rounded (always 24 bit, machine byte order)	5.0	Number of digits after the decimal point	Added number
b	Yes	signed big rounded (always 32 bit, machine byte order)	5.0	Number of digits after the decimal point	Added number
B	Yes	unsigned big rounded (always 32 bit, machine byte order)	5.0	Number of digits after the decimal point	Added number