(PHP 5, PHP 7, PHP 8)
vfprintf — Écrit une chaîne formatée dans un flux
Écrit une chaîne produite en accord avec le paramètre
format dans le flux stream.
Agit de la même façon que fprintf() excepté que vfprintf() accepte un tableau d'arguments, plutôt qu'un nombre variant d'arguments.
stream
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.
Un entier suivit d'un signe dollar $,
pour spécifier quel numéro d'argument à traiter dans la conversion.
| 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). |
Soit un entier indiquant le nombre de caractères (minimum)
que cette conversion doit produire, soit *.
Si * est utilisé, alors la largeur est fournie
en tant que valeur entière supplémentaire précédant celle formatée
par le spécificateur.
Un point . suivi optionnellement
soit d'un entier, soit de *,
dont la signification dépend du spécificateur :
e, E,
f et F :
ceci est le nombre de chiffres à afficher après
la virgule (par défaut, ceci est 6).
g, G,
h et H :
ceci est le nombre maximal de chiffres significatifs à afficher.
digits to be printed.
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é. Si
*est utilisé, la précision est fournie en tant que valeur entière supplémentaire précédant celle formatée par le spécificateur.
| 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). |
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 |
| int |
d,
u,
c,
o,
x,
X,
b
|
| float |
e,
E,
f,
F,
g,
G,
h,
H
|
values
Retourne la longueur de la chaîne retournée.
As of PHP 8.0.0, a ValueError is thrown if the number of arguments is zero.
Prior to PHP 8.0.0, a E_WARNING was emitted instead.
As of PHP 8.0.0, a ValueError is thrown if [width] is less than zero or bigger than PHP_INT_MAX.
Prior to PHP 8.0.0, a E_WARNING was emitted instead.
As of PHP 8.0.0, a ValueError is thrown if [precision] is less than zero or bigger than PHP_INT_MAX.
Prior to PHP 8.0.0, a E_WARNING was emitted instead.
As of PHP 8.0.0, a ValueError is thrown when less arguments are given than required.
Prior to PHP 8.0.0, false was returned and a E_WARNING emitted instead.
| Version | Description |
|---|---|
| 8.0.0 |
Cette fonction ne renvoie plus false en cas d'échec.
|
| 8.0.0 |
Lance une ValueError si le nombre d'arguments est zéro ;
auparavant, cette fonction émettait un E_WARNING.
|
| 8.0.0 |
Lance une ValueError si [width] est inférieur à zéro ou supérieur à PHP_INT_MAX ;
auparavant, cette fonction émettait un E_WARNING.
|
| 8.0.0 |
Lance une ValueError si [precision] est inférieur à zéro ou supérieur à PHP_INT_MAX ;
auparavant, cette fonction émettait un E_WARNING.
|
| 8.0.0 |
Lance une ArgumentCountError lorsque moins d'arguments sont donnés que requis ;
auparavant, cette fonction émettait un E_WARNING.
|
Exemple #1 vfprintf() : zéro comme caractères d'espacements
<?php
if (!($fp = fopen('date.txt', 'w')))
return;
vfprintf($fp, "%04d-%02d-%02d", array($year, $month, $day));
// écrira la date formatée ISO dans date.txt
?>