(PHP 4, PHP 5, PHP 7)
pack — Compacte des données dans une chaîne binaire
Compacte les arguments args
dans une chaîne binaire, suivant le format format.
Le concept vient du Perl et tout le formatage fonctionne de la même façon qu'en Perl, mais quelques formats manquent encore (comme "u").
Notez que la distinction entre signé et non signé n'affecte que la fonction unpack(), tandis que la fonction pack() fournira le même résultat pour les deux formats.
format
La chaîne de caractères format consiste en des codes
de format suivis par un argument répéteur optionnel. Le répéteur
peut être soit une valeur entière, soit * pour
une répétition jusqu'à la fin des données d'entrées. Pour a, A, h, H,
le répéteur spécifie combien de caractères d'une donnée est pris, pour
@, c'est la position absolue où l'on insère les prochaines données, pour
tout le reste, le répéteur spécifie combien d'arguments de données sont
consommés et compactés dans la chaîne binaire résultante.
Les formats actuellement acceptés sont :
| Code | Description |
|---|---|
| a | NUL - Une chaîne complétée avec NULL |
| A | SPACE - Une chaîne complétée avec un espace |
| h | Chaîne hexadécimale h, bit de poids faible en premier |
| H | Chaîne hexadécimale H, bit de poids fort en premier |
| c | Caractère signé |
| C | Caractère non signé |
| s | entier court signé (toujours sur 16 bits, ordre des octets dépendant de la machine) |
| S | entier court non signé (toujours 16 bits, ordre des octets dépendant de la machine) |
| n | entier court non signé (toujours 16 bits, ordre des octets big endian) |
| v | entier court non signé (toujours 16 bits, ordre des octets little endian) |
| i | entier signé (taille et ordre des octets dépendants de la machine) |
| I | entier non signé (taille et ordre des octets dépendants de la machine) |
| l | entier long signé (toujours 32 bits, ordre des octets dépendant de la machine) |
| L | entier long non signé (toujours 32 bits, ordre des octets dépendant de la machine) |
| N | entier long non signé (toujours 32 bits, ordre des octets big endian) |
| V | entier long non signé (toujours 32 bits, ordre des octets little endian) |
| q | entier doublement long signé (toujours 64 bits, ordre des octets dépendant de la machine) |
| Q | entier doublement long non signé (toujours 64 bits, ordre des octets dépendant de la machine) |
| J | entier doublement long non signé (toujours 64 bits, ordre des octets big endian) |
| P | entier doublement long non signé (toujours 64 bits, ordre des octets little endian) |
| f | nombre à virgule flottante (taille et représentation dépendantes de la machine) |
| d | nombre à virgule flottante double (taille et représentation dépendantes de la machine) |
| x | caractère NUL |
| X | Recule d'un caractère |
| Z | Chaîne complétée par la valeur NULL (nouveau en PHP 5.5) |
| @ | Remplit avec des NUL jusqu'à la position absolue |
args
Retourne une chaîne de caractères binaire contenant les données.
| Version | Description |
|---|---|
| 5.6.3 | Les codes "q", "Q", "J" et "P" codes ont été ajoutés pour travailler avec les nombres 64 bits. |
| 5.5.0 | Le code "Z" a été ajouté et dont le comportement est identique à "a" en Perl. |
Exemple #1 Exemple avec pack()
<?php
$binarydata = pack("nvc*", 0x1234, 0x5678, 65, 66);
?>
La chaîne binaire résultante aura 6 octets de long, et contiendra la séquence 0x12, 0x34, 0x78, 0x56, 0x41, 0x42.
Notez que PHP stocke en interne les valeurs integer comme valeurs signées dépendantes de la machine (type C long). Les opérations sur les entiers qui mènent à des chiffres en dehors de l'espace de définition de l'integer seront stockées dans des float. Lors de l'empaquetage de ses flottants en entiers, ils sont transtypés vers le type entier. Ceci peut éventuellement mener à une représentation inattendue des octets.
Le cas le plus classique est l'empaquetage de nombres non signés qui seraient représentables dans le type integer si celui-ci était non signé. Sur les systèmes ayant un integer d'une taille de 32-bits, le transtypage résulte en un octet identique que si le type integer était non signé (même si cela reste dépendant de l'implémentation non signé vers signé, du standard C). Sur les systèmes ayant un integer d'une taille de 64-bits, le float n'a souvent pas une mantisse assez large pour contenir la valeur sans perte de précision. Si ces systèmes possèdent aussi un type C natif int 64-bits (la plupart des *NIX ne l'ont pas), le seul moyen d'utiliser le format de paquetage I dans les hautes valeurs est de créer des valeurs integer négatives avec la même représentation des octets que la valeur non signées voulue correspondante.