pack

(PHP 4, PHP 5, PHP 7, PHP 8)

pack — Упаковывает данные в двоичную строку

Описание

pack(string $format, mixed ...$values): string

Функция упаковывает заданные аргументы в двоичную строку в соответствии с форматом в параметре format.

Идею функции заимствовали из языка программирования Perl, и коды форматирования работают так же, как они делают это в Perl. Однако части кодов форматирования нет, например, кода формата Perl «u».

Обратите внимание, что различия между знаковыми и беззнаковыми значениями влияют только на функцию unpack(), тогда как функция pack() даёт одинаковый результат для знаковых и беззнаковых кодов формата.

Список параметров

format

Строка format состоит из кодов формата, за которыми идёт необязательный аргумент повторителя. Значение аргумента повторителя указывают как целое число или как символ * для повторения до конца входных данных. Для кодов a, A, h, H число повторений указывает, сколько символов одного аргумента данных возьмёт функция, для кода @ — абсолютную позицию, в которую функция поместит следующие данные. Для остальных кодов форматирования число повторений указывает, сколько аргументов данных функция обработает и упакует в результирующую двоичную строку.

Доступные форматы:

Символы формата функции **pack()**
Код	Описание
a	Строка (string) с NUL-дополнением
A	Строка (string) со SPACE-дополнением
h	Шестнадцатеричная строка (string), вначале младший полубайт
H	Шестнадцатеричная строка (string), вначале старший полубайт
c	Знаковый char
C	Беззнаковый char
s	Знаковый short (всегда 16 битов, машинный порядок байтов)
S	Беззнаковый short (всегда 16 битов, машинный порядок байтов)
n	Беззнаковый short (всегда 16 битов, порядок байтов от старшего к младшему)
v	Беззнаковый short (всегда 16 битов, порядок байтов от младшего к старшему)
i	Знаковый integer (машинно-зависимые размер и порядок байтов)
I	Беззнаковый integer (машинно-зависимые размер и порядок байтов)
l	Знаковый long (всегда 32 бита, машинный порядок байтов)
L	Беззнаковый long (всегда 32 бита, машинный порядок байтов)
N	Беззнаковый long (всегда 32 бита, порядок байтов от старшего к младшему)
V	Беззнаковый long (всегда 32 бита, порядок байтов от младшего к старшему)
q	Знаковый long long (всегда 64 бита, машинный порядок байтов)
Q	Беззнаковый long long (всегда 64 бита, машинный порядок байтов)
J	Беззнаковый long long (всегда 64 бита, порядок байтов от старшего к младшему)
P	Беззнаковый long long (всегда 64 бита, порядок байтов от младшего к старшему)
f	Число с плавающей точкой float (машинно-зависимые размер и представление)
g	Число с плавающей точкой float (машинно-зависимый размер, порядок байтов от младшего к старшему)
G	Число с плавающей точкой float (машинно-зависимый размер, порядок байтов от старшего к младшему)
d	Число double (машинно-зависимые размер и представление)
e	Число double (машинно-зависимый размер, порядок байтов от младшего к старшему)
E	Число double (машинно-зависимый размер, порядок байтов от старшего к младшему)
x	NUL-байт
X	Резервирование одного байта
Z	Строка (string) с NUL-дополнением
@	NUL-заполнение до абсолютной позиции

values

Возвращаемые значения

Функция возвращает двоичную строку, которая содержит данные.

Список изменений

Версия	Описание
8.0.0	Функция больше не возвращает `false`, если возникла ошибка.
7.2.0	Типы float и double поддерживают как прямой, так и обратный порядок байтов.
7.0.15,7.1.1	Добавили коды e, E, g и G для поддержки порядка байтов для типов float и double.

Примеры

Пример #1 Пример использования функции pack()

<?php

$binarydata = pack("nvc*", 0x1234, 0x5678, 65, 66);

?>

Длина результирующей двоичной строки будет составлять 6 байтов, и строка будет содержать последовательность байтов: 0x12, 0x34, 0x78, 0x56, 0x41, 0x42.

Примечания

Предостережение

Обратите внимание, что внутренне PHP хранит значения с типом int как знаковые значения машинно-зависимого размера (тип long в языке программирования C). Целочисленные литералы и операции, которые возвращают числа за пределами типа int, будут храниться как float. При упаковке чисел с плавающей точкой как целых чисел числа с плавающей точкой сначала приводятся к целочисленному типу. Поэтому результат или будет совпадать с заданной структурой байтов, или нет.

Нагляднее остальных это показывает пример с упаковкой беззнаковых чисел, которые можно было бы представить типом int, если бы этот тип был беззнаковым. В системах, в которых размер int составляет 32 бита, приведение обычно даёт ту же структуру байтов, как если бы тип int был беззнаковым (хотя, это зависит от определяемых реализацией преобразований по правилам стандарта языка С беззнаковых чисел в числа со знаком). В системах, в которых размер типа int составляет 64 бита, у типа float, скорее всего, нет мантиссы необходимого размера, чтобы удерживать значение без потери точности. Если в этих системах также есть собственный 64-разрядный тип C int (в большей части UNIX-систем такого типа нет), то единственный способ использовать формат упаковки I в верхнем диапазоне — создать отрицательные значения с типом int с тем же байтовым представлением, что и у беззнакового значения, которое требуется получить.

Смотрите также

unpack() - Распаковывает данные из бинарной строки

＋add a note

User Contributed Notes 10 notes

down

chadm at codeangel dot org ¶

12 years ago

If you'd like to understand pack/unpack. There is a tutorial here in perl, that works equally well in understanding it for php:

http://perldoc.perl.org/perlpacktut.html

down

stanislav dot eckert at vizson dot de ¶

7 years ago

A helper class to convert integer to binary strings and vice versa. Useful for writing and reading integers to / from files or sockets.

<?php

    class int_helper
    {
        public static function int8($i) {
            return is_int($i) ? pack("c", $i) : unpack("c", $i)[1];
        }

        public static function uInt8($i) {
            return is_int($i) ? pack("C", $i) : unpack("C", $i)[1];
        }

        public static function int16($i) {
            return is_int($i) ? pack("s", $i) : unpack("s", $i)[1];
        }

        public static function uInt16($i, $endianness=false) {
            $f = is_int($i) ? "pack" : "unpack";

            if ($endianness === true) {  // big-endian
                $i = $f("n", $i);
            }
            else if ($endianness === false) {  // little-endian
                $i = $f("v", $i);
            }
            else if ($endianness === null) {  // machine byte order
                $i = $f("S", $i);
            }

            return is_array($i) ? $i[1] : $i;
        }

        public static function int32($i) {
            return is_int($i) ? pack("l", $i) : unpack("l", $i)[1];
        }

        public static function uInt32($i, $endianness=false) {
            $f = is_int($i) ? "pack" : "unpack";

            if ($endianness === true) {  // big-endian
                $i = $f("N", $i);
            }
            else if ($endianness === false) {  // little-endian
                $i = $f("V", $i);
            }
            else if ($endianness === null) {  // machine byte order
                $i = $f("L", $i);
            }

            return is_array($i) ? $i[1] : $i;
        }

        public static function int64($i) {
            return is_int($i) ? pack("q", $i) : unpack("q", $i)[1];
        }

        public static function uInt64($i, $endianness=false) {
            $f = is_int($i) ? "pack" : "unpack";

            if ($endianness === true) {  // big-endian
                $i = $f("J", $i);
            }
            else if ($endianness === false) {  // little-endian
                $i = $f("P", $i);
            }
            else if ($endianness === null) {  // machine byte order
                $i = $f("Q", $i);
            }

            return is_array($i) ? $i[1] : $i;
        }
    }
?>

Usage example:
<?php
    Header("Content-Type: text/plain");
    include("int_helper.php");

    echo int_helper::uInt8(0x6b) . PHP_EOL;  // k
    echo int_helper::uInt8(107) . PHP_EOL;  // k
    echo int_helper::uInt8("\x6b") . PHP_EOL . PHP_EOL;  // 107

    echo int_helper::uInt16(4101) . PHP_EOL;  // \x05\x10
    echo int_helper::uInt16("\x05\x10") . PHP_EOL;  // 4101
    echo int_helper::uInt16("\x05\x10", true) . PHP_EOL . PHP_EOL;  // 1296

    echo int_helper::uInt32(2147483647) . PHP_EOL;  // \xff\xff\xff\x7f
    echo int_helper::uInt32("\xff\xff\xff\x7f") . PHP_EOL . PHP_EOL;  // 2147483647

    // Note: Test this with 64-bit build of PHP
    echo int_helper::uInt64(9223372036854775807) . PHP_EOL;  // \xff\xff\xff\xff\xff\xff\xff\x7f
    echo int_helper::uInt64("\xff\xff\xff\xff\xff\xff\xff\x7f") . PHP_EOL . PHP_EOL;  // 9223372036854775807

?>

down

plutus at gmx dot de ¶

23 years ago

Note that the the upper command in perl looks like this:



$binarydata = pack ("n v c*", 0x1234, 0x5678, 65, 66);

In PHP it seems that no whitespaces are allowed in the first parameter. So if you want to convert your pack command from perl -> PHP, don't forget to remove the whitespaces!

down

FrozenFire ¶

13 years ago

If you need to unpack a signed short from big-endian or little-endian specifically, instead of machine-byte-order, you need only unpack it as the unsigned form, and then if the result is >= 2^15, subtract 2^16 from it.



And example would be:



<?php

$foo = unpack("n", $signedbigendianshort);

$foo = $foo[1];

if($foo >= pow(2, 15)) $foo -= pow(2, 16);

?>

down

j.s.hoekstra ¶

18 years ago

/* Convert float from HostOrder to Network Order */
function FToN( $val )
{
    $a = unpack("I",pack( "f",$val ));
    return pack("N",$a[1] );
}
    
/* Convert float from Network Order to HostOrder */
function NToF($val )
{
    $a = unpack("N",$val);
    $b = unpack("f",pack( "I",$a[1]));
    return $b[1];
}

down

Patrik Fimml ¶

18 years ago

You will get the same effect with

<?php
function _readInt($fp)
{
   return unpack('V', fread($fp, 4));
}
?>

or unpack('N', ...) for big-endianness.

down

php at nagler-ihlein dot de ¶

15 years ago

Be aware of format code H always padding the 0 for byte-alignment to the right (for odd count of nibbles).

So pack("H", "7") results in 0x70 (ASCII character 'p') and not in 0x07 (BELL character)
as well as pack("H*", "347") results in 0x34 ('4') and 0x70 ('p') and not 0x03 and 0x47.

down

petepostma at gmail dot spam dot com ¶

11 years ago

Even though in a 64-bit architecure intval(6123456789) = 6123456789, and sprintf('%b', 5000000000) = 100101010000001011111001000000000

pack will not treat anything passed to it as 64-bit.  If you want to pack a 64-bit integer:



<?php

$big = 5000000000;



$left = 0xffffffff00000000;

$right = 0x00000000ffffffff;



$l = ($big & $left) >>32;

$r = $big & $right;



$good = pack('NN', $l, $r);



$urlsafe = str_replace(array('+','/'), array('-','_'), base64_encode($good));



//done!



//rebuild:

$unurl =  str_replace(array('-','_'), array('+','/'), $urlsafe);

$binary = base64_decode($unurl);



$set = unpack('N2', $tmp);

print_r($set);



$original = $set[1] << 32 | $set[2];

echo $original, "\\r\\n";

?>



results in:

Array

(

    [1] => 1

    [2] => 705032704

)

5000000000



but ONLY on a 64-bit enabled machine and PHP distro.

down

Ammar Hameed ¶

13 years ago

Using pack to write Arabic char(s) to a file.

<?php
$text = "&#13574;&#13830;&#13830;";

$text = mb_convert_encoding($text, "UCS-2BE", "HTML-ENTITIES");

$len =  mb_strlen($text);

$bom = mb_convert_encoding("&#65534;", "unicode", "HTML-ENTITIES");

$fp = fopen('text.txt', 'w');

fwrite($fp, pack('a2', $bom));  
fwrite($fp, pack("a{$len}", $text));
fwrite($fp, pack('a2', $bom)); 
fwrite($fp, pack('a2', "\n"));

fclose($fp);
?>

down

ru ¶

6 years ago

pack()
h    Hex string, low nibble first (not same hex2bin())
H    Hex string, high nibble first (same hex2bin())

＋add a note