php-doc-en/reference/spl/splfileobject.xml

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

<phpdoc:classref xmlns:phpdoc="http://php.net/ns/phpdoc" xml:id="class.splfileobject" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">

 <title>The SplFileObject class</title>
 <titleabbrev>SplFileObject</titleabbrev>

 <partintro>

<!-- {{{ SplFileObject intro -->
  <section xml:id="splfileobject.intro">
   &reftitle.intro;
   <para>
    The SplFileObject class offers an object oriented interface for a file.
   </para>
  </section>
<!-- }}} -->

  <section xml:id="splfileobject.synopsis">
   &reftitle.classsynopsis;

<!-- {{{ Synopsis -->
   <classsynopsis>
    <ooclass><classname>SplFileObject</classname></ooclass>

<!-- {{{ Class synopsis -->
    <classsynopsisinfo>
     <ooclass>
      <classname>SplFileObject</classname>
     </ooclass>
     
     <ooclass>
      <modifier>extends</modifier>
      <classname>SplFileInfo</classname>
     </ooclass>
     
     <oointerface>
      <interfacename>RecursiveIterator</interfacename>
     </oointerface>

     <oointerface>
      <interfacename>SeekableIterator</interfacename>
     </oointerface>
    </classsynopsisinfo>
<!-- }}} -->
    <classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="splfileobject.constants.drop-new-line">SplFileObject::DROP_NEW_LINE</varname>
     <initializer>1</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="splfileobject.constants.read-ahead">SplFileObject::READ_AHEAD</varname>
     <initializer>2</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="splfileobject.constants.skip-empty">SplFileObject::SKIP_EMPTY</varname>
     <initializer>4</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="splfileobject.constants.read-csv">SplFileObject::READ_CSV</varname>
     <initializer>8</initializer>
    </fieldsynopsis>
    
    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.splfileobject')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
    
    <classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.splfileinfo')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />

   </classsynopsis>
<!-- }}} -->

  </section>
  
<!-- {{{ SplFileObject constants -->
  <section xml:id="splfileobject.constants">
   &reftitle.constants;
   <variablelist>
    <varlistentry xml:id="splfileobject.constants.drop-new-line">
     <term><constant>SplFileObject::DROP_NEW_LINE</constant></term>
     <listitem>
      <para>Drop newlines at the end of a line.</para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="splfileobject.constants.read-ahead">
     <term><constant>SplFileObject::READ_AHEAD</constant></term>
     <listitem>
      <para>Read on rewind/next.</para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="splfileobject.constants.skip-empty">
     <term><constant>SplFileObject::SKIP_EMPTY</constant></term>
     <listitem>
      <para>Skips empty lines in the file. This requires the <constant>READ_AHEAD</constant> flag be enabled, to work as expected.</para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="splfileobject.constants.read-csv">
     <term><constant>SplFileObject::READ_CSV</constant></term>
     <listitem>
      <para>Read lines as CSV rows.</para>
     </listitem>
    </varlistentry>
   </variablelist>
  </section>
<!-- }}} -->

 <section role="changelog"><!-- {{{ -->
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>5.3.9</entry>
       <entry>
        <constant>SplFileObject::SKIP_EMPTY</constant> value changed to 4.
        Previously, value was 6.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </section><!-- }}} -->

 </partintro>

 &reference.spl.entities.splfileobject;

</phpdoc:classref>

<!-- 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
-->