fgetcsv.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 781f2ec04ee8817687e5e333bc3e64ab973322d7 Maintainer: shein Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.fgetcsv" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>fgetcsv</refname>
  <refpurpose>Получает строку из файлового указателя и разбирает по CSV-полям</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>array</type><type>false</type></type><methodname>fgetcsv</methodname>
   <methodparam><type>resource</type><parameter>stream</parameter></methodparam>
   <methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>length</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>separator</parameter><initializer>","</initializer></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>enclosure</parameter><initializer>"\""</initializer></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>escape</parameter><initializer>"\\"</initializer></methodparam>
  </methodsynopsis>
  <para>
   Функция похожа на функцию <function>fgets</function>, за исключением того,
   что функция <function>fgetcsv</function> анализирует строку на наличие полей
   в формате <acronym>CSV</acronym> и возвращает массив с прочитанными полями.
  </para>
  <note>
   <simpara>
    Функция учитывает региональный настройки. Поэтому функция иногда неправильно разбирает
    данные в отдельных однобайтовых кодировках, если значение константы
    <constant>LC_CTYPE</constant> равно <literal>en_US.UTF-8</literal>.
   </simpara>
  </note>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>stream</parameter></term>
     <listitem>
      <para>
       Корректный указатель на файл, который успешно открыли функции
       <function>fopen</function>, <function>popen</function>
       или <function>fsockopen</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>length</parameter></term>
     <listitem>
      <para>
       Для параметра <parameter>length</parameter> устанавливают значение,
       которое больше самой длинной строки в CSV-файле, иначе строка разбивается на части заданной длины,
       если только место разделения не встретится внутри символов-ограничителей.
       Длина строк измеряется в символах с учётом символов конца строки, которыми завершаются строки.
      </para>
      <para>
       Функция снимет ограничение на длину строки, но замедлит работу,
       если параметр пропустили или начиная с PHP 8.0.0 установили для параметра значение 0 или &null;.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>separator</parameter></term>
     <listitem>
      <para>
       Параметр <parameter>separator</parameter> устанавливает
       символ-разделитель полей и принимает только один однобайтовый символ.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>enclosure</parameter></term>
     <listitem>
      <para>
       Параметр <parameter>enclosure</parameter> устанавливает
       символ-ограничитель значения поля и принимает только один однобайтовый символ.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>escape</parameter></term>
     <listitem>
      <para>
       Параметр <parameter>escape</parameter> устанавливает
       символ экранирования и принимает только один однобайтовый символ или пустую строку.
       Пустая строка <literal>""</literal> отключает внутренний механизм экранирования.
      </para>
      <note>
       <simpara>
        Обычно символ ограничителя значений — <parameter>enclosure</parameter> экранируется внутри поля путём удвоения;
        однако как альтернативу разрешается использовать символ экранирования <parameter>escape</parameter>.
        Поэтому для стандартных значений параметра смысл значений <literal>""</literal> и <literal>\"</literal>
        одинаков. Символ экранирования — <parameter>escape</parameter> не несёт отдельного смысла,
        кроме экранирования символа ограничителя значений — <parameter>enclosure</parameter>;
        он даже не экранирует сам себя.
       </simpara>
      </note>
      <warning>
       <simpara>
        Начиная с PHP 8.4.0 полагаться на значение по умолчанию,
        которое содержит параметр <parameter>escape</parameter>, не рекомендуют.
        Значение потребуется указать явно, позиционно
        или как <link linkend="functions.named-arguments">именованный аргумент</link>.
       </simpara>
      </warning>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
  &warning.csv.escape-parameter;
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   В случае успешного выполнения функция возвращает индексный массив с полями,
   которые прочитала из файла,&return.falseforfailure;.
  </para>
  <note>
   <para>
    Пустую строку в CSV-файле функция возвращает как массив
    с единственным элементом <type>null</type>
    и не рассматривает как ошибку.
   </para>
  </note>
  &note.line-endings;
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <simpara>
   Функция выбрасывает ошибку <exceptionname>ValueError</exceptionname>,
   если аргументы для разделителя полей <parameter>separator</parameter> или ограничителя значений <parameter>enclosure</parameter>
   содержат значение короче одного байта.
  </simpara>
  <simpara>
   Функция выбрасывает ошибку <exceptionname>ValueError</exceptionname>,
   если длина значения аргумента <parameter>escape</parameter> не равна одному байту или передали пустую строку.
  </simpara>
 </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.4.0</entry>
       <entry>
        Вызов функции без явной передачи значения в параметр <parameter>escape</parameter>
        устарел.
       </entry>
      </row>
      <row>
       <entry>8.3.0</entry>
       <entry>
        Вместо строки с одним нулевым байтом возвращается пустая строка,
        если последнее поле содержит только незавершённый символ ограничения значения поля.
        enclosure.
       </entry>
      </row>
      <row>
       <entry>8.0.0</entry>
       <entry>
        Параметр <parameter>length</parameter> теперь принимает значение &null;.
       </entry>
      </row>
      <row>
       <entry>7.4.0</entry>
       <entry>
        Параметр <parameter>escape</parameter> теперь также принимает пустую строку
        для отключения встроенного механизма экранирования.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

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

$row = 1;

if (($handle = fopen("test.csv", "r")) !== FALSE) {
    while (($data = fgetcsv($handle, 1000, ",")) !== FALSE) {
        $num = count($data);

        echo "<p> $num полей в строке $row: <br /></p>\n";
        $row++;

        for ($c = 0; $c < $num; $c++) {
            echo $data[$c] . "<br />\n";
        }
    }

    fclose($handle);
}

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

 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member><function>fputcsv</function></member>
   <member><function>str_getcsv</function></member>
   <member><methodname>SplFileObject::fgetcsv</methodname></member>
   <member><methodname>SplFileObject::fputcsv</methodname></member>
   <member><methodname>SplFileObject::setCsvControl</methodname></member>
   <member><methodname>SplFileObject::getCsvControl</methodname></member>
   <member><function>explode</function></member>
   <member><function>file</function></member>
   <member><function>pack</function></member>
  </simplelist>
 </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
-->