(PHP 4 >= 4.1.0, PHP 5, PHP 7, PHP 8)
vprintf — Output a formatted string
Display array values as a formatted string according to
format (which is described in the documentation
for sprintf()).
Operates as printf() but accepts an array of arguments, rather than a variable number of arguments.
format
Рядок формату складається з нуля або більше директив: звичайних символів
(крім %), які відображаються в результаті без змін, та
специфікаторів перетворення, для кожного з яких
задається свій параметр.
Специфікатор перетворення відповідає прототипу:
%[argnum$][flags][width][.precision]specifier.
Ціле число, слідом за ним — знак долара $. Вказує
порядковий номер параметра для перетворення.
| Позначення | Опис |
|---|---|
- |
Вирівнює по лівому краю в межах заданої ширини. Праве вирівнювання виконується автоматично. |
+ |
Дописує до додатнього числа знак +. Знак мінуса до
від'ємного числа дописується автоматично.
|
(пропуск) |
Доповнює результат пропусками. Також виконується автоматично. |
0 |
Доповнює число нулями ліворуч. Разом зі специфікатором
s доповнює число нулями також праворуч.
|
' (символ) |
Доповнює рядок символом (символ). |
Може бути цілим числом, що вказує найменшу кількість символів в значенні
після перетворення, або знак *. Якщо використано
знак *, то ширина вказується як додаткове ціле число,
що передує значенню, відформатованому специфікатором.
Крапка ., за якою (необов'язково) слідує ціле число
чи знак *, значення якого залежить від специфікатора:
e, E,
f і F — це кількість знаків, що
будуть надруковані після десяткового розділювача (початково: 6).
g, G,
h і H — найбільша допустима
кількість значущих цифр, що будуть надруковані.
s — діє як точка відсікання,
встановлюючи максимальну кількість символів у рядку.
Зауваження: Якщо крапку вказано без зазначення точності, тоді точністю вважатиметься 0. Якщо використано знак
*, то точність вказується як додаткове ціле число, що передує значенню, відформатованому специфікатором.
| Назва | Опис |
|---|---|
% |
Буквальний знак відсотка. Ніяких параметрів не потрібно. |
b |
Параметр розглядається як ціле число і відображається як двійкове число. |
c |
Параметр розглядається як ціле число і відображається як символ з таким кодом ASCII. |
d |
Параметр розглядається як ціле число і відображається як знакове десяткове число. |
e |
Параметр розглядається як експоненційний запис (напр. 1.2e+2). |
E |
Схожий до специфікатора e, але використовує знак
експоненти з великої букви (напр. 1.2E+2).
|
f |
Параметр розглядається і відображається як десятковий дріб (з урахуванням локалі). |
F |
Параметр розглядається і відображається як десятковий дріб (БЕЗ урахування локалі). |
g |
Загальний формат.
Нехай Якщо P > X ≥ −4, перетворення буде в стилі "f" та з точністю P − (X + 1). Інакше, перетворення буде в стилі "e" та з точністю P − 1. |
G |
Схожий до специфікатора g, але використовує
E та f.
|
h |
Схожий до специфікатора g, але використовує
F. Доступний, починаючи з PHP 8.0.0.
|
H |
Схожий до специфікатора g, але використовує
E та F. Доступний, починаючи з
PHP 8.0.0.
|
o |
Параметр розглядається як ціле число і відображається як вісімкове число. |
s |
Параметр розглядається і відображається як рядок. |
u |
Параметр розглядається як ціле число і відображається як беззнакове десяткове число. |
x |
Параметр розглядається як ціле число і відображається як шіснадцяткове число (з малими буквами). |
X |
Параметр розглядається як ціле число і відображається як шіснадцяткове число (з великими буквами). |
Специфікатор "c" ігнорує заповнення та ширину.
Спроба використати разом рядковий специфікатор та специфікатор ширини з символами, що займають більше одного байта, може призвести до неочікуваного результату.
Змінні будуть приведені до відповідного типу для специфікатора:
| Тип | Специфікатор |
|---|---|
| string | s |
| int |
d,
u,
c,
o,
x,
X,
b
|
| float |
e,
E,
f,
F,
g,
G,
h,
H
|
values
Returns the length of the outputted string.
Починаючи з PHP 8.0.0, якщо не задано жодного параметра, то викидається
ValueError. Раніше виводилось повідомлення
E_WARNING.
Починаючи з PHP 8.0.0, якщо значення [width] менше за нуль
або більше за PHP_INT_MAX, то викидається
ValueError. Раніше виводилось повідомлення
E_WARNING.
Починаючи з PHP 8.0.0, якщо значення [precision] менше за
нуль або більше за PHP_INT_MAX, то викидається
ValueError. Раніше виводилось повідомлення
E_WARNING.
Починаючи з PHP 8.0.0, якщо якщо не задано обов'язкові параметри, то
викидається ValueError. Раніше функція повертала
false, а також виводилося повідомлення E_WARNING.
| Версія | Опис |
|---|---|
| 8.0.0 |
Ця функція більше не повертає false у разі помилки.
|
| 8.0.0 |
Викидає ValueError, якщо не задано жодного
параметра. Раніше ця функція виводила E_WARNING.
|
| 8.0.0 |
Викидає ValueError, якщо значення
[width] менше за нуль або більше за
PHP_INT_MAX. Раніше ця функція виводила
E_WARNING.
|
| 8.0.0 |
Викидає ValueError, якщо значення
[precision] менше за нуль або більше за
PHP_INT_MAX. Раніше ця функція виводила
E_WARNING.
|
| 8.0.0 |
Викидає ValueError, якщо не задано
обов'язкові параметри. Раніше ця функція виводила
E_WARNING.
|
Приклад #1 vprintf(): zero-padded integers
<?php
vprintf("%04d-%02d-%02d", explode('-', '1988-8-1'));
?>Поданий вище приклад виведе:
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.