Как прочитать файл php
Перейти к содержимому

Как прочитать файл php

  • автор:

Работа с файловой системой

Как и большинство языков программирования, PHP поддерживает работу с файлами, которые являются одним из способов хранения информации.

Чтение и запись файлов

Открытие и закрытие файлов

Для открытия файлов в PHP определена функция fopen() . Она имеет следующее определение: resource fopen(string $filename, string $mode) . Первый параметр $filename представляет путь к файлу, а второй — режим открытия. В зависимости от цели открытия и типа файла данный параметр может принимать следующие значения:

  • ‘r’ : файл открывается только для чтения. Если файла не существует, возвращает false
  • ‘r+’ : файл открывается только для чтения с возможностью записи. Если файла не существует, возвращает false
  • ‘w’ : файл открывается для записи. Если такой файл уже существует, то он перезаписывается, если нет — то он создается
  • ‘w+’ : файл открывается для записи с возможностью чтения. Если такой файл уже существует, то он перезаписывается, если нет — то он создается
  • ‘a’ : файл открывается для записи. Если такой файл уже существует, то данные записываются в конец файла, а старые данные остаются. Если файл не существует, то он создается
  • ‘a+’ : файл открывается для чтения и записи. Если файл уже существует, то данные дозаписываются в конец файла. Если файла нет, то он создается

Результатом функции fopen будет дескриптор файла. Этот дескриптор используется для операций с файлом и для его закрытия.

После окончания работы файл надо закрыть с помощью функции fclose() , которая принимает в качестве параметра дескриптор файла. Например, откроем и закроем файл:

$fd = fopen("form.php", 'r') or die("не удалось открыть файл"); fclose($fd);

Конструкция or die(«текст ошибки») позволяет прекратить работу скрипта и вывесте некоторое сообщение об ошибке, если функция fopen не смогла открыть файл.

Чтение файла

Для чтения файла можно использовать несколько функций. Для построчного чтения используется функция fgets() , которая получает дескриптор файла и возвращает одну считанную строку. Пройдем построчно по всему файлу:

 fclose($fd); ?>

При каждом вызове fgets() PHP будет помещать указатель в конец считанной строки. Чтобы проследить окончание файла, используется функция feof() , которая возвращает true при завершении файла. И пока не будет достигнут конец файла, мы можем применять функцию fgets().

Чтение файла полностью

Если нам надо прочитать файл полностью, то мы можем облегчить себе жизнь, применив функцию file_get_contents() :

При этом нам не надо открывать явно файл, получать дескриптор, а затем закрывать файл.

Поблочное считывание

Также можно провести поблочное считывание, то есть считывать определенное количество байт из файла с помощью функции fread() :

 fclose($fd); ?>

Функция fread() принимает два параметра: дескриптор считываемого файла и количество считываемых байтов. При считывании блока указатель в файле становится в конец этого блока. И также с помощью функции feof() можно отследить завершение файла.

Запись файла

Для записи файла применяется функция fwrite() , которая записывает в файл строку:

Аналогично работает другая функция fputs() :

Работа с указателем файла

При открытии файла для чтения или записи в режиме ‘w’, указатель в файле помещается в начало. При считывании данных PHP перемещает указатель в файле в конец блока считанных данных. Однако мы также вручную можем управлять указателем в файле и устанавливать его в произвольное место. Для этого надо использовать функцию fseek, которая имеет следующее формальное определение:

int fseek (resource $handle , int $offset [, int $whence = SEEK_SET ] )

Параметр $handle представляет дескриптор файла. Параметр $offset — смещение в байтах относительно начала файла, с которого начнется считывание/запись. Третий необязательный параметр задает способ установки смещения. Он может принимать три значения:

  • SEEK_SET : значение по умолчанию, устанавливает смещение в offset байт относительно начала файла
  • SEEK_CUR : устанавливает смещение в offset байт относительно начала текущей позиции в файле
  • SEEK_END : устанавливает смещение в offset байт от конца файла

В случае удачной установки указателя функция fseek() возвращает 0, а при неудачной установке возвращает -1.

Пример использования функции:

$fd = fopen("hello.txt", 'w+') or die("не удалось открыть файл"); $str = "Привет мир!"; // строка для записи fwrite($fd, $str); // запишем строку в начало fseek($fd, 0); // поместим указатель файла в начало fwrite($fd, "Хрю"); // запишем в начало строку fseek($fd, 0, SEEK_END); // поместим указатель в конец fwrite($fd, $str); // запишем в конце еще одну строку fclose($fd);

Как прочитать файл в php массив

При необходимости можно разбить содержимое файла построчно, тогда получится массив строк.

 $content = file_get_contents('./example.txt'); $lines = explode("\n", $content); print_r($lines); # => Array # => ( # . Здесь вывод данных. Каждая строчка - элемент массива # => ) 

Вариант с функцией file(). Файл будет прочитан построчно, строки файла будут сохранены в массив

 $lines = file('./example.txt', FILE_IGNORE_NEW_LINES); print_r($lines); # => Array # => ( # . Здесь вывод данных. Каждая строчка - элемент массива # => ) 

file

Замечание:

Можно также использовать функцию file_get_contents() для получения файла в виде строки.

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

Подсказка

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

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

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

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

Замечание:

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

Замечание: Если у вас возникают проблемы с распознаванием PHP концов строк при чтении или создании файлов на Macintosh-совместимом компьютере, включение опции auto_detect_line_endings может помочь решить проблему.

Ошибки

Вызывает ошибку уровня E_WARNING , если файл не существует.

Примеры

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

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

// Осуществим проход массива и выведем содержимое в виде HTML-кода вместе с номерами строк.
foreach ( $lines as $line_num => $line ) echo «Строка # : » . htmlspecialchars ( $line ) . «
\n» ;
>

// Используем необязательный параметр flags
$trimmed = file ( ‘somefile.txt’ , FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES );
?>

Примечания

Внимание

При использовании SSL, Microsoft 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() — Создаёт контекст потока

User Contributed Notes 15 notes

9 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).

2 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.

10 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:
$names = file ( ‘name.txt’ );
// To check the number of lines
echo count ( $names ). ‘
‘ ;
foreach( $names as $name )
echo $name . ‘
‘ ;
>
?>

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

14 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. «\\»:

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

foreach( $lines as $line )
echo( $line );
>

hope this helps.

12 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)

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 ++;
>
>

?>

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)

// —— view ——
echo «

\r\n" ; 
print_r ( $csvdata );
echo "

\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

5 years ago
My experience is that the function file does uses the cached content if the file has changed.
4 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);

16 years ago

This note applies to PHP 5.1.6 under Windows (although may apply to other versions).

It appears that the ‘FILE_IGNORE_NEW_LINES’ flag doesn’t remove newlines properly when reading Windows-style text files, i.e. files whose lines end in ‘\r\n’.

Solution: Always use ‘rtrim()’ in preference to ‘FILE_IGNORE_NEW_LINES’.

20 years ago

Note: Now that file() is binary safe it is ‘much’ slower than it used to be. If you are planning to read large files it may be worth your while using fgets() instead of file() For example:

$fd = fopen ( «log_file.txt» , «r» );
while (! feof ( $fd ))
<
$buffer = fgets ( $fd , 4096 );
$lines [] = $buffer ;
>
fclose ( $fd );
?>

The resulting array is $lines.

I did a test on a 200,000 line file. It took seconds with fgets() compared to minutes with file().

9 years ago

(«file()’s problem with UTF-16» is wrong. This is updated.
The former may miss the last line of the string.)

file() seems to have a problem in handling
UTF-16 with or without BOM.

file() is likely to think «\n»=LF (0A) as a line-ending.
So, not only «000A» but also «010A, 020A. FE0A, FF0A. «
are regarded as line-endings.

Moreover, file() causes a serious problem in UTF-16LE.
file() loses first «0A» (the first half of «0A00»)!
And the next line begins with «00» (the rest of «0A00»).
So lines after the first «0A» are totally different.

To avoid this phenomena,
eg. in case (php_script : UTF-8 , file : UTF-16 with line-ending «\r\n»),

mb_regex_encoding ( ‘UTF-16’ ); // to help mb_ereg_..() work properly
$str = file_get_contents ( $file_path );
$to_encoding = ‘UTF-16’ ; // encoding of string
$from_encoding = ‘UTF-8’ ; // encoding of PHP_script
$pattern1 = mb_convert_encoding ( ‘[^\r]*\r\n’ , $to_encoding , $from_encoding );
mb_ereg_search_init ( $str , $pattern1 );
while ( $res = mb_ereg_search_regs ()) $file [] = $res [ 0 ];
>
$pattern2 = mb_convert_encoding ( ‘\A.*\r\n(.*)\z’ , $to_encoding , $from_encoding );
mb_ereg ( $pattern2 , $str , $match );
$file [] = $match [ 1 ];

?>

instead of
$file = file($file_path);

If line-ending is «\n»,
$pattern1 = mb_convert_encoding(‘[^\n]*\n’, $to_encoding, $from_encoding);

15 years ago

A user suggested using rtrim always, due to the line ending conflict with files that have an EOL that differs from the server EOL.

Using rtrim with it’s default character replacement is a bad solution though, as it removes all whitespace in addition to the ‘\r’ and ‘\n’ characters.

A good solution using rtrim follows:

$line = rtrim ( $line , «\r\n» ) . PHP_EOL ;
?>

This removes only EOL characters, and replaces with the server’s EOL character, thus making preg_* work fine when matching the EOL ($)

15 years ago

If you’re getting «failed to open stream: Permission denied» when trying to use either file() or fopen() to access files on another server. Check your host doesn’t have any firewall restrictions in-place which prevent outbound connections. This is the case with my host Aplus.net

6 years ago

Using if ( file(name.txt) ) might not be enough for testing if the file was successfully opened for reading because the file could be empty in which case the array returned is empty, so test instead with !==. e.g.:

$file_array = file(‘test.txt’); // an empty file

echo »;
if ( $file_array ) # code.
echo «success\n»;
> else # code.
echo «failure\n»; // executed
>

if ( $file_array !== false ) # code.
echo «success\n»; // executed
> else # code.
echo «failure\n»;
>
echo ‘‘;

9 years ago

Here’s my CSV converter
supports Header and trims all fields
Note: Headers must be not empty!

function csv2array ( $file , $delim = ‘;’ , $encl = ‘»‘ , $header = false )

# File does not exist
if(! file_exists ( $file ))
return false ;

# Read lines of file to array
$file_lines = file ( $file , FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES );

# Empty file
if( $file_lines === array())
return NULL ;

# Read headers if you want to
if( $header === true ) $line_header = array_shift ( $file_lines );
$array_header = array_map ( ‘trim’ , str_getcsv ( $line_header , $delim , $encl ));
>

# Now line per line (strings)
foreach ( $file_lines as $line ) # Skip empty lines
if( trim ( $line ) === » )
continue;

# Convert line to array
$array_fields = array_map ( ‘trim’ , str_getcsv ( $line , $delim , $encl ));

# If header present, combine header and fields as key => value
if( $header === true )
$out [] = array_combine ( $array_header , $array_fields );
else
$out [] = $array_fields ;
>

16 years ago

Using file() for reading large text files > 10 Mb gives problems, therefore you should use this instead. It is much slower but it works fine. $lines will return an array with all the lines.

$handle = @ fopen ( ‘yourfile. ‘ , «r» );
if ( $handle ) <
while (! feof ( $handle )) <
$lines [] = fgets ( $handle , 4096 );
>
fclose ( $handle );
>
?>

  • Copyright © 2001-2023 The PHP Group
  • My PHP.net
  • Contact
  • Other PHP.net sites
  • Privacy policy

file_get_contents

Данная функция похожа на функцию file() с той лишь разницей, что file_get_contents() возвращает содержимое файла в строке, начиная с указанного смещения offset и до length байт. В случае неудачи, file_get_contents() вернёт false .

Использование функции file_get_contents() наиболее предпочтительно в случае необходимости получить содержимое файла целиком, поскольку для улучшения производительности функция использует технику отображения файла в память (memory mapping), если она поддерживается вашей операционной системой.

Замечание:

Если вы открываете URI, содержащий спецсимволы, такие как пробел, вам нужно закодировать URI при помощи urlencode() .

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

Имя читаемого файла.

Замечание:

Можно использовать константу FILE_USE_INCLUDE_PATH для поиска файла в include path. Только помните, что если вы используете строгую типизацию, то так сделать не получится, поскольку FILE_USE_INCLUDE_PATH имеет тип int . В таком случае используйте true .

Корректный ресурс контекста, созданный с помощью функции stream_context_create() . Если в использовании особого контекста нет необходимости, можно пропустить этот параметр передав в него значение null .

Смещение, с которого начнётся чтение оригинального потока. Отрицательное значение смещения будет отсчитываться с конца потока.

Поиск смещения ( offset ) не поддерживается при работе с удалёнными файлами. Попытка поиска смещения на нелокальных файлах может работать при небольших смещениях, но результат будет непредсказуемым, так как функция работает на буферизованном потоке.

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

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

Функция возвращает прочтённые данные или false в случае возникновения ошибки.

Внимание

Эта функция может возвращать как логическое значение false , так и значение не типа boolean, которое приводится к false . За более подробной информацией обратитесь к разделу Булев тип. Используйте оператор === для проверки значения, возвращаемого этой функцией.

Ошибки

Будет сгенерирована ошибка уровня E_WARNING в случаях, если не удастся найти filename , задан length меньше нуля, или поиск по смещению offset в потоке завершится неудачно.

Когда file_get_contents() вызывается в каталоге, в Windows ошибка генерируется E_WARNING , а с PHP 7.4 также в других операционных системах.

Список изменений

Версия Описание
8.0.0 Параметр length теперь допускает значение null .
7.1.0 Добавлена поддержка отрицательных значений offset .

Примеры

Пример #1 Получить и вывести исходный код домашней страницы сайта

$homepage = file_get_contents ( ‘http://www.example.com/’ );
echo $homepage ;
?>

Пример #2 Поиск файлов в include_path

// Если включены строгие типы, то есть объявлено (strict_types=1);
$file = file_get_contents ( ‘./people.txt’ , true );
// Иначе
$file = file_get_contents ( ‘./people.txt’ , FILE_USE_INCLUDE_PATH );
?>

Пример #3 Чтение секции файла

// Читаем 14 символов, начиная с 21 символа
$section = file_get_contents ( ‘./people.txt’ , FALSE , NULL , 20 , 14 );
var_dump ( $section );
?>

Результатом выполнения данного примера будет что-то подобное:

string(14) "lle Bjori Ro"

Пример #4 Использование потоковых контекстов

// Создаём поток
$opts = array(
‘http’ =>array(
‘method’ => «GET» ,
‘header’ => «Accept-language: en\r\n» .
«Cookie: foo=bar\r\n»
)
);

$context = stream_context_create ( $opts );

// Открываем файл с помощью установленных выше HTTP-заголовков
$file = file_get_contents ( ‘http://www.example.com/’ , false , $context );
?>

Примечания

Замечание: Эта функция безопасна для обработки данных в двоичной форме.

Подсказка

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

Внимание

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

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

  • file() — Читает содержимое файла и помещает его в массив
  • fgets() — Читает строку из файла
  • fread() — Бинарно-безопасное чтение файла
  • readfile() — Выводит файл
  • file_put_contents() — Пишет данные в файл
  • stream_get_contents() — Читает оставшуюся часть потока в строку
  • stream_context_create() — Создаёт контекст потока
  • $http_response_header

Добавить комментарий

Ваш адрес email не будет опубликован. Обязательные поля помечены *