Edit Report a Bug

    vprintf

    (PHP 4 >= 4.1.0, PHP 5, PHP 7, PHP 8)

    vprintf — Affiche une chaîne formatée

    Description

    vprintf(string $format, array $values): int

    vprintf() affiche le tableau args, sous forme de chaîne formatée grâce à format. Le format est le même que celui utilisé par sprintf().

    vprintf() fonctionne comme printf(), mais accepte un tableau comme argument, au lieu d'une liste d'arguments.

    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

    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.

    Precision

    Un point . suivi optionnellement soit d'un entier, soit de *, dont la 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é. 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é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

    values

    Valeurs de retour

    Retourne la longueur de la chaîne retournée.

    Erreurs / Exceptions

    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.

    Historique

    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.

    Exemples

    Exemple #1 Exemple avec vprintf() : entiers complétés avec des zéros

    <?php
    vprintf    ("%04d-%02d-%02d", explode('-', '1988-8-1'));
    ?>

    L'exemple ci-dessus va afficher :

    1988-08-01

    Voir aussi

    • printf() - Affiche une chaîne de caractères formatée
    • sprintf() - Retourne une chaîne formatée
    • fprintf() - Écrit une chaîne formatée dans un flux
    • vsprintf() - Retourne une chaîne formatée
    • vfprintf() - Écrit une chaîne formatée dans un flux
    • sscanf() - Analyse une chaîne à l'aide d'un format
    • fscanf() - Analyse un fichier en fonction d'un format
    • number_format() - Formate un nombre pour l'affichage
    • date() - Formate un horodatage Unix

    add a note add a note

    User Contributed Notes 8 notes

    up
    10
    steve at stevelockwood dot net
    10 years ago
    If, instead of an array, you pass an object PHP will automatically cast the object as an array so you can use it directly in vprintf.
    <?php
    $object     = new stdClass();
    $object->Property1 = 'Value 1';
    $object->Property2 = 'Value 2';
    vprintf('%-20s %-20s', $object);

    /* will output
    Value 1              Value 2            
    */
    ?>
    up
    1
    phpcoder at gmail dot com
    5 years ago
    Using the ... operator, vprintf($format, $array) is basically just printf($format, ...$array).
    up
    0
    taken from &#34;Php Phrasebook&#34;
    16 years ago
    <?php
    $string     = 'The site runs on PHP '.phpversion();
    preg_match('/php ((\d)\.\d\.\d+)/i',$string,$matches);
    print_r($matches);
    vprintf('Match: %s<br /> Version %s; Major:%d.',$matches);
    ?>

    output:
    Array ( [0] => PHP 5.2.5 [1] => 5.2.5 [2] => 5 )
    Match: PHP 5.2.5 Version 5.2.5; Major:5.

    For preg_match:

    If matches  is provided, then it is filled with the results of search. $matches[0] will contain the text that matched the full pattern, $matches[1]  will have the text that matched the first captured parenthesized subpattern, and so on.
    up
    0
    tehjosh at gamingg dot net
    17 years ago
    To toolofthesystem at gmail dot com:

    You don't need to use output buffering with vprintf() because you can use vsprintf(), which has the same functionality as vprintf(), except that it returns the resulting string instead of outputting it.
    up
    -2
    Chris
    12 years ago
    Another way to display arrays is use an array_walk(). This can be useful inline echo/print where a foreach wouldn't work, e.g.

    <?php
    echo "These errors: ", (unset)array_walk($msgs, function($a) { echo "<p>$a</p>"; } ), "must be corrected.";
    ?>
    up
    -2
    caleb at tekhawk dot com
    18 years ago
    i know that you can use %1$s or %3$s to select the first or third string but how can you or can you use array names to select it

    something like %'user'$s $'email'$s

    i tend to add things to my databases over time and this could save loads of recoding
    up
    -3
    badcop666 at hotmail dot com
    17 years ago
    For blocks of text, sprintf() is slow according to my tests.

    Also, having the mapping between place-holders and the list of actual variables or datastructures often makes this code difficult to read. But the printf() family are widely supported and have a huge range of nice features. Performance is a cold mistress though!

    From an ease-of-reading and maintenance, debugging point of view, I much prefer HEREDOC and "...{$variable}..." methods.

    For a block of HTML markup with place holders, the fastest by far was:-

    ?>
    <div> markup etc<?= $variable ?>more markup
    <?

    My tests comprised 20 runs of a loop of 1 million iterations with output buffering    , ditching the buffer on each loop.

    The timings ranged from average 2.1msec/million repetitions for the <?= $var ?> method up to 7.6msec/million using printf().

    I'll try some benchmarking tools too, since I just wrote this myself and it could be introducing bias, but they've run on dev servers with low load.

    Hopefully interesting.
    up
    -3
    toolofthesystem at gmail dot com
    17 years ago
    This function comes useful sometimes when trying to list information returned from MySQL:

    function print_sql($query,$printf){
        $sql_sql = mysql_query($query);
        while($sql = mysql_fetch_row($sql_sql)){
            vprintf($printf,$sql);
        }
    }

    Unfortunately, this seems to sneak its way past output buffering when I tried creating an argument to allow it to be contained in a returned string... either that or I didn't do it right.
    add a note add a note
    To Top