<?xml version="1.0" encoding="utf-8"?>

<refentry xml:id="function.fputcsv" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">

<refnamediv>

<refname>fputcsv</refname>

<refpurpose>Формирует строку в CSV-формате и записывает строку в файловый указатель</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type class="union"><type>int</type><type>false</type></type><methodname>fputcsv</methodname>

<methodparam><type>resource</type><parameter>stream</parameter></methodparam>

<methodparam><type>array</type><parameter>fields</parameter></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>

<methodparam choice="opt"><type>string</type><parameter>eol</parameter><initializer>"\n"</initializer></methodparam>

</methodsynopsis>

<para>

Функция <function>fputcsv</function> формирует из массива полей <parameter>fields</parameter>

строку в <acronym>CSV</acronym>-формате, завершает её символом перевода строки

и записывает строку в файловый указатель <parameter>stream</parameter>.

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>stream</parameter></term>

<listitem>

&fs.validfp.all;

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>fields</parameter></term>

<listitem>

<para>

Массив строк (<type>string</type>).

</para>

</listitem>

</varlistentry>

<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('function.fgetcsv')/db:refsect1[@role='parameters']//db:varlistentry[db:term[db:parameter[text()='separator']]]/.)">

<xi:fallback/>

</xi:include>

<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('function.fgetcsv')/db:refsect1[@role='parameters']//db:varlistentry[db:term[db:parameter[text()='enclosure']]]/.)">

<xi:fallback/>

</xi:include>

<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('function.fgetcsv')/db:refsect1[@role='parameters']//db:varlistentry[db:term[db:parameter[text()='escape']]]/.)">

<xi:fallback/>

</xi:include>

<varlistentry>

<term><parameter>eol</parameter></term>

<listitem>

<para>

Необязательный параметр <parameter>eol</parameter> устанавливает

пользовательскую последовательность конца строки.

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

&warning.csv.escape-parameter;

<note>

<para>

Функция заэкранирует символ ограничителя полей путём удвоения,

если поле содержит символ ограничителя полей <parameter>enclosure</parameter>,

если только перед ограничителем, который функция встретила в поле,

не идёт символ экранирования <parameter>escape</parameter>.

</para>

</note>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

Функция возвращает длину строки, которую записала,&return.falseforfailure;.

</para>

</refsect1>

<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('function.fgetcsv')/db:refsect1[@role='errors']/.)">

<xi:fallback/>

</xi:include>

<refsect1 role="changelog">

&reftitle.changelog;

<para>

<informaltable>

<tgroup cols="2">

<thead>

<row>

<entry>&Version;</entry>

<entry>&Description;</entry>

</row>

</thead>

<tbody>

<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('function.fgetcsv')/db:refsect1[@role='changelog']//db:row[db:entry[text()='8.4.0']]/.)">

<xi:fallback/>

</xi:include>

<row>

<entry>8.1.0</entry>

<entry>

Добавили необязательный параметр <parameter>eol</parameter>.

</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-строки в файл функцией <function>fputcsv</function></title>

<programlisting role="php">

</programlisting>

<para>

Пример запишет в файл <literal>file.csv</literal> следующие строки:

</para>

<screen>

</screen>

</example>

</para>

</refsect1>

<refsect1 role="seealso">

&reftitle.seealso;

<simplelist>

<member><function>fgetcsv</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>

</simplelist>

</refsect1>

</refentry>