(PHP 4 >= 4.1.0, PHP 5, PHP 7, PHP 8)
vprintf — Mostra uma string formatada
Motra valores de array como uma string formatada de acordo com
format (que está descrito na documentação
da função sprintf()).
Funciona como printf() mas aceita uma array de argumentos, ao invés de um número variável de argumentos.
format
A string de formato é composta de zero ou mais diretivas:
caracteres comuns (excluindo %) que são
copiados diretamente para o resultado e especificações
de conversão, cada uma das quais resulta na busca de seu
próprio parâmetro.
Uma especificação de conversão segue este protótipo:
%[argnum$][flags][width][.precision]especificador.
Um número inteiro seguido por um cifrão $,
para especificar qual o número de argumento a tratar na conversão.
| Flag | Descrição |
|---|---|
- |
Justificar à esquerda dentro da largura de campo especificada; A justificação à direita é o padrão. |
+ |
Prefixa números positivos com um sinal de mais
+; Por padrão, apenas números negativos
são prefixados com um sinal negativo.
|
(espaço) |
Preenche o resultado com espaços. Este é o padrão. |
0 |
Preenche números com zeros apenas à esquerda.
Com os especificadores s, também pode
preencher com zeros à direita.
|
'(char) |
Preenche o resultado com o caractere (char). |
Um número inteiro que define em quantos caracteres (mínimo)
esta conversão deve resultar, ou *.
Se * for usado, a largura será fornecida
como um valor inteiro adicional precedendo aquele formatado
pelo especificador.
Um ponto . opcionalmente seguido por
um número inteiro ou *,
cujo significado depende do especificador:
e, E,
f e F:
este é o número de dígitos a serem impressos
após o ponto decimal (por padrão, é 6).
g, G,
h e H:
este é o número máximo de dígitos
significativos a serem impressos.
s: atua como um ponto de corte,
definindo um limite máximo de caracteres para a string.
Nota: Se o ponto for especificado sem um valor explícito para precisão, 0 é assumido. Se
*for usado, a precisão é fornecida como um valor inteiro adicional precedendo aquele formatado pelo especificador.
| Especificador | Descrição |
|---|---|
% |
Um caractere literal de porcentagem. Nenhum argumento é necessário. |
b |
O argumento é tratado como um número inteiro e apresentado como um número binário. |
c |
O argumento é tratado como um número inteiro e apresentado como o caractere com aquele código ASCII. |
d |
O argumento é tratado como um número inteiro e apresentado como um número decimal (com sinal). |
e |
O argumento é tratado como notação científica (por exemplo, 1.2e+2). |
E |
Como o especificador e, mas usa
letra maiúscula (por exemplo, 1.2E+2).
|
f |
O argumento é tratado como um float e apresentado como um número de ponto flutuante (com reconhecimento da localidade). |
F |
O argumento é tratado como um float e apresentado como um número de ponto flutuante (sem reconhecimento da localidade). |
g |
Formato geral. Deixa P igual à precisão se for diferente de zero, 6 se a precisão for omitida, ou 1 se a precisão for zero. Então, se uma conversão com estilo E tivesse um expoente de X: Se P > X ≥ −4, a conversão é com estilo f e precisão P − (X + 1). Caso contrário, a conversão é com estilo e e precisão P − 1. |
G |
Como o especificador g, mas usa
E e f.
|
h |
Como o especificador g, mas usa F.
Disponível a partir do PHP 8.0.0.
|
H |
Como o especificador g, mas usa
E e F. Disponível a partir do PHP 8.0.0.
|
o |
O argumento é tratado como um número inteiro e apresentado como um número octal. |
s |
O argumento é tratado e apresentado como uma string. |
u |
O argumento é tratado como um número inteiro e apresentado como um número decimal sem sinal. |
x |
O argumento é tratado como um número inteiro e apresentado como um número hexadecimal (com letras minúsculas). |
X |
O argumento é tratado como um número inteiro e apresentado como um número hexadecimal (com letras maiúsculas). |
O especificador de tipo c ignora preenchimento e largura.
Tentar usar uma combinação dos especificadores de string e largura com conjuntos de caracteres que requerem mais de um byte por caractere pode resultar em resultados inesperados.
As variáveis serão forçadas a um tipo adequado para o especificador:
| Tipo | Especificadores |
|---|---|
| string | s |
| int |
d,
u,
c,
o,
x,
X,
b
|
| float |
e,
E,
f,
F,
g,
G,
h,
H
|
values
Retorna o comprimento da string mostrada.
A partir do PHP 8.0.0, um erro ValueError será lançado se o número de argumentos for zero.
Antes do PHP 8.0.0, um E_WARNING era emitido.
A partir do PHP 8.0.0, um erro ValueError será lançado se [width] for menor que zero ou maior que PHP_INT_MAX.
Antes do PHP 8.0.0, um E_WARNING era emitido.
A partir do PHP 8.0.0, um erro ValueError será lançado se [precision] for menor que zero ou maior que PHP_INT_MAX.
Antes do PHP 8.0.0, um E_WARNING era emitido.
A partir do PHP 8.0.0, um erro ArgumentCountError será lançado quando menos argumentos do que o necessário forem fornecidos.
Antes do PHP 8.0.0, false era retornado e um E_WARNING era emitido.
| Versão | Descrição |
|---|---|
| 8.0.0 |
Esta função não mais retorna false em caso de falha.
|
| 8.0.0 |
Lança uma exceção ValueError se o número de argumentos for zero;
anteriormente esta função emitia um E_WARNING.
|
| 8.0.0 |
Lança uma exceção ValueError se [width] for menor que zero ou maior que PHP_INT_MAX;
anteriormente esta função emitia um E_WARNING.
|
| 8.0.0 |
Lança uma exceção ValueError se [precision] for menor que zero ou maior que PHP_INT_MAX;
anteriormente esta função emitia um E_WARNING.
|
| 8.0.0 |
Lança uma exceção ValueError quando houver menos parâmetros que os necessários;
anteriormente esta função emitia um E_WARNING.
|
Exemplo #1 vprintf(): inteiros preenchidos com zero
<?php
vprintf("%04d-%02d-%02d", explode('-', '1988-8-1'));
?>O exemplo acima produzirá:
1988-08-01
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
*/
?>Using the ... operator, vprintf($format, $array) is basically just printf($format, ...$array).<?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.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.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.";
?>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 recodingFor 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.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.