fprintf
(PHP 5, PHP 7, PHP 8)
fprintf — 将格式化后的字符串写入到流
说明
写入根据 format 格式化后的字符串到由
stream 句柄打开的流中。
参数
streamformat-
format 字符串通常由零或多个指令组成:普通字符(不包含
%)——直接复制到结果,转换规范——获取每个参数的结果。转换规范遵循此原型:
%[argnum$][flags][width][.precision]specifier.Argnum
整数后跟美元符号
$,用于指定转换中要处理的参数数量。标志 标志 说明 -在指定字段宽度时左对齐,默认右对齐 +正数的加号 +前缀,默认负数的前缀是负号。(space)空格填充结果。这是默认设置。 0仅用 0 进行左侧数字填充。使用 s标志符可以右侧填充。'(char)用字符(char)填充结果。 Width
要么是整数,表示转换结果应该有多少个字符(最少),要么是
*。如果使用*,那么宽度将作为额外的整数值提供,位于格式化符号之前。Precision
小数点
.,可选的后跟整数或者*,其含义取决于格式化符号:-
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参数当做浮点数处理且作为浮点数呈现(locale aware)。 F参数当做浮点数处理且作为浮点数呈现(non-locale aware)。 g通用格式。
Let P equal the precision if nonzero, 6 if the precision is omitted, or 1 if the precision is zero. Then, if a conversion with style E would have an exponent of X:
If P > X ≥ −4, the conversion is with style f and precision P − (X + 1). Otherwise, the conversion is with style e and precision P − 1.
GLike the gspecifier but usesEandf.hLike the gspecifier but usesF. Available as of PHP 8.0.0.HLike the gspecifier but usesEandF. Available as of PHP 8.0.0.o参数视为整数并以八进制数字来呈现。 s参数视为字符串来呈现。 u参数视为整数并以无符号十进制数字呈现。 x参数视为整数并作为十六进制数字呈现(带小写字母)。 X参数视为整数并作为十六进制数字呈现(带大写字母)。 警告c类型标志符忽略填充和宽度。警告Attempting to use a combination of the string and width specifiers with character sets that require more than one byte per character may result in unexpected results.
变量将会强制转换为适合标志符的类型:
类型处理 类型 标志符 string sint d,u,c,o,x,X,bfloat e,E,f,F,g,G,h,H -
values-
返回值
返回写入的字符串长度。
错误/异常
从 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 开始,当传递的参数少于所需的参数时会抛出 ArgumentCountError。在 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 |
当传递的参数少于所需的参数时抛出 ArgumentCountError;以前该函数则会发出 E_WARNING。
|
示例
示例 #1 fprintf():零填充整数
<?php
if (!($fp = fopen('date.txt', 'w'))) {
return;
}
fprintf($fp, "%04d-%02d-%02d", $year, $month, $day);
// 将格式化的 ISO 日期写入 date.txt
?>示例 #2 fprintf():格式化货币
<?php
if (!($fp = fopen('currency.txt', 'w'))) {
return;
}
$money1 = 68.75;
$money2 = 54.35;
$money = $money1 + $money2;
// $money 将输出“123.1”
$len = fprintf($fp, '%01.2f', $money);
// 将“123.10”写入到 currency.txt
echo "wrote $len bytes to currency.txt";
// 使用 fprintf 的返回值来确定写入了多少字节
?>参见
- printf() - 输出格式化字符串
- sprintf() - 返回格式化字符串
- vprintf() - 输出格式化字符串
- vsprintf() - 返回格式化字符串
- vfprintf() - 将格式化字符串写入流
- sscanf() - 根据指定格式解析输入的字符
- fscanf() - 从文件中格式化输入
- number_format() - 以千位分隔符方式格式化一个数字
- date() - 格式化 Unix 时间戳
用户贡献的备注 1 note
If you use the command line interface (CLI SAPI), you may be interested by the 3 standard input/output streams (STDIN, STDOUT & STDERR) described at: https://www.php.net/manual/en/features.commandline.io-streams.php