file-put-contents.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: e41aab5ecacf449e51179886c17f1d41735b0234 Maintainer: ktretyak Status: ready -->
<!-- $Revision$ -->

<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.file-put-contents">
 <refnamediv>
  <refname>file_put_contents</refname> 
  <refpurpose>Записує рядок у файл</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>file_put_contents</methodname>
   <methodparam><type>string</type><parameter>filename</parameter></methodparam>
   <methodparam><type>mixed</type><parameter>data</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> 
   Ця функція є ідентичною до послідовних викликів <function>fopen</function>,
   <function>fwrite</function> та <function>fclose</function> для
   записування даних у файл.
  </para>
  <para>
   Якщо файлу (<parameter>filename</parameter>) не існує, його буде створено.
   В іншому випадку, існуючий файл буде перезаписано, якщо не встановлено
   флаг <constant>FILE_APPEND</constant>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>filename</parameter></term>
     <listitem>
      <para>
       Шлях до файлу, куди будуть записуватись дані.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>data</parameter></term>
     <listitem>
      <para>
       Дані для запису. Може бути рядком (<type>string</type>), масивом
       (<type>array</type>) або ресурсом потоку (<type>stream</type>).
      </para>
      <para>
       Якщо дані (<parameter>data</parameter>) є ресурсом потоку
       (<type>stream</type>), залишок буфера цього потоку буде скопійовано до
     зазначеного файла.
       Це схоже на використання <function>stream_copy_to_stream</function>.
      </para>
      <para>
       Ви також можете зазначити параметр <parameter>data</parameter> як
       як одномірний одиночний масив. Це буде еквівалентно до виклика
       <literal>file_put_contents($filename, implode('', $array))</literal>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       Значення параметра <parameter>flags</parameter> може бути будь-якою
       комбінацією з наступних флагів, об'єднаних бінарним оператором АБО
       (<literal>|</literal>).
      </para>
      <para>
       <table>
        <title>Доступні флаги</title>
        <tgroup cols="2">
         <thead>
          <row>
           <entry>Флаг</entry>
           <entry>Опис</entry>
          </row>
         </thead>
         <tbody>
          <row>
           <entry>
            <constant>FILE_USE_INCLUDE_PATH</constant>
           </entry>
           <entry>
            Пошук файла <parameter>filename</parameter> в директоріях,
            що підключаються. Прогляньте <link linkend="ini.include-path">include_path</link>
            для більш детальної інформації.
           </entry>
          </row>
          <row>
           <entry>
            <constant>FILE_APPEND</constant>
           </entry>
           <entry>
            Якщо файл <parameter>filename</parameter> вже існує, додавати
            дані, замість перезаписування старого вмісту.
           </entry>
          </row>
          <row>
           <entry>
            <constant>LOCK_EX</constant>
           </entry>
           <entry>
            Отримати монопольне блокування поки йде процес записування.
           </entry>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>context</parameter></term>
     <listitem>
      <para>
       Коректний ресурс контента створений за допомогою функції
       <function>stream_context_create</function>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Ця функція повертає кількість байтів, які будуть записані до файла, або
   &false; при невдачі.
  </para>
  &return.falseproblem;
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Просте використання</title>
    <programlisting role="php">
<![CDATA[
<?php
$file = 'people.txt';

// Відкрити файл для отримання існуючого вмісту
$current = file_get_contents($file);

// Додати нову особу до файлу
$current .= "Коля Шкраб";

// Вписати вміст назад у файл
file_put_contents($file, $current);
?>
]]>
    </programlisting>
   </example>
   <example>
    <title>Використання флагів</title>
    <programlisting role="php">
<![CDATA[
<?php
$file = 'people.txt';

// Додати нову особу до файлу
$person = "Коля Шкраб";

// Запис до файлу з використанням флагу FILE_APPEND,
// щоб вміст додавався в кінець,
// та блокування файлу за допомогою флагу LOCK_EX, щоб недопустити одночасний запис ще кимось
file_put_contents($file, $person, FILE_APPEND | LOCK_EX);
?>
]]>
    </programlisting>
   </example>
  </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>5.1.0</entry>
       <entry>
        Додано підтримку для <constant>LOCK_EX</constant> та можливість
        передавати ресурс потоку в параметр <parameter>data</parameter>
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>
  
 <refsect1 role="notes">
  &reftitle.notes;
  &note.bin-safe;
  &tip.fopen-wrapper;
 </refsect1>

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