Parses input from file according to a format

Beschreibung

public SplFileObject::fscanf ( string $format [, mixed &$... ] ) : mixed

Reads a line from the file and interprets it according to the specified format, which is described in the documentation for sprintf().

Any whitespace in the format string matches any whitespace in the line from the file. This means that even a tab \t in the format string can match a single space character in the input stream.

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: %[Flags][Weite][.Präzision]Spezifizierer.

**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 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.

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, f und F: Dies stellt die Anzahl der Nachkommastellen an, die nach dem Dezimaltrennzeichen ausgegeben werden soll (Standradmäßig ist dies 6).
Für die Spezifizierer g und G: Die maximale Anzahl der auszugebenenden signifikanten Nachkommastellen.
Für den 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**
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.

Warnung

Der Spezifizierer c ignoriert Auffüllung und Weite.

Warnung

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-Behandlung**
Typ	Spezifizierer
string	s
integer	d, u, c, o, x, X, b
double	g, G, e, E, f, F

...

The optional assigned values.

Rückgabewerte

If only one parameter is passed to this method, the values parsed will be returned as an array. Otherwise, if optional parameters are passed, the function will return the number of assigned values. The optional parameters must be passed by reference.

Beispiele

Beispiel #1 SplFileObject::fscanf() example


<?php
$file = new SplFileObject("misc.txt");
while ($userinfo = $file->fscanf("%s %s %s")) {
    list ($name, $profession, $countrycode) = $userinfo;
    // Do something with $name $profession $countrycode
}
?>

Contents of users.txt

javier   argonaut    pe
hiroshi  sculptor    jp
robert   slacker     us
luigi    florist     it

Siehe auch

fscanf() - Interpretiert den Input einer Datei entsprechend einem angegebenen Format
sscanf() - Überträgt einen String in ein angegebenes Format
printf() - Gibt einen formatierten String aus
sprintf() - Gibt einen formatierten String zurück