sprintf
(PHP 4, PHP 5, PHP 7, PHP 8)
sprintf — Gibt einen formatierten String zurück
Beschreibung
Gibt eine anhand des Formatierungs-Strings format
gebildete Zeichenkette zurück.
Parameter-Liste
-
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.ArgNum
Eine Ganzzahl gefolgt von einem Dollarzeichen
$, die die Nummer des Arguments angibt, das für die Konversion verwendet werden soll.Flags 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 ausgegebenFüllt das Ergebnis mit Leerzeichen auf. Dies ist der Standard. 0Fü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. Weite
Eine Ganzzahle die angibt, wie viele Zeichen (Minimum) das Konvertierungsergebnis haben soll.
Präzision
Die Bedeutung eines Punkts
.gefolgt von einer Ganzzahl hängt vom Spezifizierer ab:-
Für die Spezifizierer
e,E,fundF: Dies stellt die Anzahl der Nachkommastellen an, die nach dem Dezimaltrennzeichen ausgegeben werden soll (Standardmäßig ist dies 6). -
Für die Spezifizierer
g,G,hundH: Die maximale Anzahl der auszugebenenden signifikanten Nachkommastellen. -
Für den
sSpezifizierer: 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 Spezifizierer Beschreibung %Ein Prozentzeichen. Kein Parameter nötig. bDer Parameter wird als Ganzzahl behandelt und als Binärzahl ausgegeben. cDer Parameter wird als Ganzzahl behandelt und als Zeichen aus dem ASCII-Zeichensatz ausgegeben. dDer Parameter wird als Ganzzahl behandelt und als (vorzeichenbehaftete) Dezimalzahl ausgegeben. eDer Parameter wird als Zahl in wissenschaftlicher Schreibweise (z.B. 1.2e+2) behandelt. EWie der Spezifizierer e, aber schreibt einen Großbuchstaben (z.B. 1.2E+2).fDer Parameter wird als Gleitkommazahl betrachtet und als Gleitkommazahl ausgegeben (abhängig von der Locale). FDer Parameter wird als Gleitkommazahl betrachtet und als Gleitkommazahl (unabhängig von der Locale) ausgegeben. gGenerelles 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.
GWie der Spezifizierer g, aber es wirdEundfverwendet.hWie der Spezifizierer g, aber es werdenFverwendet. Verfügbar ab PHP 8.0.0.HWie der Spezifizierer g, aber es werdenEundFverwendet. Verfügbar ab PHP 8.0.0.oDer Parameter wird als Ganzzahl betrachtet und als Oktalzahl ausgegeben. sDer Parameter wird als Zeichenkette betrachtet und ausgegeben. uDer Parameter wird als Ganzzahl betrachtet und als vorzeichenlose Dezimalzahl ausgegeben. xDer Parameter wird als Ganzzahl betrachtet und als Hexadezimalzahl (mit Kleinbuchstaben) ausgegeben. XDer Parameter wird als Ganzzahl betrachtet und als Hexadezimalzahl (mit Großbuchstaben) ausgegeben. WarnungDer Spezifizierer
cignoriert Auffüllung und Weite.WarnungDer 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-Behandlung Typ Spezifizierer string sint d,u,c,o,x,X,bfloat e,E,f,F,g,G,h,H -
Für die Spezifizierer
-
values -
Rückgabewerte
Gibt eine anhand des Formatierungs-Strings format
gebildete Zeichenkette zurück.
Changelog
| Version | Beschreibung |
|---|---|
| 8.0.0 |
Diese Funktion gibt bei Auftreten eines Fehlers nicht mehr false
zurück.
|
Beispiele
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
Siehe auch
- printf() - Liefert einen formatierten String
- fprintf() - Schreibt einen formatierten String in einen Stream
- vprintf() - Gibt einen formatierten String aus
- vsprintf() - Gibt einen formatierten String zurück
- vfprintf() - Schreibt einen formatierten String in einen Stream
- sscanf() - Überträgt einen String in ein angegebenes Format
- fscanf() - Interpretiert den Input einer Datei entsprechend einem angegebenen Format
- number_format() - Formatiert eine Zahl mit Tausender-Trennzeichen
- date() - Formatiert einen Unix-Zeitstempel
