PHP 7.4.24 Released!

SplFileObject::fscanf

(PHP 5 >= 5.1.0, PHP 7, PHP 8)

SplFileObject::fscanfAnalyse une entrée d'un fichier suivant un format donné

Description

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

Lit une ligne depuis un fichier et l'analyse suivant le format format spécifié, décrit dans la documentation de la fonction sprintf().

Les espaces blancs dans la chaîne format correspondent aux espaces blancs dans la ligne du fichier. Ceci signifie que une tabulation (\t) dans le format va correspondre à un seul caractère blanc dans le flux d'entrée.

Liste de paramètres

format

La chaîne de format est composé de zéro ou plusieurs directives : des caractères ordinaires (à l'exception de %) qui sont copiés directement dans le résultat et des spécifications de conversion, chacun ayant pour résultat de récupérer ses propres paramètre.

Une spécification de conversion qui suit ce prototype : %[argnum$][flags][width][.precision]specifier.

Argnum

Un entier suivit d'un signe dollar $, pour spécifier quel numéro d'argument à traiter dans la conversion.

Drapeaux
Drapeau Description
- Justifie le texte à gauche donnée la largeur du champ ; Justification à droite est le comportement par défaut.
+ Préfixe les nombres positives avec un signe plus + ; Par défaut seul les nombres négatifs sont préfixés avec un signe négatif.
(espace) Complète le résultat avec des espaces. Ceci est par défaut.
0 Complète uniquement les nombres à gauches avec des zéros. Avec le spécificateur s ceci peut aussi compléter à droite avec des zéros.
'(char) Complète le résultat avec le caractère (char).

Largeur

Un entier indiquant combien de caractères (au minimum) cette conversion doit avoir pour résultat.

Precision

Un point . suivie d'un entier dont sa signification dépend du spécificateur :

  • Pour les spécificateurs e, E, f et F : ceci est le nombre de chiffres à afficher après la virgule (par défaut, ceci est 6).
  • Pour les spécificateurs g, G, h et H : ceci est le nombre maximal de chiffres significatifs à afficher. digits to be printed.
  • Pour le spécificateur s : il agit comme un point de coupure, définissant une limite maximale de caractères de la chaîne.

Note: Si le point est spécifié sans une valeur explicite pour la précision, 0 est assumé.

Note: Tenter d'utiliser une position supérieure à PHP_INT_MAX génèrera une alerte.

Spécificateurs
Spécificateur Description
% Un caractère de pourcentage littéral. Aucun argument n'est nécessaire.
b L'argument est traité comme un entier et présenté comme un nombre binaire.
c L'argument est traité comme un entier et présenté comme le caractère de code ASCII correspondant.
d L'argument est traité comme un entier et présenté comme un nombre entier décimal (signé).
e L'argument est traité comme une notation scientifique (e.g. 1.2e+2).
E Comme le spécificateur e mais utilise une lettre majuscule (par exemple 1.2E+2).
f L'argument est traité comme un nombre à virgule flottante (type nombre décimal) et présenté comme un nombre à virgule flottante (tenant compte de la locale utilisée).
F L'argument est traité comme un nombre à virgule flottante (type nombre décimal) et présenté comme un nombre à virgule flottante (ne tenant pas compte de la locale utilisée).
g

Format général.

Soit P égal à la précision si différent de 0, 6 si la précision est omit ou 1 si la précision est zéro. Alors, si la conversion avec le style E aurait comme exposant X :

Si P > X ≥ −4, la conversion est avec style f et précision P − (X + 1). Sinon, la conversion est avec le style e et précision P - 1.

G Comme le spécificateur g mais utilise E et f.
h Comme le spécificateur g mais utilise F. Disponible à partir de PHP 8.0.0.
H Comme le spécificateur g mais utilise E et F. Disponible à partir de PHP 8.0.0.
o L'argument est traité comme un entier et présenté comme un nombre octal.
s L'argument est traité et présenté comme une chaîne de caractères.
u L'argument est traité comme un entier et présenté comme un nombre décimal non signé.
x L'argument est traité comme un entier et présenté comme un nombre hexadécimal (les lettres en minuscules).
X L'argument est traité comme un entier et présenté comme un nombre hexadécimal (les lettres en majuscules).

Avertissement

Le spécificateur de type c ignore l'alignement et la taille.

Avertissement

Le fait de tenter d'utiliser une combinaison d'une chaîne et de spécificateurs avec des jeux de caractères qui nécessitent plus d'un octet par caractères donnera un résultat inattendu.

Les variables seront contraints à un type approprié pour le spécificateur :

Gestion des types
Type Spécificateurs
string s
int d, u, c, o, x, X, b
float e, E, f, F, g, G, h, H

vars

Les valeurs optionnelles assignées.

Valeurs de retour

Si seul 1 paramètre est passé à cette méthode, la valeur analysée sera retournée sous la forme d'un tableau. Sinon, si les paramètres optionnelles sont passés, la fonction retournera le nombre de valeurs assignées. Les paramètres optionnels doivent être passés par référence.

Exemples

Exemple #1 Exemple avec SplFileObject::fscanf()

<?php
$file 
= new SplFileObject("misc.txt");
while (
$userinfo $file->fscanf("%s %s %s")) {
    list (
$name$profession$countrycode) = $userinfo;
    
// Faire des opérations sur $name $profession $countrycode
}
?>

Contenu de users.txt

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

Voir aussi

  • fscanf() - Analyse un fichier en fonction d'un format
  • sscanf() - Analyse une chaîne à l'aide d'un format
  • printf() - Affiche une chaîne de caractères formatée
  • sprintf() - Retourne une chaîne formatée

add a note add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top