ProfiPHPProfiPHP
Категория: Функции для работы с файловой системой

Функция File_get_contents

Функция File_get_contents читает содержимое файла в строку.
string file_get_contents( string $filename [, bool $use_include_path = false [, resource $context [, int $offset = 0 [, int $maxlen ]]]] )
Функция File_get_contents похожа на функцию File с той только разницей, что функция File_get_contents возвращает содержимое файла в строке, начиная с указанного смещения Offset и до Maxlen байт. В случае неудачи, функция File_get_contents вернет FALSE.

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

В параметре Filename указывается имя читаемого файла.

В параметре Use_include_path можно указать константу FILE_USE_INCLUDE_PATH, которая разрешает поиск файла в Include path.

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

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

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

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

Функция File_get_contents возвращает прочтенные данные или FALSE в случае возникновения ошибки. Также может возвращать как boolean FALSE, так и не-boolean значение, которое приводится к FALSE. Используйте оператор "===" для проверки значения, возвращаемого этой функцией.

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

Пример использования:
$file = file_get_contents( 'file.txt' )
$file = file_get_contents( 'file.txt', false, NULL, 0, 5 );
Функция File_get_contents может использовать URL в качестве имени файла, если была включена опция Allow_url_fopen. Смотрите более подробную информацию об определении имени файла в описании функции Fopen.

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

Имя:
Текст комментария: