(PHP 4, PHP 5, PHP 7)
sprintf — Gibt einen formatierten String zurück
Gibt eine anhand des Formatierungs-Strings format
gebildete Zeichenkette zurück.
format
Der Formatstring setzt sich aus keiner oder mehreren Anweisungen
zusammen: Normale Zeichen (abgesehen von %),
die direkt in das Ergebnis kopiert werden und
Konvertierungsanweisungen, die jeweils ihre
eigenen Parameter abrufen.
Eine Konvertierungsanweisung folgt diesem Prototypen:
%[ArgNum$][Flags][Weite][.Präzision]Spezifizierer.
Eine Ganzzahl gefolgt von einem Dollarzeichen $, die die
Nummer des Arguments angibt, das für die Konversion verwendet werden soll.
| Flag | Beschreibung |
|---|---|
- |
Linksbündig innerhalb der angegebenen Feldbreite; Rechtsbündig ist der Standard |
+ |
Positive Zahlen mit einem Pluszeichen
+; Standardmäßig werden
nur negative Zahlen mit negativen Vorzeichen
ausgegeben
|
(Leerzeichen) |
Füllt das Ergebnis mit Leerzeichen auf. Dies ist der Standard. |
0 |
Füllt nach Links mit Nullen auf.
Mit dem s-Spezifizierer
kann dies auch nach rechts mit Nullen auffüllen.
|
'(Zeichen) |
Füllt das Ergebnis mit dem angegebenen Zeichen auf. |
Eine Ganzzahle die angibt, wie viele Zeichen (Minimum) das Konvertierungsergebnis haben soll.
Die Bedeutung eines Punkts . gefolgt
von einer Ganzzahl hängt vom Spezifizierer ab:
e, E,
f und F: Dies stellt die
Anzahl der Nachkommastellen an, die nach dem Dezimaltrennzeichen
ausgegeben werden soll (Standradmäßig ist dies 6).
g und G:
Die maximale Anzahl der auszugebenenden signifikanten
Nachkommastellen.
s Spezifizierer: Verhält sich wie ein
Abschneidepunkt, der eine maximale Anzahl an Zeichen in der
Zeichenkette angibt.
Hinweis: Wenn der Punkt ohne einen expliziten Wert für die Präzision angegeben wird, wird 0 angenommen.
Hinweis: Wird ein Spezifizierer angegeben, der größer ist als
PHP_INT_MAX, so wird eine Warnung ausgegeben.
| Spezifizierer | Beschreibung |
|---|---|
% |
Ein Prozentzeichen. Kein Parameter nötig. |
b |
Der Parameter wird als Ganzzahl behandelt und als Binärzahl ausgegeben. |
c |
Der Parameter wird als Ganzzahl behandelt und als Zeichen aus dem ASCII-Zeichensatz ausgegeben. |
d |
Der Parameter wird als Ganzzahl behandelt und als (vorzeichenbehaftete) Dezimalzahl ausgegeben. |
e |
Der Parameter wird als Zahl in wissenschaftlicher Schreibweise (z.B. 1.2e+2) behandelt. Die Angabe der Präzision steht seit PHP 5.2.1 für die Anzahl Zeichen nach dem Dezimalpunkt. In früheren Versionen wurde dies als die Anzahl signifikanter Dezimalstellen betrachtet (eins weniger). |
E |
Wie der Spezifizierer e, aber schreibt
einen Großbuchstaben (z.B. 1.2E+2).
|
f |
Der Parameter wird als Gleitkommazahl betrachtet und als Gleitkommazahl ausgegeben (abhängig von der Locale). |
F |
Der Parameter wird als Gleitkommazahl betrachtet und als Gleitkommazahl (unabhängig von der Locale) ausgegeben. Verfügbar seit PHP 5.0.3. |
g |
Generelles Format. Sei P die Präzision wenn nicht Null, 6 wenn die Präzision nicht angegeben ist oder 1 wenn die Präzision Null ist. Dann, wenn eine Konvertierung mittels E einen Exponenten von X hätte: Wenn P > X ≥ −4 ist die Konvertierung mit Spezifizierer f und Präzision P - (X + 1). Andernfalls wie mit Spezifizierer e und Präzision P - 1. |
G |
Wie der Spezifizierer g, aber
es wird E und f verwendet.
|
o |
Der Parameter wird als Ganzzahl betrachtet und als Oktalzahl ausgegeben. |
s |
Der Parameter wird als Zeichenkette betrachtet und ausgegeben. |
u |
Der Parameter wird als Ganzzahl betrachtet und als vorzeichenlose Dezimalzahl ausgegeben. |
x |
Der Parameter wird als Ganzzahl betrachtet und als Hexadezimalzahl (mit Kleinbuchstaben) ausgegeben. |
X |
Der Parameter wird als Ganzzahl betrachtet und als Hexadezimalzahl (mit Großbuchstaben) ausgegeben. |
Der Spezifizierer c ignoriert Auffüllung und Weite.
Der Versuch, die Kombination aus Zeichenketten mit Weite-Spezifizierern und Zeichensätzen die mehr als ein Byte pro zeichen erwarten zu verwenden, führt zu unvorhersehbaren Ergebnissen.
Variablen werden auf einen für den Spezifizier passenden Typen umgewandelt:
| Typ | Spezifizierer |
|---|---|
string |
s |
integer |
d,
u,
c,
o,
x,
X,
b
|
double |
g,
G,
e,
E,
f,
F
|
...
Gibt eine an Hand des Formatierungs-Strings format
gebildete Zeichenkette zurück. Im Fehlerfall wird FALSE zurückgegeben.
Beispiel #1 Argumente tauschen
Der Formatstring unterstützt nummerierte Argumente und kann daher auch ihre Position bestimmen (argument numbering/swapping).
<?php
$anzahl = 5;
$ort = 'Baum';
$format = 'Es sind %d Affen auf dem %s';
echo sprintf($format, $anzahl, $ort);
?>
Das oben gezeigte Beispiel erzeugt folgende Ausgabe:
Es sind 5 Affen auf dem Baum
Aber nehmen wir einmal an, dass wir den Formatstring in einer separaten Datei erstellen, da wir ihn internationalisieren wollen und deshalb wie folgt umschreiben:
<?php
$format = 'Der %s enthält %d Affen';
echo sprintf($format, $anzahl, $ort);
?>
Nun haben wir ein Problem. Die Reihenfolge der Platzhalter im Formatstrings entspricht nicht mehr der Reihenfolge der Argumente im Code. Wir würden gern den Code belassen wie er ist und einfach im Formatstring angeben, welche Argumenten welchen Platzhaltern entsprechen. Wir würden dann den Formatstring wie folgt schreiben:
<?php
$format = 'Der %2$s enthält %1$d Affen';
echo sprintf($format, $anzahl, $ort);
?>
Ein weiterer Vorteil ist, dass die Platzhalter wiederholt werden können, ohne mehr Argumente im Code hinzufügen zu müssen.
<?php
$format = 'Der %2$s enthält %1$d Affen.
%1$d Affen sind ziemlich viel für einen %2$s.';
echo sprintf($format, $anzahl, $ort);
?>
Wenn Argumenttausch verwendet wird muss die n$
Positionsangabe
direkt nach dem Prozentzeichen (%) folgen, vor
jeglichen anderen Angaben, wie unten zu sehen ist.
Beispiel #2 Angabe von Füllzeichen
<?php
echo sprintf("%'.9d\n", 123);
echo sprintf("%'.09d\n", 123);
?>
Das oben gezeigte Beispiel erzeugt folgende Ausgabe:
......123 000000123
Beispiel #3 Positionstausch mit weiteren Spezifikatoren
<?php
$format= 'Der %2$s enthält %1$04d Affen';
echo sprintf($format, $anzahl, $ort);
?>
Das oben gezeigte Beispiel erzeugt folgende Ausgabe:
Der Baum enthält 0005 Affen.
Beispiel #4 sprintf(): Mit Nullen aufgefüllte Integer
<?php
$isodate = sprintf("%04d-%02d-%02d", $year, $month, $day);
?>
Beispiel #5 sprintf(): Währungsformatierung
<?php
$money1 = 68.75;
$money2 = 54.35;
$money = $money1 + $money2;
echo $money;
echo "\n";
$formatted = sprintf("%01.2f", $money);
echo $formatted;
?>
Das oben gezeigte Beispiel erzeugt folgende Ausgabe:
123.1 123.10
Beispiel #6 sprintf(): Wissenschaftliche Notation
<?php
$number = 362525200;
echo sprintf("%.3e", $number);
?>
Das oben gezeigte Beispiel erzeugt folgende Ausgabe:
3.625e+8