(PHP 4, PHP 5, PHP 7)
pack — Packt Daten in eine Binär-Zeichenkette
Packt die angegebenen Argumente unter Beachtung von
format in eine Binär-Zeichenkette.
Die Idee für diese Funktion entstammt Perl. Alle Formatierungs-Anweisungen funktionieren genau wie dort, allerdings fehlen in PHP einige Format-Codes von Perl (z.B. "u").
Beachten sie, dass der Unterschied zwischen vorzeichenlosen und vorzeichenbehafteten Werten nur Einfluss auf die Funktion unpack() hat, wogegen die Funktion pack() bei vorzeichenlosen und vorzeichenbehafteten Format-Codes dasselbe Ergebnis liefert.
format
Die Zeichenkette format besteht aus
Format-Codes, gefolgt von einem optionalen Wiederholungs-Argument.
Dieses Argument kann ein ganzzahliger Wert sein oder ein
* für Wiederholung bis ans Ende der Daten. Bei den
Format-Codes a, A, h und H gibt das Wiederholungs-Argument an, wie
viele gleiche Zeichen folgen. Im Zusammenhang mit "@" gibt das
Wiederholungs-Argument die absolute Position an, ab der das nächste
Zeichen steht. Bei allen anderen steht der Wiederholungs-Zähler für die
Anzahl der benutzten Daten-Argumente, die in die sich ergebende
Binär-Zeichenkette gepackt werden sollen.
Zurzeit sind folgende Formate implementiert:
| Code | Beschreibung |
|---|---|
| a | mit NUL gefüllte Zeichenkette |
| A | mit Leerzeichen gefüllte Zeichenkette |
| h | Hex-Zeichenkette, unterer Halbwert zuerst |
| H | Hex-Zeichenkette, oberer Halbwert zuerst |
| c | vorzeichenbehaftetes Zeichen |
| C | vorzeichenloses Zeichen |
| s | vorzeichenbehafteter Short-Typ (immer 16 Bit, Byte-Folge maschinenabhängig) |
| S | vorzeichenloser Short-Typ (immer 16 Bit, Byte-Folge maschinenabhängig) |
| n | vorzeichenloser Short-Typ (immer 16 Bit, Byte-Folge Big Endian) |
| v | vorzeichenloser Short-Typ (immer 16 Bit, Byte-Folge Little Endian) |
| i | vorzeichenbehaftete Ganzzahl (Größe und Byte-Folge maschinenabhängig) |
| I | vorzeichenlose Ganzzahl (Größe und Byte-Folge maschinenabhängig) |
| l | vorzeichenbehafteter Long-Typ (immer 32 Bit, Byte-Folge maschinenabhängig) |
| L | vorzeichenloser Long-Typ (immer 32 Bit, Byte-Folge maschinenabhängig) |
| N | vorzeichenloser Long-Typ (immer 32 Bit, Byte-Folge Big Endian) |
| V | vorzeichenloser Long-Typ (immer 32 Bit, Byte-Folge Little Endian) |
| q | vorzeichenbehafteter Long-Long-Typ (immer 64 bit, maschinenabhängig) |
| Q | vorzeichenloser Long-Long-Typ (immer 64 bit, maschinenabhängig) |
| J | vorzeichenloser Long-Long-Typ (immer 64 bit, Byte-Folge Big Endian) |
| P | vorzeichenloser Long-Long-Typ (immer 64 bit, Byte-Folge Little Endian) |
| f | Gleitkommazahl (maschinenabhängige Größe und Wiedergabe) |
| g | Gleitkommazahl (maschinenabhängige Größe, Byte-Folge Little Endian) |
| G | Gleitkommazahl (maschinenabhängige Größe, Byte-Folge Big Endian) |
| d | Double-Typ (maschinenabhängige Größe und Wiedergabe) |
| e | Double-Typ (maschinenabhängige Größe, Byte-Folge Little Endian) |
| E | Double-Typ (maschinenabhängige Größe, Byte-Folge Big Endian) |
| x | NUL Byte |
| X | geht in der Zeichenkette ein Byte rückwärts |
| Z | NUL-aufgefüllte Zeichenkette (neu in PHP 5.5) |
| @ | NUL-Auffüllung bis zur absoluten Position |
...
Gibt die Daten als Binär-Zeichenkette zurück.
| Version | Beschreibung |
|---|---|
| 7.2.0 | float und double Typen unterstützen sowohl Big Endian als auch Little Endian. |
| 7.0.15, 7.1.1 | Die "e", "E", "g" and "G" Codes wurden hinzugefügt, um Byte-Folgen-Unterstützung für float und double zu ermöglichen. |
| 5.6.3 | Die "q", "Q", "J" und "P" Codes wurden hinzugefügt, um die Arbeit mit 64-bit Zahlen zu ermöglichen. |
| 5.5.0 | Der "Z" Code mit equivalenter Funktionsweise wie "a" wurde zwecks Perl-Kompatibilität hinzugefügt. |
Beispiel #1 pack()-Beispiel
<?php
$binaerdaten = pack("nvc*", 0x1234, 0x5678, 65, 66);
?>
Die sich daraus ergebende Binär-Zeichenkette ist sechs Bytes lang und enthält die Byte-Folge 0x12, 0x34, 0x78, 0x56, 0x41, 0x42.
Es ist zu beachten, dass PHP integer Werte intern als vorzeichenbehaftete Werte einer maschinenabhängigen Größe speichert (C-Typ long). Integer-Literale und Operationen die Zahlen außerhalb der Grenzen des integer-Typs ergeben, werden als float gespeichert. Wenn diese Floats als Integer gepackt werden, werden sie zuerst in den Integer-Typ gewandelt. Dies kann u.U. ein nicht erwünschtes Byte-Muster ergeben.
Der wichtigste Fall ist das Packen vorzeichenloser Zahlen, die als integer-Typ darstellbar wären, wenn dieser vorzeichenlos wäre. Auf Systemen wo der integer-Typ 32 bit groß ist, resultiert die Umwandlung üblicherweise im selben Byte-Muster wie wenn der integer vorzeichenlos wäre (allerdings ist das auf implementierungsspezifische Konvertierungen von vorzeichenlosen in vorzeichenbehaftete Zahlen gemäß dem C-Standard angewiesen). Auf Systemen wo der integer-Typ 64 bit groß ist, hat float vermutlich keine Mantisse, die groß genug ist, um den Wert ohne Genauigkeitsverlust zu speichern. Haben diese Systeme ebenfalls einen nativen 64-bit C int-Typ (die meisten UNIX-artigen Systeme haben das nicht), dann ist die einzige Möglichkeit das I-Packformat auf den oberen Bereich zu nutzen, negative integer Werte mit der gleichen Byte-Darstellung wie die gewünschten vorzeichenlosen Werte zu erzeugen.