file-get-contents.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: ea62fb83196997032641b50fe44420305466195e Maintainer: shein Status: ready -->
<!-- Reviewed: no -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.file-get-contents" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>file_get_contents</refname>
  <refpurpose>Читает содержимое файла в строку</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>file_get_contents</methodname>
   <methodparam><type>string</type><parameter>filename</parameter></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>use_include_path</parameter><initializer>&false;</initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>resource</type><type>null</type></type><parameter>context</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>offset</parameter><initializer>0</initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>length</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Функция похожа на функцию <function>file</function>, за исключением того,
   что функция <function>file_get_contents</function> возвращает
   содержимое файла в строке длиной <parameter>length</parameter>
   байтов со смещения <parameter>offset</parameter>.
   В случае неудачи функция <function>file_get_contents</function> вернёт &false;.
  </para>
  <para>
   Вызов функции <function>file_get_contents</function>
   наиболее предпочтителен, когда требуется получить
   содержимое файла целиком, поскольку для улучшения производительности
   функция использует технику отображения файла в памяти
   (memory mapping), если операционная система её поддерживает.
  </para>
  <note>
   <para>
    Если открывается URI, который содержит спецсимволы наподобие пробела,
    нужно закодировать URI функцией <function>urlencode</function>.
   </para>
  </note>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>filename</parameter></term>
     <listitem>
      <para>
       Имя читаемого файла.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>use_include_path</parameter></term>
     <listitem>
      <note>
       <para>
        Разрешается указывать константу
        <constant>FILE_USE_INCLUDE_PATH</constant> для поиска файла
        в списке путей <link linkend="ini.include-path">include path</link>.
        Обратите внимание, в коде <link
        linkend="language.types.declarations.strict">со строгой типизацией</link>
        так сделать не получится, потому что
        значение константы <constant>FILE_USE_INCLUDE_PATH</constant> принадлежит типу <type>int</type>.
        Тогда лучше задать &true;.
       </para>
      </note>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>context</parameter></term>
     <listitem>
      <para>
       Корректный ресурс контекста, который возвращает функция
       <function>stream_context_create</function>.
       Чтобы пропустить параметр, в него передают значение &null;,
       когда особый контекст не нужен.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>offset</parameter></term>
     <listitem>
      <para>
       Смещение, с которого начнётся чтение оригинального потока.
       Отрицательное значение смещения будет отсчитываться с конца потока.
      </para>
      <para>
       Поиск смещения (<parameter>offset</parameter>) не поддерживается при
       работе с удалёнными файлами. Попытка поиска смещения на нелокальных
       файлах может работать при небольших смещениях, но результат будет
       непредсказуемым, так как функция работает на буферизованном потоке.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>length</parameter></term>
     <listitem>
      <para>
       Максимальный размер читаемых данных. По умолчанию чтение
       осуществляется пока не будет достигнут конец файла. Учтите, что
       этот параметр применяется и к потоку с фильтрами.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Функция возвращает прочтённые данные&return.falseforfailure;.
  </para>
  &return.falseproblem;
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Функция выдаёт ошибку уровня <constant>E_WARNING</constant>,
   если не получится найти файл <parameter>filename</parameter>, для параметра <parameter>length</parameter>
   задали значение меньше нуля или поиск по смещению <parameter>offset</parameter> в потоке
   завершится неудачно.
  </para>
  <para>
   Когда функция <function>file_get_contents</function> вызывается для каталога,
   в ОС Windows генерируется ошибка уровня <constant>E_WARNING</constant>,
   а с PHP 7.4 и в других операционных системах.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>8.0.0</entry>
       <entry>
        Параметр <parameter>length</parameter> теперь принимает значение &null;.
       </entry>
      </row>
      <row>
       <entry>7.1.0</entry>
       <entry>
        Добавили поддержку отрицательных значений для смещения <parameter>offset</parameter>.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Пример получения и вывода исходного кода домашней страницы сайта</title>
    <programlisting role="php">
<![CDATA[
<?php

$homepage = file_get_contents('http://www.example.com/');
echo $homepage;

?>
]]>
    </programlisting>
   </example>
   <example>
    <title>Поиск файлов в include_path</title>
    <programlisting role="php">
<![CDATA[
<?php

// Если включили строгую типизацию, то есть объявили (strict_types=1);
$file = file_get_contents('./people.txt', true);

// Иначе
$file = file_get_contents('./people.txt', FILE_USE_INCLUDE_PATH);

?>
]]>
    </programlisting>
   </example>
   <example>
    <title>Чтение секции файла</title>
    <programlisting role="php">
<![CDATA[
<?php

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

var_dump($section);

?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
string(14) "lle Bjori Ro"
]]>
    </screen>
   </example>
   <example>
    <title>Работа функции с потоковыми контекстами</title>
    <programlisting role="php">
<![CDATA[
<?php

// Создаём поток
$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);

?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  &note.bin-safe;
  &tip.fopen-wrapper;
  &warn.ssl-non-standard;
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>file</function></member>
    <member><function>fgets</function></member>
    <member><function>fread</function></member>
    <member><function>readfile</function></member>
    <member><function>file_put_contents</function></member>
    <member><function>stream_get_contents</function></member>
    <member><function>stream_context_create</function></member>
    <member><link linkend="reserved.variables.httpresponseheader">$http_response_header</link></member>
   </simplelist>
  </para>
 </refsect1>

</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->