(PHP 4, PHP 5, PHP 7, PHP 8)
pack — Упаковывает данные в двоичную строку
Функция упаковывает заданные аргументы в двоичную строку в соответствии с форматом в параметре format.
Идею функции заимствовали из языка программирования Perl, и коды форматирования работают так же, как они делают это в Perl. Однако части кодов форматирования нет, например, кода формата Perl «u».
Обратите внимание, что различия между знаковыми и беззнаковыми значениями влияют только на функцию unpack(), тогда как функция pack() даёт одинаковый результат для знаковых и беззнаковых кодов формата.
format Строка format состоит из кодов формата, за которыми идёт необязательный аргумент повторителя. Значение аргумента повторителя указывают как целое число или как символ * для повторения до конца входных данных. Для кодов a, A, h, H число повторений указывает, сколько символов одного аргумента данных возьмёт функция, для кода @ — абсолютную позицию, в которую функция поместит следующие данные. Для остальных кодов форматирования число повторений указывает, сколько аргументов данных функция обработает и упакует в результирующую двоичную строку.
Доступные форматы:
| Код | Описание |
|---|---|
| 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 с тем же байтовым представлением, что и у беззнакового значения, которое требуется получить.