2024年PHP开发者大会日本站

vsprintf

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

vsprintf返回格式化的字符串

描述

vsprintf(字符串 $format, 数组 $values): 字符串

其功能与sprintf()相同,但接受的是一个参数数组,而不是可变数量的参数。

参数

format

格式字符串由零个或多个指令组成:直接复制到结果中的普通字符(不包括%)和*转换说明符*,每个转换说明符都会获取它自己的参数。

转换说明符遵循此原型:%[argnum$][flags][width][.precision]specifier

Argnum

一个整数后跟美元符号$,用于指定转换时要处理的参数编号。

Flags
标志 描述
- 在给定的字段宽度内左对齐;右对齐是默认值
+ 在正数前面加上加号+;默认情况下,只有负数前面带有负号。
(空格) 用空格填充结果。这是默认值。
0 仅用零填充数字的左侧。对于s说明符,也可以用零填充右侧。
'(字符) 用字符 (char) 填充结果。

Width

一个整数,表示此转换应产生的字符数(最小值),或者*。如果使用*,则宽度作为另一个整数提供,该整数位于说明符格式化的整数之前。

Precision

一个句点.,后跟一个整数或*(可选),其含义取决于说明符

  • 对于eEfF说明符:这是小数点后要打印的位数(默认为6)。
  • 对于gGhH说明符:这是要打印的有效数字的最大数量。
  • 对于s说明符:它充当截止点,为字符串设置最大字符限制。

注意如果指定了句点但不指定精度的显式值,则假定为0。如果使用*,则精度作为另一个整数提供,该整数位于说明符格式化的整数之前。

Specifiers
说明符 描述
% 一个文字百分号字符。不需要参数。
b 该参数被视为整数,并以二进制数的形式显示。
c 该参数被视为整数,并以该ASCII码对应的字符的形式显示。
d 该参数被视为整数,并以(带符号)十进制数的形式显示。
e 该参数被视为科学记数法(例如1.2e+2)。
E e说明符类似,但使用大写字母(例如1.2E+2)。
f 该参数被视为浮点数,并以浮点数的形式显示(与语言环境相关)。
F 该参数被视为浮点数,并以浮点数的形式显示(与语言环境无关)。
g

通用格式。

令P等于精度(如果非零),如果省略精度则为6,如果精度为零则为1。然后,如果使用E样式的转换具有X的指数

如果P > X ≥ −4,则转换使用f样式和精度P − (X + 1)。否则,转换使用e样式和精度P − 1。

G g说明符类似,但使用Ef
h g 说明符类似,但使用F。PHP 8.0.0起可用。
H g 说明符类似,但使用EF。PHP 8.0.0起可用。
o 该参数被视为整数,并以八进制数的形式显示。
s 该参数被视为字符串并以字符串的形式显示。
u 该参数被视为整数,并以无符号十进制数的形式显示。
x 该参数被视为整数,并以十六进制数的形式显示(使用小写字母)。
X 该参数被视为整数,并以十六进制数的形式显示(使用大写字母)。

警告

c类型说明符忽略填充和宽度。

警告

尝试将字符串和宽度说明符组合与每个字符需要多个字节的字符集一起使用可能会导致意外结果。

变量将被强制转换为适合说明符的类型

类型处理
类型 Specifiers
字符串 s
整数 ducoxXb
浮点数 eEfFgGhH

values

返回值

根据format返回数组值作为格式化字符串。

错误/异常

从PHP 8.0.0开始,如果参数数量为零,则抛出ValueError。在PHP 8.0.0之前,会发出E_WARNING警告。

从PHP 8.0.0开始,如果[width]小于零或大于PHP_INT_MAX,则抛出ValueError。在PHP 8.0.0之前,会发出E_WARNING警告。

从PHP 8.0.0开始,如果[precision]小于零或大于PHP_INT_MAX,则抛出ValueError。在PHP 8.0.0之前,会发出E_WARNING警告。

从PHP 8.0.0开始,如果提供的参数少于所需参数,则抛出ValueError。在PHP 8.0.0之前,会返回false并发出E_WARNING警告。

变更日志

版本 描述
8.0.0 此函数不再在失败时返回false
8.0.0 如果参数数量为零,则抛出ValueError;之前此函数会发出E_WARNING警告。
8.0.0 如果[width]小于零或大于PHP_INT_MAX,则抛出ValueError;之前此函数会发出E_WARNING警告。
8.0.0 如果[precision]小于零或大于PHP_INT_MAX,则抛出ValueError;之前此函数会发出E_WARNING警告。
8.0.0 如果提供的参数少于所需参数,则抛出ValueError;之前此函数会发出E_WARNING警告。

示例

示例 #1 vsprintf():零填充整数

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

以上示例将输出

1988-08-01

参见

添加笔记

用户贡献笔记 10 条笔记

spectrumcat
8 年前
如果您想使用数组键作为占位符名称并在字符串中替换相应的数组值,则无需自己发明函数,只需使用 str_replace

$string = 'Hello %name!';
$data = array(
'%name' => 'John'
);

$greeting = str_replace(array_keys($data), array_values($data), $string);
Josef Kufner
12 年前
<?php
/**
* 类似于 vsprintf,但接受 $args 键而不是顺序索引。
* 数字和与 /[a-zA-Z0-9_-]+/ 匹配的字符串都是允许的。
*
* 示例:vskprintf('y = %y$d, x = %x$1.1f', array('x' => 1, 'y' => 2))
* 结果:'y = 2, x = 1.0'
*
* $args 也可以是对象,然后使用 get_object_vars() 获取其属性。
*
* 没有参数名称的 '%s' 也能正常工作。vsprintf() 可以执行的所有操作都支持。
*
* @author Josef Kufner <jkufner(at)gmail.com>
*/
function vksprintf($str, $args)
{
if (
is_object($args)) {
$args = get_object_vars($args);
}
$map = array_flip(array_keys($args));
$new_str = preg_replace_callback('/(^|[^%])%([a-zA-Z0-9_-]+)\$/',
function(
$m) use ($map) { return $m[1].'%'.($map[$m[2]] + 1).'$'; },
$str);
return
vsprintf($new_str, $args);
}
?>
crash
3 年前
请注意,从 PHP 8.0 开始,如果发生错误,此函数现在会抛出 ValueError*。

$ php -r 'var_dump(vsprintf("%d", []));'
> Fatal error: Uncaught ValueError: The arguments array must contain 1 items, 0 given in Command line code:1

*ValueError 是 PHP 8.0 中的新增内容,因此,如果您想使您的代码与 PHP 7.x 兼容,则应测试参数数组是否具有正确的长度。
steven at nevvix dot com
6 年前
<?php
/**
* 返回一个格式化的字符串,类似于 vsprintf(),但使用命名占位符。
*
* 当占位符在 `$args` 中没有匹配的键时,
* 占位符将按原样返回,以显示缺少的参数。
* @param string $format
* @param array $args
* @param string $pattern
* @return string
*/
function p($format, array $args, $pattern="/\{(\w+)\}/") {
return
preg_replace_callback($pattern, function ($matches) use ($args) {
return @
$args[$matches[1]] ?: $matches[0];
},
$format);
}

$args = ["database"=>"people", "user"=>"staff", "pass"=>"pass123", "host"=>"localhost"];

// 使用类似 PHP 的占位符:变量嵌入在字符串 "{$database}" 中,但不包含美元符号
$format = <<<SQL
CREATE DATABASE IF NOT EXISTS {database};
GRANT ALL PRIVILEGES ON {database_name}.* TO '{user}'@'{host}';
SET PASSWORD = PASSWORD('{pass}');
SQL;
echo
p($format, $args);
/*
结果:

CREATE DATABASE IF NOT EXISTS people;
GRANT ALL PRIVILEGES ON {database_name}.* TO 'staff'@'localhost';
SET PASSWORD = PASSWORD('pass123');

`{database_name}` 占位符在 `$args` 中不存在匹配的键,因此按原样返回。
*/

// 使用类似 Ruby 的占位符
$format = <<<SQL
CREATE DATABASE IF NOT EXISTS :database;
GRANT ALL PRIVILEGES ON :database_name.* TO ':user'@':host';
SET PASSWORD = PASSWORD(':pass');
SQL;
echo
p($format, $args, "/:(\w+)/");
/*
结果:

CREATE DATABASE IF NOT EXISTS people;
GRANT ALL PRIVILEGES ON :database_name.* TO 'staff'@'localhost';
SET PASSWORD = PASSWORD('pass123');

`:database_name` 占位符在 `$args` 中不存在匹配的键,因此按原样返回。
*/
jon at ardentcreative dot co dot uk
18 年前
这可以用于快速简便的国际化

<?php
$GLOBALS
['strings']['example'] = "There are %d people.";

// 从 lang/$lang/phrases.php 中的翻译列表加载短语
function t() {
$args = func_get_args();
$nArgs = func_num_args();

$phrase = array_shift($args);
$nArgs--;

include_once(
"../lang/" . lang() . "/phrases.php");
if (isset(
$GLOBALS['strings'][$phrase])) {
return
vsprintf($GLOBALS['strings'][$phrase], $args);
} else {
return
'<span style="color: #ff0000">Untranslated string: ' . $phrase . '</span>';
}
}
?>
Roadster
18 年前
请注意:在 4.0.4 版和 4.1.0 版之间可以使用 call_user_func_array 获得相同的功能(差不多)。

示例

call_user_func_array("sprintf", $arg)

$arg 的第一个元素是格式。这在我无法使用 4.1.0 版的情况下救了我。
www dot wesley at gmail dot com
16 年前
vnsprintf 等于 vsprintf,除了关联、带符号或浮点键。

vnsprintf 支持例如 "%assocKey$05d"、"%-2$'+10s" 和 "%3.2$05u",vsprintf 不支持。

vnsprintf( '%2$d', $array) [第二个值] 等于 vsprintf( '%2$d', $array) [第二个值]
vnsprintf( '%+2$d', $array) [键 = 2] 等于 vnsprintf( '%2.0$d', $array) [键 = 2]
vnsprintf( '%+2$d', $array) [键 = 2] 与 vsprintf( '%+2$d', $array) [不支持] 不同。

当您使用带符号或浮点键时,vnsprintf 会搜索原始数组的带符号截断键。

注释¹:vnsprintf 例如不支持 "%someKeyf"(浮点数,键 = someKey)或 "%+03d"(带符号十进制数,键 = 3),您应该分别使用 "%someKey$f" 或 "%+03$d"。
注释²:"%+03d"(或 "%1$+03d")将被解释为带符号的零填充十进制数。

<?php
function vnsprintf( $format, array $data)
{
preg_match_all( '/ (?<!%) % ( (?: [[:alpha:]_-][[:alnum:]_-]* | ([-+])? [0-9]+ (?(2) (?:\.[0-9]+)? | \.[0-9]+ ) ) ) \$ [-+]? \'? .? -? [0-9]* (\.[0-9]+)? \w/x', $format, $match, PREG_SET_ORDER | PREG_OFFSET_CAPTURE);
$offset = 0;
$keys = array_keys($data);
foreach (
$match as &$value )
{
if ( (
$key = array_search( $value[1][0], $keys) ) !== FALSE || ( is_numeric( $value[1][0]) && ( $key = array_search( (int)$value[1][0], $keys) ) !== FALSE ) ) {
$len = strlen( $value[1][0]);
$format = substr_replace( $format, 1 + $key, $offset + $value[1][1], $len);
$offset -= $len - strlen( $key);
}
}
return
vsprintf( $format, $data);
}

$examples = array(
2.8=>'positiveFloat', // key = 2 , 1st value
-3=>'negativeInteger', // key = -3 , 2nd value
'my_name'=>'someString' // key = my_name , 3rd value
);

echo
vsprintf( "%%my_name\$s = '%my_name\$s'\n", $examples); // [unsupported]
echo vnsprintf( "%%my_name\$s = '%my_name\$s'\n", $examples); // output : "someString"

echo vsprintf( "%%2.5\$s = '%2.5\$s'\n", $examples); // [unsupported]
echo vnsprintf( "%%2.5\$s = '%2.5\$s'\n", $examples); // output : "positiveFloat"

echo vsprintf( "%%+2.5\$s = '%+2.5\$s'\n", $examples); // [unsupported]
echo vnsprintf( "%%+2.5\$s = '%+2.5\$s'\n", $examples); // output : "positiveFloat"

echo vsprintf( "%%-3.2\$s = '%-3.2\$s'\n", $examples); // [unsupported]
echo vnsprintf( "%%-3.2\$s = '%-3.2\$s'\n", $examples); // output : "negativeInteger"

echo vsprintf( "%%2\$s = '%2\$s'\n", $examples); // output : "negativeInteger"
echo vnsprintf( "%%2\$s = '%2\$s'\n", $examples); // output : [= vsprintf]

echo vsprintf( "%%+2\$s = '%+2\$s'\n", $examples); // [unsupported]
echo vnsprintf( "%%+2\$s = '%+2\$s'\n", $examples); // output : "positiveFloat"

echo vsprintf( "%%-3\$s = '%-3\$s'\n", $examples); // [unsupported]
echo vnsprintf( "%%-3\$s = '%-3\$s'\n", $examples); // output : "negativeInteger"
?>
dee jay simple zero07 at geemail dawt co
11年前
在vprintf中使用heredoc

<?php
$string
= <<<THESTRING
我喜欢%1\$s州 <br />
我选择:%2\$d作为数字, <br />
我还选择%2\$d作为数字 <br />
%3\$s<br />
THESTRING;

$returnText = vprintf( $string, array('Oregon','7','I Love Oregon') );

echo
$returnText;
?>
jed at NOSPAM dot jed dot bz
20年前
vsprintf() 接受具有任何键的数组,因此在编写 printf 类型函数时,无需使用 array_shift() 技术。您需要的任何参数都可以轻松地从使用 func_get_args() 获取的数组中取消设置。

<?php

function mysprintf($format) {
$args = func_get_args();
unset(
$args[0]); /* 去除“$format” */
return vsprintf($format, $args);
}

/* 我在生产代码中按如下方式使用此技术: */
function logf($target, $string) {
$args = func_get_args();
unset(
$args[0], $args[1]);
fprintf($GLOBALS['config']['logtargets'][$target],
"[%s] %s\n", date('H:i'), wordwrap(vsprintf($string, $args), 75, '\n\r '));
}

/* 例如:
logf(DEBUG, "Oops! %s", mysql_error());
*/

?>
据我所知,不需要 array_shift() 和其他代价高昂的数组操作。我可能错了。
ASchmidt at Anamera dot net
7年前
有必要清楚地说明在使用参数数组时如何应用参数交换。有人可能会尝试使用 %0$ 来引用 $args[0]。

实际上,位置说明符始终是数组索引 + 1

$args[0] 由 %1$... 引用
$args[1] 由 %2$... 引用
等等。

类似地,RegEx 匹配的第一个子模式将在 $matches[1] 中找到,第二个在 $match[2] 中找到,依此类推。但是,如果 $matches 数组用作 vsprint() 的参数,则位置说明符是子模式 + 1

preg_match( $pattern, $subject, $matches );
vsprintf( 'Full Match = %1$s, first Subpattern = %2$s, second Subpattern = %3$s', $matches );
To Top