(PHP 4 >= 4.0.1, PHP 5, PHP 7)
fscanf — Обрабатывает данные из файла в соответствии с форматом
Функция fscanf() похожа на
sscanf(), но берёт данные для обработки из файла,
связанного с handle, и интерпретирует их
согласно формату format, который описан в
документации функции sprintf().
Любой пробельный символ в строке формата эквивалентен любому пробельному символу во входящем потоке. Это означает, что даже табуляция \t в строке формата может быть сопоставлена одному символу пробела во входящем потоке данных.
Каждый вызов fscanf() читает одну строку из файла.
handleУказатель (resource) на файл, обычно создаваемый с помощью функции fopen().
formatСтрока формата состоит из нуля или более директив: обычные символы (за исключением %), которые просто выводятся без изменения и спецификаторы преобразования, каждый из которых требует передачи своего параметра.
Спецификаторы преобразования имеют следующий формат: %[flags][width][.precision]specifier.
| Флаг | Описание |
|---|---|
| - | Выравнивание по левому краю в пределах заданной ширины поля; По умолчанию выравнивание происходит по правому краю. |
| + | Печатает плюс + у не отрицательных чисел; По умолчанию знак печатается только у отрицательных чисел. |
| (space) | Дополняет результат пробелами. Это поведение по умолчанию. |
| 0 | Дополняет числа нулями (только слева). Со спецификатором s также может дополнять нулями справа. |
| '(char) | Дополняет результат символом (char). |
Целое число, определяющее минимальное количество символов, которое будет напечатано.
Точка . с последующим целым числом, работающая по разному для разных спецификаторов:
Замечание: Если указана точка без последующего значения точности, то точность будет считаться за 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. |
| o | Аргумент рассматривается как целое число и печатается в восмеричном представлении. |
| s | Аргумент рассматривается и печатается как строка. |
| u | Аргумент рассматривается как целое число и печатается как беззаковое целое число. |
| x | Аргумент рассматривается как целое число и печатается в шестнадцатеричном представлении (буквы будут в нижнем регистре). |
| X | Аргумент рассматривается как целое число и печатается в шестнадцатеричном представлении (буквы будут в верхнем регистре). |
Спецификатор c игнорирует значения ширины и дополнения
Попытка использовать спецификаторы с указанием ширины для строки в многобайтовой кодировке может привести к неожиданным результатам.
Переменные будут приведены к подходящему для спецификатора типу:
| Тип | Спецификатор |
|---|---|
| string | s |
| integer | d, u, c, o, x, X, b |
| double | g, G, e, E, f, F |
...Необязательные присваиваемые значения.
Если в функцию переданы только два аргумента, обработанные значения будут возвращены в виде массива. В ином случае, если были переданы необязательные аргументы, функция вернёт количество присвоенных значений. Необязательные аргументы должны быть переданы по ссылке.
Пример #1 Пример использования функции fscanf()
<?php
$handle = fopen("users.txt", "r");
while ($userinfo = fscanf($handle, "%s\t%s\t%s\n")) {
list ($name, $profession, $countrycode) = $userinfo;
//... совершаем какие-либо действия над значениями
}
fclose($handle);
?>
Пример #2 Содержимое файла users.txt
javier argonaut pe hiroshi sculptor jp robert slacker us luigi florist it