pack
Pack given arguments into a binary string according to format .
The idea for this function was taken from Perl and all formatting codes work the same as in Perl. However, there are some formatting codes that are missing such as Perl’s «u» format code.
Note that the distinction between signed and unsigned values only affects the function unpack(), where as function pack() gives the same result for signed and unsigned format codes.
Parameters
The format string consists of format codes followed by an optional repeater argument. The repeater argument can be either an integer value or * for repeating to the end of the input data. For a, A, h, H the repeat count specifies how many characters of one data argument are taken, for @ it is the absolute position where to put the next data, for everything else the repeat count specifies how many data arguments are consumed and packed into the resulting binary string.
Currently implemented formats are:
| Code | Description |
|---|---|
| a | NUL-padded string |
| A | SPACE-padded string |
| h | Hex string, low nibble first |
| H | Hex string, high nibble first |
| c | signed char |
| C | unsigned char |
| s | signed short (always 16 bit, machine byte order) |
| S | unsigned short (always 16 bit, machine byte order) |
| n | unsigned short (always 16 bit, big endian byte order) |
| v | unsigned short (always 16 bit, little endian byte order) |
| i | signed integer (machine dependent size and byte order) |
| I | unsigned integer (machine dependent size and byte order) |
| l | signed long (always 32 bit, machine byte order) |
| L | unsigned long (always 32 bit, machine byte order) |
| N | unsigned long (always 32 bit, big endian byte order) |
| V | unsigned long (always 32 bit, little endian byte order) |
| q | signed long long (always 64 bit, machine byte order) |
| Q | unsigned long long (always 64 bit, machine byte order) |
| J | unsigned long long (always 64 bit, big endian byte order) |
| P | unsigned long long (always 64 bit, little endian byte order) |
| f | float (machine dependent size and representation) |
| g | float (machine dependent size, little endian byte order) |
| G | float (machine dependent size, big endian byte order) |
| d | double (machine dependent size and representation) |
| e | double (machine dependent size, little endian byte order) |
| E | double (machine dependent size, big endian byte order) |
| x | NUL byte |
| X | Back up one byte |
| Z | NUL-padded string |
| @ | NUL-fill to absolute position |
Return Values
Returns a binary string containing data, or false on failure.
Changelog
| Version | Description |
|---|---|
| 8.0.0 | This function no longer returns false on failure. |
| 7.2.0 | float and double types supports both Big Endian and Little Endian. |
| 7.0.15,7.1.1 | The «e», «E», «g» and «G» codes were added to enable byte order support for float and double. |
Examples
Example #1 pack() example
$binarydata = pack("nvc*", 0x1234, 0x5678, 65, 66); ?> The resulting binary string will be 6 bytes long and contain the byte sequence 0x12, 0x34, 0x78, 0x56, 0x41, 0x42.
Notes
Note that PHP internally stores int values as signed values of a machine-dependent size (C type long ). Integer literals and operations that yield numbers outside the bounds of the int type will be stored as float. When packing these floats as integers, they are first cast into the integer type. This may or may not result in the desired byte pattern.
The most relevant case is when packing unsigned numbers that would be representable with the int type if it were unsigned. In systems where the int type has a 32-bit size, the cast usually results in the same byte pattern as if the int were unsigned (although this relies on implementation-defined unsigned to signed conversions, as per the C standard). In systems where the int type has 64-bit size, the float most likely does not have a mantissa large enough to hold the value without loss of precision. If those systems also have a native 64-bit C int type (most UNIX-like systems don’t), the only way to use the I pack format in the upper range is to create int negative values with the same byte representation as the desired unsigned value.
See Also
PHP 8.2
(PHP 4 4.3.0, 5, 7, 8) output_add_rewrite_var URL rewriter values This function adds another name/value pair to URL rewrite mechanism.
(PHP 4 4.3.0, 5, 7, 8) output_reset_rewrite_vars URL rewriter values This function resets the URL rewriter and removes all variables previously by output_add_rewrite_var()
(PHP 4, 5, 7, 8) parse_ini_file configuration parse_ini_file() loads the specified filename, and returns settings it associative array.
(PHP 5 5.3.0, 7, 8) parse_ini_string configuration parse_ini_string() returns the settings an associative array.
pack
Упаковывает заданные аргументы в бинарную строку в соответствии с форматом в параметре format .
Идея этой функции была заимствована из Perl и все коды форматирования работают так же. Однако, есть некоторые отсутствующие коды форматирования, такие как код формата Perl «u».
Необходимо иметь в виду, что отличие между знаковыми и беззнаковыми значениями влияет только на функцию unpack() , тогда как функция pack() даёт одинаковый результат для знаковых и беззнаковых кодов формата.
Список параметров
Параметр format задаётся в виде строки и состоит из кодов формата и опционального аргумента повторения. Аргумент может быть целочисленным, либо * для повторения до конца введённых данных. Для a, A, h, H число повторений определяет то, сколько символов взято от одного аргумента данных, для @ — это абсолютная позиция для размещения следующих данных, для всего остального число повторений определяет как много аргументов данных было обработано и упаковано в результирующую бинарную строку.
Работающие на данный момент форматы:
| Код | Описание |
|---|---|
| a | Строка (string) с NUL-заполнением |
| A | Строка (string) со SPACE-заполнением |
| h | Hex-строка (Hex string), с нижнего разряда |
| H | Hex-строка (Hex string), с верхнего разряда |
| c | знаковый символ (char) |
| C | беззнаковый символ (char) |
| s | знаковый short (всегда 16 бит, машинный байтовый порядок) |
| S | беззнаковый short (всегда 16 бит, машинный байтовый порядок) |
| n | беззнаковый short (всегда 16 бит, порядок big endian) |
| v | беззнаковый short (всегда 16 бит, порядок little endian) |
| i | знаковый integer (машинно-зависимый размер и порядок) |
| I | беззнаковый integer (машинно-зависимый размер и порядок) |
| l | знаковый long (всегда 32 бит, машинный порядок) |
| L | беззнаковый long (всегда 32 бит, машинный порядок) |
| N | беззнаковый long (всегда 32 бит, порядок big endian) |
| V | беззнаковый long (всегда 32 бит, порядок little endian) |
| q | signed long long (всегда 64 bit, машинный порядок) |
| Q | беззнаковый long long (всегда 64 bit, машинный порядок) |
| J | беззнаковый long long (всегда 64 bit, порядок big endian) |
| P | беззнаковый long long (всегда 64 bit, порядок little endian) |
| f | float (машинно-зависимые размер и представление) |
| g | float (машинно-зависимые размер, порядок байт little endian) |
| G | float (машинно-зависимые размер, порядок байт big endian) |
| d | double (машинно-зависимые размер и представление) |
| e | double (машинно-зависимые размер, порядок байт little endian) |
| E | double (машинно-зависимые размер, порядок байт big endian) |
| x | байт NUL |
| X | Резервирование одного байта |
| Z | Строка (string) с NUL-заполнением |
| @ | NUL-заполнение до абсолютной позиции |
Возвращаемые значения
Возвращает бинарную строку, содержащую данные.
Список изменений
| Версия | Описание |
|---|---|
| 8.0.0 | Функция больше не возвращает false в случае возникновения ошибки. |
| 7.2.0 | Типы float и double поддерживают как обратный, так и прямой порядок передачи байтов. |
| 7.0.15,7.1.1 | Добавлены коды «e», «E», «g» и «G» для поддержки принудительного указания порядка байт для float и double. |
Примеры
Пример #1 Пример использования pack()
Полученная бинарная строка длиной 6 байт будет содержать последовательность байтов 0x12, 0x34, 0x78, 0x56, 0x41, 0x42.
Примечания
Необходимо отметить, что PHP сохраняет значения типа int как знаковые с машинно-зависимым размером (C тип long ). Все числа, переданные как int , но выходящие за границы этого типа будут сохранены с типом float . При упаковке этих float как int , они будут переданы с типом int . Это может как совпадать, так и нет с заданным шаблоном.
Наиболее частым является случай, когда упаковываются беззнаковые числа типа int . В системах, где int имеет размер в 32 бита, число обычно передаётся по тому же шаблону, как если бы int был беззнаковым (хотя, это зависит от определённых преобразований из знаковое в беззнаковое, согласно стандарту С). В системах, где тип int имеет размер в 64 бита, тип float не имеет мантиссы, достаточной по размеру для хранения значения без потери точности. Если эти системы также имеют простой 64-битный С тип int (большинство UNIX систем не имеют), то единственным путём для использования формата I в верхнем разряде является создание отрицательных int значений с тем же представлением как и в определённом беззнаковом значении.
Смотрите также
pack
Pack given arguments into a binary string according to format .
The idea for this function was taken from Perl and all formatting codes work the same as in Perl. However, there are some formatting codes that are missing such as Perl’s «u» format code.
Note that the distinction between signed and unsigned values only affects the function unpack() , where as function pack() gives the same result for signed and unsigned format codes.
Parameters
The format string consists of format codes followed by an optional repeater argument. The repeater argument can be either an integer value or * for repeating to the end of the input data. For a, A, h, H the repeat count specifies how many characters of one data argument are taken, for @ it is the absolute position where to put the next data, for everything else the repeat count specifies how many data arguments are consumed and packed into the resulting binary string.
Currently implemented formats are:
| Code | Description |
|---|---|
| a | NUL-padded string |
| A | SPACE-padded string |
| h | Hex string, low nibble first |
| H | Hex string, high nibble first |
| c | signed char |
| C | unsigned char |
| s | signed short (always 16 bit, machine byte order) |
| S | unsigned short (always 16 bit, machine byte order) |
| n | unsigned short (always 16 bit, big endian byte order) |
| v | unsigned short (always 16 bit, little endian byte order) |
| i | signed integer (machine dependent size and byte order) |
| I | unsigned integer (machine dependent size and byte order) |
| l | signed long (always 32 bit, machine byte order) |
| L | unsigned long (always 32 bit, machine byte order) |
| N | unsigned long (always 32 bit, big endian byte order) |
| V | unsigned long (always 32 bit, little endian byte order) |
| q | signed long long (always 64 bit, machine byte order) |
| Q | unsigned long long (always 64 bit, machine byte order) |
| J | unsigned long long (always 64 bit, big endian byte order) |
| P | unsigned long long (always 64 bit, little endian byte order) |
| f | float (machine dependent size and representation) |
| g | float (machine dependent size, little endian byte order) |
| G | float (machine dependent size, big endian byte order) |
| d | double (machine dependent size and representation) |
| e | double (machine dependent size, little endian byte order) |
| E | double (machine dependent size, big endian byte order) |
| x | NUL byte |
| X | Back up one byte |
| Z | NUL-padded string |
| @ | NUL-fill to absolute position |
values
Return Values
Returns a binary string containing data.
Changelog
| Version | Description |
|---|---|
| 8.0.0 | This function no longer returns false on failure. |
| 7.2.0 | float and double types supports both Big Endian and Little Endian. |
| 7.0.15,7.1.1 | The «e», «E», «g» and «G» codes were added to enable byte order support for float and double. |
Examples
Example #1 pack() example
The resulting binary string will be 6 bytes long and contain the byte sequence 0x12, 0x34, 0x78, 0x56, 0x41, 0x42.
Notes
Note that PHP internally stores int values as signed values of a machine-dependent size (C type long ). Integer literals and operations that yield numbers outside the bounds of the int type will be stored as float . When packing these floats as integers, they are first cast into the integer type. This may or may not result in the desired byte pattern.
The most relevant case is when packing unsigned numbers that would be representable with the int type if it were unsigned. In systems where the int type has a 32-bit size, the cast usually results in the same byte pattern as if the int were unsigned (although this relies on implementation-defined unsigned to signed conversions, as per the C standard). In systems where the int type has 64-bit size, the float most likely does not have a mantissa large enough to hold the value without loss of precision. If those systems also have a native 64-bit C int type (most UNIX-like systems don’t), the only way to use the I pack format in the upper range is to create int negative values with the same byte representation as the desired unsigned value.