(PHP 4 >= 4.0.1, PHP 5, PHP 7)
fscanf — Analyse un fichier en fonction d'un format
La fonction fscanf() est similaire à la fonction
sscanf(), sauf qu'elle prend un fichier en entrée,
représentée par la ressource handle et interprète
l'entrée en fonction du format format spécifié,
qui est décrit dans la documentation de la fonction
sprintf().
Tous les caractères blancs de la chaîne de formatage correspondent à autant d'espaces dans le flux d'entrée. Cela signifie qu'une tabulation \t dans la chaîne de format peut remplacer un espace simple dans le flux d'entrée.
Chaque appel à la fonction fscanf() lit une ligne du fichier.
handleUn pointeur de système de fichiers de type resource qui est habituellement créé en utilisant la fonction fopen().
formatLa 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 : %[flags][width][.precision]specifier.
| 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). |
Un entier indiquant combien de caractères (au minimum) cette conversion doit avoir pour résultat.
Un point . suivie d'un entier dont sa signification dépend du spécificateur :
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_MAXgénèrera une alerte.
| 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). Le spécificateur de précision représente le nombre de chiffres après la virgule depuis PHP 5.2.1. Dans les versions antérieures, il a été pris comme nombre des chiffres significatifs (moins un). |
| 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 float) 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 float) et présenté comme un nombre à virgule flottante (ne tenant pas compte de la locale utilisée). Disponible à partir de PHP 5.0.3. |
| 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. |
| 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). |
Le spécificateur de type c ignore l'alignement et la taille.
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 :
| Type | Spécificateurs |
|---|---|
| string | s |
| integer | d, u, c, o, x, X, b |
| double | g, G, e, E, f, F |
...Les valeurs optionnelles à assigner.
Si seulement 2 paramètres sont passés à la fonction, la valeur analysée sera retourné sous la forme d'un tableau. Si des paramètres optionnels sont passés, la fonction retournera le nombre de valeurs assignées. Les paramètres optionnels doivent être passés par référence.
Exemple #1 Exemple avec fscanf()
<?php
$handle = fopen("users.txt", "r");
while ($userinfo = fscanf($handle, "%s\t%s\t%s\n")) {
list ($name, $profession, $countrycode) = $userinfo;
//... traitement des données
}
fclose($handle);
?>
Exemple #2 Contenu du fichier users.txt
javier argonaut pe hiroshi sculptor jp robert slacker us luigi florist it