file.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: e3ae86b439c1963f0cd6d262712e2d3f7e85bc37 Maintainer: wiesemann Status: ready -->
<!-- Reviewed: yes -->
<!-- Rev-Revision: 5783afacadc643d901276d4314d75a0186397dd6 Reviewer: samesch -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.file">
 <refnamediv>
  <refname>file</refname>
  <refpurpose>Liest eine komplette Datei in ein Array</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>array</type><type>false</type></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 class="union"><type>resource</type><type>null</type></type><parameter>context</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Liest eine komplette Datei in ein Array.
  </para>
  <note>
   <para>
    Sie können <function>file_get_contents</function> benutzen, um den Inhalt
    einer Datei als String zurückgegeben zu bekommen.
   </para>
  </note>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>filename</parameter></term>
     <listitem>
      <para>
       Der Pfad zur Datei.
      </para>
      &tip.fopen-wrapper;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       Der optionale Parameter <parameter>flags</parameter> kann aus einer
       oder mehreren der folgenden Konstanten bestehen:
       <variablelist>
        <varlistentry>
         <term>
          <constant>FILE_USE_INCLUDE_PATH</constant>
         </term>
         <listitem>
          <simpara>
           Suche nach der Datei im
           <link linkend="ini.include-path">include_path</link>
          </simpara>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term>
          <constant>FILE_IGNORE_NEW_LINES</constant>
         </term>
         <listitem>
          <simpara>
           Entferne den Zeilenumbruch am Ende jedes Array-Elements
          </simpara>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term>
          <constant>FILE_SKIP_EMPTY_LINES</constant>
         </term>
         <listitem>
          <simpara>
           Überspringe leere Zeilen
          </simpara>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term>
          <constant>FILE_NO_DEFAULT_CONTEXT</constant>
         </term>
         <listitem>
          <simpara>
           Verwende nicht den Standardkontext
          </simpara>
         </listitem>
        </varlistentry>
       </variablelist>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>context</parameter></term>
     <listitem>
      &note.context-support;
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Gibt die Datei in einem Array zurück. Jedes Element des Arrays entspricht
   einer Zeile in der Datei, ohne dass der Zeilenumbruch entfernt wird. Im
   Fehlerfall gibt <function>file</function> &false; zurück.
  </para>
  <note>
   <para>
    Jede Zeile im resultierenden Array enthält den Zeilenumbruch, außer es
    wird <constant>FILE_IGNORE_NEW_LINES</constant> verwendet.
   </para>
  </note>
  &note.line-endings;
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <simpara>
   Wenn <parameter>flags</parameter> ungültige Werte enthält, &zb;
   <constant>FILE_APPEND</constant>, wird seit PHP 8.3.0 ein
   <exceptionname>ValueError</exceptionname> ausgelöst.
  </simpara>
  <para>
   Erzeugt einen Fehler der Stufe <constant>E_WARNING</constant>, wenn die
   Datei nicht existiert.
  </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.3.0</entry>
      <entry>
       Für alle ungültigen Werte von <parameter>flags</parameter> wird ein
       <exceptionname>ValueError</exceptionname> ausgelöst.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>file</function>-Beispiel</title>
    <programlisting role="php">
<![CDATA[
<?php
// Liest eine Datei in ein Array. Hier gehen wir über HTTP, um den
// HTML-Quelltext einer URL zu bekommen
$lines = file('http://www.example.com/');

// Durchgehen des Arrays und Anzeigen des HTML-Quelltexts inkl. Zeilennummern
foreach ($lines as $line_num => $line) {
    echo "Line #<b>{$line_num}</b> : " . htmlspecialchars($line) . "<br />\n";
}

// Benutzung des optionalen Parameters flags
$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>file_get_contents</function></member>
    <member><function>readfile</function></member>
    <member><function>fopen</function></member>
    <member><function>fsockopen</function></member>
    <member><function>popen</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
-->