Parses input from file according to a format

Beschreibung

public function SplFileObject::fscanf(string $format, mixed &...$vars): array|int|null

Reads a line from the file and interprets it according to the specified format.

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

Das interpretierte Format für string, wie es in der Dokumentation zu sprintf() beschrieben ist, mit den folgenden Unterschieden:

Die Funktion beachtet die Locale nicht.
F, g, G und b werden nicht unterstützt.
D steht für eine Dezimalzahl.
i steht für eine Ganzzahl mit Angabe der Basis.
n steht für die Anzahl der bisher verarbeiteten Zeichen.
s beendet das Lesen beim ersten Whitespace-Zeichen.
* anstelle von argnum$ unterdrückt die Zuweisung dieser Umwandlungsspezifikation.

vars

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 method will return the number of assigned values. The optional parameters must be passed by reference.

If there are more substrings expected in the format than there are available in the line read from the file, null will be returned.

When optional parameters are used and the end of the line read from the file is reached before any value has been parsed, -1 is returned.

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() - Liefert einen formatierten String
sprintf() - Gibt einen formatierten String zurück