SplFileObject::fscanf
(PHP 5 >= 5.1.0, PHP 7)
SplFileObject::fscanf — Разбирает строку файла в соответствии с заданным форматом
Описание
Читает строку из файла и разбирает ее в соответствии с заданным форматом
format
. Спецификация формата приведена в документации к
функции sprintf().
Любые пробелы в строке format
соответствует
любому пробелу в строке из файла. Это означает, что
символ табуляции \t
в строке формата может соответствовать
одному пробелу в строке файла.
Список параметров
-
format
-
Строка формата состоит из нуля или более директив: обычные символы (за исключением
%
), которые просто выводятся без изменения и спецификаторы преобразования, каждый из которых требует передачи своего параметра.Спецификаторы преобразования имеют следующий формат:
%[argnum$][flags][width][.precision]specifier
.Argnum
Целое число, за которым следует знак доллара
$
, чтобы указать, какой числовой аргумент обрабатывать при преобразовании.Флаги Флаг Описание -
Выравнивание по левому краю в пределах заданной ширины поля; По умолчанию выравнивание происходит по правому краю. +
Печатает плюс +
у не отрицательных чисел; По умолчанию знак печатается только у отрицательных чисел.Дополняет результат пробелами. Это поведение по умолчанию. 0
Дополняет числа нулями (только слева). Со спецификатором s
также может дополнять нулями справа.'
(char)Дополняет результат символом (char). Ширина
Целое число, определяющее минимальное количество символов, которое будет напечатано.
Точность
Точка
.
с последующим целым числом, работающая по разному для разных спецификаторов:-
Для спецификаторов
e
,E
,f
иF
: задает количество цифр после десятичной запятой (по умолчанию 6). -
Для спецификаторов
g
иG
: задает максимальное значение печатаемых значащих цифр. -
Для спецификатора
s
: задает ограничение максимального количества символов в строке, которые будут выведены.
Замечание: Если указана точка без последующего значения точности, то точность будет считаться за 0.
Замечание: Попытка использовать спецификатор позиции со значением больше, чем
PHP_INT_MAX
приведет к выводу предупреждения.Спецификаторы Спецификатор Описание %
Символ процента. Аргументы не требуются. b
Аргумент рассматривается как целое число и печатается в бинарном представлении. c
Аргумент рассматривается как целое число и печатается как символ из таблицы ASCII с соответствующим кодом. d
Аргумент рассматривается как целое число и печатается как целое число со знаком. e
Аргумент считается за число в научной нотации (т.е. 1.2e+2). Начиная с PHP 5.2.1, спецификатор точности задает количество цифр после десятичной запятой. В более ранних версиях он задавал общее количество значащих цифр (т.е. после запятой выводилось на 1 символ меньше). E
Аналогично спецификатору e
, но использует заглавные символы (т.е. 1.2E+2).f
Аргумент считается за число с плавающей точкой (с учетом локали). F
Аргумент считается за число с плавающей точкой (без учета локали). Доступно с PHP 5.0.3. g
Общий формат.
Пусть P равно точности, если она не равно нулю, 6 - если точность не задана и 1, если точность задана как 0. Тогда, если преобразование со стилем "E" будет иметь показатель степени X:
Если 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
integer
d
,u
,c
,o
,x
,X
,b
double
g
,G
,e
,E
,f
,F
-
Для спецификаторов
-
vars
-
Дополнительные строки форматирования.
Возвращаемые значения
Если передан только один параметр, распознанные в строке значения будут помещены в массив. Если переданы дополнительные строки форматирования, функция вернет количество шаблонов, с которыми совпала строка. Необязательные параметры должны передаваться по ссылке.
Примеры
Пример #1 Пример использования SplFileObject::fscanf()
<?php
$file = new SplFileObject("misc.txt");
while ($userinfo = $file->fscanf("%s %s %s")) {
list ($name, $profession, $countrycode) = $userinfo;
// Работаем с $name $profession $countrycode
}
?>
Содержимое файла users.txt
javier argonaut pe hiroshi sculptor jp robert slacker us luigi florist it