file

(PHP 4, PHP 5, PHP 7, PHP 8)

fileЧитает содержимое файла и помещает его в массив

Описание

file(string $filename, int $flags = 0, ?resource $context = null): array|false

Функция читает содержимое файла и помещает его в массив.

Замечание:

Файл в виде строки также возвращает функция file_get_contents().

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

filename

Путь к файлу.

Подсказка

В эту функцию в качестве имени файла можно передавать URL-адреса, если была включена директива fopen wrappers. Подробнее о том, как указать имя файла, рассказано в описании функции fopen(). В разделе «Протоколы и обёртки» также даны ссылки на информацию о способностях поддерживаемых обёрток, замечания по работе с ними и список предопределённых переменных, которые они дают.

flags

Необязательный параметр flags принимает константу из следующего списка:

FILE_USE_INCLUDE_PATH
Искать файл в списке путей директивы include_path.
FILE_IGNORE_NEW_LINES
Пропускать новую строку в конце каждого элемента массива.
FILE_SKIP_EMPTY_LINES
Пропускать пустые строки.
FILE_NO_DEFAULT_CONTEXT
Не использовать контекст по умолчанию.

context

Ресурс (resource) контекста потока.

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

Функция возвращает файл в виде массива. Каждый элемент массива соответствует строке файла, с символами новой строки включительно. Функция file() возвращает false, если возникла ошибка.

Замечание:

Каждая строка в массиве будет завершаться символами конца строки, если только не указали флаг FILE_IGNORE_NEW_LINES).

Замечание: Включение опции auto_detect_line_endings во время выполнения иногда помогает исправить неправильное распознавание языком PHP концов строк при чтении файлов на Macintosh-совместимом компьютере или файлов, которые создали на Макинтоше.

Ошибки

Функция выдаёт ошибку уровня E_WARNING, если файл не существует.

Примеры

Пример #1 Пример использования функции file()

<?php

// Получаем содержимое файла в виде массива. Обращаемся
// по HTTP-протоколу, чтобы получить HTML-код с удалённого сервера
$lines = file('http://www.example.com/');

// Обходим элементы массива и выводим содержимое как HTML-код с номерами строк
foreach ($lines as $line_num => $line) {
echo
"Строка #<b>{$line_num}</b> : " . htmlspecialchars($line) . "<br />\n";
}

// Передаём необязательный параметр flags
$trimmed = file('somefile.txt', FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES);

?>

Примечания

Внимание

При работе с сервером Microsoft IIS по SSL-протоколу разработчик сталкивается с тем, что IIS-сервер нарушает протокол путём закрытия соединения без отправки индикатора close_notify. PHP выдаст ошибку в виде сообщения «SSL: Fatal Protocol Error» при достижении конца данных. Чтобы избежать такого поведения, значение директивы error_reporting снижают до уровня, который не включает предупреждений уровня E_WARNING. PHP умеет обнаруживать ошибочное программное обеспечение IIS-сервера при открытии потока через обёртку https://, и подавляет предупреждение. За обнаружение и подавление предупреждения отвечает разработчик, который вызывает функцию fsockopen(), чтобы создать сокет ssl://.

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

  • file_get_contents() - Считывает содержимое файла в строку
  • readfile() - Выводит файл
  • fopen() - Открывает файл или URL-адрес
  • fsockopen() - Открывает соединение с сокетом интернет- или Unix-домена
  • popen() - Открывает файловый указатель процесса
  • include - include
  • stream_context_create() - Создаёт контекст потока

Добавить

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

up
32
Martin K.
10 years ago
If the file you are reading is in CSV format do not use file(), use fgetcsv(). file() will split the file by each newline that it finds, even newlines that appear within a field (i.e. within quotations).
up
22
bingo at dingo dot com
11 years ago
To write all the lines of the file in other words to read the file line by line you can write the code like this:
<?php
$names
=file('name.txt');
// To check the number of lines
echo count($names).'<br>';
foreach(
$names as $name)
{
echo
$name.'<br>';
}
?>

this example is so basic to understand how it's working. I hope it will help many beginners.

Regards,
Bingo
up
15
d basin
15 years ago
this may be obvious, but it took me a while to figure out what I was doing wrong. So I wanted to share. I have a file on my "c:\" drive. How do I file() it?

Don't forget the backslash is special and you have to "escape" the backslash i.e. "\\":

<?php

$lines
= file("C:\\Documents and Settings\\myfile.txt");

foreach(
$lines as $line)
{
echo(
$line);
}

?>

hope this helps...
up
9
twichi at web dot de
13 years ago
read from CSV data (file) into an array with named keys

... with or without 1st row = header (keys)
(see 4th parameter of function call as true / false)

<?php
// --------------------------------------------------------------

function csv_in_array($url,$delm=";",$encl="\"",$head=false) {

$csvxrow = file($url); // ---- csv rows to array ----

$csvxrow[0] = chop($csvxrow[0]);
$csvxrow[0] = str_replace($encl,'',$csvxrow[0]);
$keydata = explode($delm,$csvxrow[0]);
$keynumb = count($keydata);

if (
$head === true) {
$anzdata = count($csvxrow);
$z=0;
for(
$x=1; $x<$anzdata; $x++) {
$csvxrow[$x] = chop($csvxrow[$x]);
$csvxrow[$x] = str_replace($encl,'',$csvxrow[$x]);
$csv_data[$x] = explode($delm,$csvxrow[$x]);
$i=0;
foreach(
$keydata as $key) {
$out[$z][$key] = $csv_data[$x][$i];
$i++;
}
$z++;
}
}
else {
$i=0;
foreach(
$csvxrow as $item) {
$item = chop($item);
$item = str_replace($encl,'',$item);
$csv_data = explode($delm,$item);
for (
$y=0; $y<$keynumb; $y++) {
$out[$i][$y] = $csv_data[$y];
}
$i++;
}
}

return
$out;
}

// --------------------------------------------------------------

?>

fuction call with 4 parameters:

(1) = the file with CSV data (url / string)
(2) = colum delimiter (e.g: ; or | or , ...)
(3) = values enclosed by (e.g: ' or " or ^ or ...)
(4) = with or without 1st row = head (true/false)

<?php

// ----- call ------
$csvdata = csv_in_array( $yourcsvfile, ";", "\"", true );
// -----------------

// ----- view ------
echo "<pre>\r\n";
print_r($csvdata);
echo
"</pre>\r\n";
// -----------------

?>

PS: also see: http://php.net/manual/de/function.fgetcsv.php to read CSV data into an array
... and other file-handling methods

^
up
0
radler63 at hotmail dot com
6 years ago
My experience is that the function file does uses the cached content if the file has changed....
up
-2
renanlazarotto at gmail dot com
3 years ago
Be aware that using file() to count lines can cause OOM on the server as it'll allocate all lines into an array.

If you're dealing with files that can have thousands of lines, SplFileObject might be a better idea and with little changes you can get the same result.
up
-5
sheldon at hyperlinked dot com
5 years ago
As of PHP 5.6 the file(), file_get_contents(), and fopen() functions will return false if you are referencing a source URL that doesn't have a valid SSL certificate. Presumably, you will run into this a lot in your development environments this will drive you crazy.

You will need to create a stream context and provide it as an argument to the various file operations to tell it to ignore invalid SSL credentials.

$args = array("ssl"=>array("verify_peer"=>false,"verify_peer_name"=>false),"http"=>array('timeout' => 60, 'user_agent' => 'Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.8.1.9) Gecko/20071025 Firefox/3.0.0.1'));

$context = stream_context_create($args);
$httpfile = file($url, false, $context);
To Top