fwrite.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: bb6247b68128cab1b166b49a3a73a87f40333267 Maintainer: cmb Status: ready -->
<!-- Reviewed: yes -->
<!-- Rev-Revision: 9d2b858bca85edbeebb83f05a1cd2e87cf90127d Reviewer: samesch -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.fwrite">
 <refnamediv>
  <refname>fwrite</refname>
  <refpurpose>Binär-sicheres Dateischreiben</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>int</type><type>false</type></type><methodname>fwrite</methodname>
   <methodparam><type>resource</type><parameter>stream</parameter></methodparam>
   <methodparam><type>string</type><parameter>data</parameter></methodparam>
   <methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>length</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <simpara>
   <function>fwrite</function> schreibt den Inhalt der Zeichenkette
   <parameter>data</parameter> in die Datei, auf welche der Dateizeiger
   <parameter>stream</parameter> zeigt.
  </simpara>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>stream</parameter></term>
     <listitem>
      &fs.file.pointer;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>data</parameter></term>
     <listitem>
      <para>
       Die zu schreibende Zeichenkette.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>length</parameter></term>
     <listitem>
      <para>
       Wenn Parameter <parameter>length</parameter> eine &integer; ist, wird
       das Schreiben nach <parameter>length</parameter> Bytes beendet, oder
       wenn das Ende von <parameter>data</parameter> erreicht ist, je
       nachdem was eher eintritt.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <simpara>
   <function>fwrite</function> gibt die Anzahl der geschriebenen Bytes zurück.
   &return.falseforfailure;
  </simpara>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   <function>fwrite</function> erzeugt bei einem Fehler ein
   <constant>E_WARNING</constant>.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <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> ist jetzt nullbar.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Ein einfaches Beispiel für <function>fwrite</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$filename = 'test.txt';
$somecontent = "Füge dies der Datei hinzu\n";

// Sichergehen, dass die Datei existiert und beschreibbar ist.
if (is_writable($filename)) {

    // Wir öffnen $filename im Anfüge-Modus.
    // Der Dateizeiger befindet sich am Ende der Datei, und daher
    // wird später $somecontent mit fwrite() dorthin geschrieben.
    if (!$fp = fopen($filename, "a")) {
         print "Kann die Datei $filename nicht öffnen";
         exit;
    }

    // Schreibe $somecontent in die geöffnete Datei.
    if (fwrite($fp, $somecontent) === FALSE) {
        print "Kann nicht in die Datei $filename schreiben";
        exit;
    }

    print "Fertig, in die Datei $filename wurde $somecontent geschrieben";

    fclose($fp);

} else {
    print "Die Datei $filename ist nicht schreibbar";
}
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    Das Schreiben in einen Netzwerkstream kann enden, bevor die gesamte
    Zeichenkette geschrieben wurde. Der Rückgabewert von
    <function>fwrite</function> kann wie folgt überprüft werden:
    <programlisting role="php">
<![CDATA[
<?php
function fwrite_stream($fp, $string) {
    for ($written = 0; $written < strlen($string); $written += $fwrite) {
        $fwrite = fwrite($fp, substr($string, $written));
        if ($fwrite === false) {
            return $written;
        }
    }
    return $written;
}
?>
]]>
    </programlisting>
   </para>
  </note>

  <note>
   <para>
    Auf Systemen, welche zwischen Binär- und Textdateien unterscheiden (&zb;
    Windows), muss die Datei mit dem <function>fopen</function>-Modus-Parameter
    'b' geöffnet werden.
   </para>
  </note>
  <note>
   <para>
    Wurde <parameter>stream</parameter> mit <function>fopen</function> im
    Anfügemodus geöffnet, ist das Schreiben mit <function>fwrite</function>
    atomar (außer wenn die Länge von <parameter>data</parameter> die
    Blockgröße des Dateisystems auf manchen Systemen überschreitet, und
    solange sich die Datei in einem lokalen Dateisystem befindet), &dh; es
    besteht keine Notwendigkeit, eine Ressource vor dem Aufruf von
    <function>fwrite</function> mit <function>flock</function> zu sperren;
    alle Daten werden ohne Unterbrechung geschrieben.
   </para>
  </note>
  <note>
   <para>
    Wird zweimalig in den Dateizeiger geschrieben, werden die Daten an das
    Ende des Dateiinhalts angehängt:
    <programlisting role="php">
<![CDATA[
<?php
$fp = fopen('data.txt', 'w');
fwrite($fp, '1');
fwrite($fp, '23');
fclose($fp);

// der Inhalt von 'data.txt' ist nun 123 und nicht 23!
?>
]]>
    </programlisting>
   </para>
  </note>
 </refsect1>

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