reference/spl/splfileobject/tostring.xml
823dc72e74f7d01fecb8bfcf7646021b0760063f
...
...
@@ -1,17 +1,31 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
-
<!-- $Revision$ -->
3
-

4
2
<refentry xml:id="splfileobject.tostring" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
5
3
<refnamediv>
6
4
<refname>SplFileObject::__toString</refname>
7
-
<refpurpose>Alias of <methodname>SplFileObject::fgets</methodname></refpurpose>
5
+
<refpurpose>Returns the current line as a string</refpurpose>
8
6
</refnamediv>
9
7

10
8
<refsect1 role="description">
11
9
&reftitle.description;
12
-
<simpara>
13
-
&info.method.alias; <methodname>SplFileObject::fgets</methodname>.
14
-
</simpara>
10
+
<methodsynopsis role="SplFileObject">
11
+
<modifier>public</modifier> <type>string</type><methodname>SplFileObject::__toString</methodname>
12
+
<void/>
13
+
</methodsynopsis>
14
+
<para>
15
+
This method will return the current line as a string.
16
+
</para>
17
+
</refsect1>
18
+

19
+
<refsect1 role="parameters">
20
+
&reftitle.parameters;
21
+
&no.function.parameters;
22
+
</refsect1>
23
+

24
+
<refsect1 role="returnvalues">
25
+
&reftitle.returnvalues;
26
+
<para>
27
+
Returns the current line as a string.
28
+
</para>
15
29
</refsect1>
16
30

17
31
<refsect1 role="changelog">
...
...
@@ -27,6 +41,15 @@
27
41
</thead>
28
42
<tbody>
29
43
<row>
44
+
<entry>8.1.14, 8.2.1</entry>
45
+
<entry>
46
+
Changed from an alias of <methodname>SplFileObject::fgets</methodname>
47
+
to an implementation of <methodname>SplFileObject::current</methodname>
48
+
which returns a CSV string when the
49
+
<constant>SplFileObject::READ_CSV</constant> flag is set.
50
+
</entry>
51
+
</row>
52
+
<row>
30
53
<entry>7.2.19, 7.3.6</entry>
31
54
<entry>
32
55
Changed from an alias of <methodname>SplFileObject::current</methodname> to an alias of <methodname>SplFileObject::fgets</methodname>.
...
...
@@ -38,7 +61,6 @@
38
61
</para>
39
62
</refsect1>
40
63
</refentry>
41
-

42
64
<!-- Keep this comment at the end of the file
43
65
Local variables:
44
66
mode: sgml
45
67