File: splfileobject.xml

package info (click to toggle)
php-doc 20100521-2
  • links: PTS, VCS
  • area: main
  • in suites: squeeze, wheezy
  • size: 59,992 kB
  • ctags: 4,085
  • sloc: xml: 796,833; php: 21,338; cpp: 500; sh: 117; makefile: 58; awk: 28
file content (150 lines) | stat: -rw-r--r-- 4,586 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 292734 $ -->

<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>Traversable</interfacename>
     </oointerface>

     <oointerface>
      <interfacename>Iterator</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>6</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.</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>
<!-- }}} -->


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