php-doc-ru/reference/filesystem/functions/file.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 84b8fca68fc762fefe85acde180a38b2e77a28b9 Maintainer: shein Status: ready -->
<!-- Reviewed: yes -->
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.file">
 <refnamediv>
  <refname>file</refname>
  <refpurpose>Читает содержимое файла и помещает его в массив</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>file</methodname>
   <methodparam><type>string</type><parameter>filename</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
   <methodparam choice="opt"><type>resource</type><parameter>context</parameter></methodparam>
  </methodsynopsis>
  <para>
   Читает содержимое файла и помещает его в массив.
  </para>
  <note>
   <para>
    Можно также использовать функцию <function>file_get_contents</function>
    для получения файла в виде строки.
   </para>
  </note>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>filename</parameter></term>
     <listitem>
      <para>
       Путь к файлу.
      </para>
      &tip.fopen-wrapper;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       В качестве необязательного параметра <parameter>flags</parameter> может
       можно указать одну или более следующих констант:
       <variablelist>
        <varlistentry>
         <term>
          <constant>FILE_USE_INCLUDE_PATH</constant>
         </term>
         <listitem>
          <simpara>
           Ищет файл в <link
           linkend="ini.include-path">include_path</link>.
          </simpara>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term>
          <constant>FILE_IGNORE_NEW_LINES</constant>
         </term>
         <listitem>
          <simpara>
           Не добавлять новую строку к концу каждого элемента массива
          </simpara>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term>
          <constant>FILE_SKIP_EMPTY_LINES</constant>
         </term>
         <listitem>
          <simpara>
           Пропускать пустые строки
          </simpara>
         </listitem>
        </varlistentry>
        <!-- FIXME PHP_6
        <varlistentry>
         <term>
          <constant>FILE_TEXT</constant>
         </term>
         <listitem>
          <simpara>
           The content is returned in UTF-8 encoding. You can specify a different
           encoding by creating a custom context. This flag cannot be used with
           <constant>FILE_BINARY</constant>.
          </simpara>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term>
          <constant>FILE_BINARY</constant>
         </term>
         <listitem>
          <simpara>
           The content is read as binary data. This is the default setting
           and cannot be used with <constant>FILE_TEXT</constant>.
          </simpara>
         </listitem>
        </varlistentry>
        -->
       </variablelist>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>context</parameter></term>
     <listitem>
      <para>
       Ресурс контекста, созданный функцией
       <function>stream_context_create</function>.
      </para>
      <para>
       &note.context-support;
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Возвращает файл в виде массива. Каждый элемент массива соответствует
   строке файла, с символами новой строки включительно. В случае
   ошибки <function>file</function> возвращает &false;.
  </para>
  <note>
   <para>
    Каждая строка в полученном массиве будет завершаться символами конца
    строки (если вы не указали флаг <constant>FILE_IGNORE_NEW_LINES</constant>),
    поэтому, если вам будет нужно избавиться от этих символов, вы
    можете использовать функцию <function>rtrim</function>.
   </para>
  </note>
  &note.line-endings;
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <!-- FIXME PHP_6
      <row>
       <entry>6.0.0</entry>
       <entry>
        Added support for the <constant>FILE_TEXT</constant> and
        <constant>FILE_BINARY</constant> flags.
        <note>
         <para>
          For <literal>forward compatibility</literal>, these constants are
          available as of PHP 5.2.7
         </para>
        </note>
       </entry>
      </row>
       -->
      <row>
       <entry>5.0.0</entry>
       <entry>
        Добавлен параметр <parameter>context</parameter>
       </entry>
      </row>
      <row>
       <entry>5.0.0</entry>
       <entry>
        До версии PHP 5.0.0 параметр <parameter>flags</parameter>
        использовал только <link linkend="ini.include-path">include_path</link>
        и для его включения необходимо было передать 1
       </entry>
      </row>
      <row>
       <entry>4.3.0</entry>
       <entry>
        <function>file</function> стала безопасной для обработки
        бинарных данных
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Пример использования <function>file</function></title>
    <programlisting role="php">
<![CDATA[
<?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";
}

// Второй пример. Получим содержание web-страницы в виде одной строки.
// См.также описание функции file_get_contents().
$html = implode('', file('http://www.example.com/'));

// Используем необязательный параметр flags (начиная с PHP 5)
$trimmed = file('somefile.txt', FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  &warn.ssl-non-standard;
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>readfile</function></member>
    <member><function>fopen</function></member>
    <member><function>fsockopen</function></member>
    <member><function>popen</function></member>
    <member><function>file_get_contents</function></member>
    <member><function>include</function></member>
    <member><function>stream_context_create</function></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
-->