International PHP Conference Berlin 2025

fscanf

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

fscanfОбрабатывает данные из файла по условиям формата

Описание

fscanf(resource $stream, string $format, mixed &...$vars): array|int|false|null

Функция fscanf() аналогична функции sscanf(), но берёт входные данные из файла, который связан с потоком stream, и интерпретирует входные данные по условиям формата format.

Любой пробельный символ в строке формата эквивалентен любому пробельному символу во входящем потоке. Это означает, что даже символ табуляции (\t) в строке формата может соответствовать одному символу пробела в потоке входных данных.

Каждый вызов функции fscanf() считывает одну строку из файла.

Список параметров

stream

Ресурс (resource) указателя файловой системы, который обычно создают функцией fopen().

format

Формат интерпретации строки string, который описывает документация к функции sprintf() со следующими отличиями:

  • Функция не учитывает языковые настройки.
  • Параметр не поддерживает флаги F, g, G и b.
  • Флаг D обозначает десятичное число.
  • Флаг i обозначает целое число с определением системы счисления.
  • Флаг n обозначает количество символов, которые функция уже обработала.
  • Флаг s останавливает чтение при любом пробельном символе.
  • Символ * вместо спецификатора преобразования argnum$ подавляет присваивание этого спецификатора преобразования.

vars

Необязательные переменные, которым функция присвоит значения.

Возвращаемые значения

Функция возвращает массив с результатами разбора, если в функцию передали только два аргумента. Функция вернёт количество присвоенных значений, если передали необязательные аргументы. Необязательные аргументы требуется передавать по ссылке.

Если параметр format ожидает больше подстрок, чем доступно в параметре string, вернётся значение null. Функци вернёт false, если возникнут другие ошибки.

Примеры

Пример #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

Смотрите также

  • fread() - Читает файл в бинарно-безопасном режиме: как последовательность байтов
  • fgets() - Получает строку из указателя на файл
  • fgetss() - Читает строку из файла и удаляет HTML-теги
  • sscanf() - Разбирает строку по условиям формата
  • printf() - Выводит отформатированную строку
  • sprintf() - Возвращает отформатированную строку

Добавить

Примечания пользователей 7 notes

up
18
yasuo_ohgaki at hotmail dot com
23 years ago
For C/C++ programmers.

fscanf() does not work like C/C++, because PHP's fscanf() move file pointer the next line implicitly.
up
7
Bertrand dot Lecun at prism dot uvsq dot Fr
17 years ago
It would be great to precise in the fscanf documentation
that one call to the function, reads a complete line.
and not just the number of values defined in the format.

If a text file contains 2 lines each containing 4 integer values,
reading the file with 8 fscanf($fd,"%d",$v) doesnt run !
You have to make 2
fscanf($fd,"%d %d %d %d",$v1,$v2,$v3,$v4);

Then 1 fscanf per line.
up
2
eugene at pro-access dot com
22 years ago
If you want to read text files in csv format or the like(no matter what character the fields are separated with), you should use fgetcsv() instead. When a text for a field is blank, fscanf() may skip it and fill it with the next text, whereas fgetcsv() correctly regards it as a blank field.
up
1
worldwideroach at hotmail dot com
19 years ago
Yet another function to read a file and return a record/string by a delimiter. It is very much like fgets() with the delimiter being an additional parameter. Works great across multiple lines.

function fgetd(&$rFile, $sDelim, $iBuffer=1024) {
$sRecord = '';
while(!feof($rFile)) {
$iPos = strpos($sRecord, $sDelim);
if ($iPos === false) {
$sRecord .= fread($rFile, $iBuffer);
} else {
fseek($rFile, 0-strlen($sRecord)+$iPos+strlen($sDelim), SEEK_CUR);
return substr($sRecord, 0, $iPos);
}
}
return false;
}
up
-1
nico at nicoswd dot com
11 years ago
If you want to parse a cron file, you may use this pattern:

<?php

while ($cron = fscanf($fp, "%s %s %s %s %s %[^\n]s"))
{

}

?>
up
-2
loco.xxx at gmail dot com
18 years ago
to include all type of visible chars you should try:

<?php fscanf($file_handler,"%[ -~]"); ?>
up
-3
robert at NOSPAM dot NOSPAM
22 years ago
actually, instead of trying to think of every character that might be in your file, excluding the delimiter would be much easier.

for example, if your delimiter was a comma use:

%[^,]

instead of:

%[a-zA-Z0-9.| ... ]

Just make sure to use %[^,\n] on your last entry so you don't include the newline.
To Top