(PHP 4 >= 4.1.0, PHP 5, PHP 7, PHP 8)
vprintf — Gibt einen formatierten String aus
Zeigt die Werte eines Arrays als formatierten String entsprechend der
format-Anweisungen (siehe Beschreibung der
Formatierungsmöglichkeiten der Funktion sprintf()) an.
Arbeitet wie printf(), akzeptiert jedoch ein Array anstelle mehrerer Werte als Argument.
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. |
Entweder eine Ganzzahl die angibt, wie viele Zeichen (Minimum) das
Konvertierungsergebnis haben soll oder *. Wenn
* verwendet wird, wird die Breite als zusätzlicher
ganzzahliger Wert angegeben, der bestimmt, wie viele Zeichen vor dem durch
den Spezifizierer formatierten Wert stehen sollen.
Ein Punkt ., optional gefolgt von einer Ganzzahl oder
*, dessen Bedeutung vom Spezifizierer abhängt:
e, E,
f und F: Dies stellt die
Anzahl der Nachkommastellen an, die nach dem Dezimaltrennzeichen
ausgegeben werden soll (Standardmäßig ist dies 6).
g, G,
h und H:
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 Genauigkeit angegeben wird, wird 0 angenommen. Wenn
*verwendet wird, wird die Genauigkeit als zusätzliche Ganzzahl vor dem durch den Bezeichner formatierten Wert angegeben.
| 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. |
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. |
g |
Generelles Format. Sei P gleich der Genauigkeit, wenn nicht Null, 6, wenn die Genauigkeit nicht angegeben ist, oder 1 wenn die Genauigkeit Null ist. Dann, wenn eine Konvertierung mittels E einen Exponenten von X hätte: Wenn P > X ≥ −4, erfolgt die Konvertierung mit Spezifizierer f und Genauigkeit P - (X + 1), andernfalls mit Spezifizierer e und Genauigkeit P - 1. |
G |
Wie der Spezifizierer g, aber
es wird E und f verwendet.
|
h |
Wie der Spezifizierer g, aber es werden
F verwendet. Verfügbar ab PHP 8.0.0.
|
H |
Wie der Spezifizierer g, aber es werden
E und F verwendet. Verfügbar ab
PHP 8.0.0.
|
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 |
| int |
d,
u,
c,
o,
x,
X,
b
|
| float |
e,
E,
f,
F,
g,
G,
h,
H
|
values
Gibt die Länge des Ausgabestrings zurück.
Wenn die Anzahl der Argumente Null ist, wird seit PHP 8.0.0 ein ValueError ausgelöst.
Vor PHP 8.0.0 wurde stattdessen eine E_WARNING ausgegeben.
Wenn [width] kleiner als Null oder größer als PHP_INT_MAX ist, wird seit PHP 8.0.0 ein ValueError ausgelöst.
Vor PHP 8.0.0 wurde stattdessen eine E_WARNING ausgegeben.
Wenn [precision] kleiner als Null oder größer als PHP_INT_MAX ist, wird seit PHP 8.0.0 ein ValueError ausgelöst.
Vor PHP 8.0.0 wurde stattdessen eine E_WARNING ausgegeben.
Wenn weniger Argumente angegeben werden als nötig, wird seit PHP 8.0.0 ein ValueError ausgelöst.
Vor PHP 8.0.0 wurde stattdessen false zurückgegeben und eine E_WARNING ausgegeben.
| Version | Beschreibung |
|---|---|
| 8.0.0 |
Diese Funktion gibt bei Auftreten eines Fehlers nicht mehr false
zurück.
|
| 8.0.0 |
Wenn die Anzahl der Argumente Null ist, löst diese Funktion einen
ValueError aus; vorher gab sie stattdessen eine
E_WARNING aus.
|
| 8.0.0 |
Wenn [width] kleiner als Null oder größer als
PHP_INT_MAX ist, löst diese Funktion einen
ValueError aus; vorher gab sie stattdessen eine
E_WARNING aus.
|
| 8.0.0 |
Wenn [precision] kleiner als Null oder größer als
PHP_INT_MAX ist, löst diese Funktion einen
ValueError aus; vorher gab sie stattdessen eine
E_WARNING aus.
|
| 8.0.0 |
Wenn weniger Argumente angegeben werden als nötig, löst diese Funktion
einen ValueError aus; vorher gab sie stattdessen
eine E_WARNING aus.
|
Beispiel #1 vprintf(): mit Nullen aufgefüllte Ganzzahlen
<?php
vprintf("%04d-%02d-%02d", explode('-', '1988-8-1'));
?>Das oben gezeigte Beispiel erzeugt folgende Ausgabe:
1988-08-01
If, instead of an array, you pass an object PHP will automatically cast the object as an array so you can use it directly in vprintf.
<?php
$object = new stdClass();
$object->Property1 = 'Value 1';
$object->Property2 = 'Value 2';
vprintf('%-20s %-20s', $object);
/* will output
Value 1 Value 2
*/
?>Using the ... operator, vprintf($format, $array) is basically just printf($format, ...$array).<?php
$string = 'The site runs on PHP '.phpversion();
preg_match('/php ((\d)\.\d\.\d+)/i',$string,$matches);
print_r($matches);
vprintf('Match: %s<br /> Version %s; Major:%d.',$matches);
?>
output:
Array ( [0] => PHP 5.2.5 [1] => 5.2.5 [2] => 5 )
Match: PHP 5.2.5 Version 5.2.5; Major:5.
For preg_match:
If matches is provided, then it is filled with the results of search. $matches[0] will contain the text that matched the full pattern, $matches[1] will have the text that matched the first captured parenthesized subpattern, and so on.To toolofthesystem at gmail dot com:
You don't need to use output buffering with vprintf() because you can use vsprintf(), which has the same functionality as vprintf(), except that it returns the resulting string instead of outputting it.Another way to display arrays is use an array_walk(). This can be useful inline echo/print where a foreach wouldn't work, e.g.
<?php
echo "These errors: ", (unset)array_walk($msgs, function($a) { echo "<p>$a</p>"; } ), "must be corrected.";
?>i know that you can use %1$s or %3$s to select the first or third string but how can you or can you use array names to select it
something like %'user'$s $'email'$s
i tend to add things to my databases over time and this could save loads of recodingFor blocks of text, sprintf() is slow according to my tests.
Also, having the mapping between place-holders and the list of actual variables or datastructures often makes this code difficult to read. But the printf() family are widely supported and have a huge range of nice features. Performance is a cold mistress though!
From an ease-of-reading and maintenance, debugging point of view, I much prefer HEREDOC and "...{$variable}..." methods.
For a block of HTML markup with place holders, the fastest by far was:-
?>
<div> markup etc<?= $variable ?>more markup
<?
My tests comprised 20 runs of a loop of 1 million iterations with output buffering, ditching the buffer on each loop.
The timings ranged from average 2.1msec/million repetitions for the <?= $var ?> method up to 7.6msec/million using printf().
I'll try some benchmarking tools too, since I just wrote this myself and it could be introducing bias, but they've run on dev servers with low load.
Hopefully interesting.This function comes useful sometimes when trying to list information returned from MySQL:
function print_sql($query,$printf){
$sql_sql = mysql_query($query);
while($sql = mysql_fetch_row($sql_sql)){
vprintf($printf,$sql);
}
}
Unfortunately, this seems to sneak its way past output buffering when I tried creating an argument to allow it to be contained in a returned string... either that or I didn't do it right.