Skip to content

Commit 1de749f

Browse files
Girgiascmb69
authored andcommitted
Update SplFileObject::_toString() after bugfix (php#2023)
Co-authored-by: Christoph M. Becker <[email protected]>
1 parent 461779e commit 1de749f

File tree

1 file changed

+29
-7
lines changed

1 file changed

+29
-7
lines changed

reference/spl/splfileobject/tostring.xml

Lines changed: 29 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,31 @@
11
<?xml version="1.0" encoding="utf-8"?>
2-
<!-- $Revision$ -->
3-
42
<refentry xml:id="splfileobject.tostring" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
53
<refnamediv>
64
<refname>SplFileObject::__toString</refname>
7-
<refpurpose>&Alias; <methodname>SplFileObject::fgets</methodname></refpurpose>
5+
<refpurpose>Returns the current line as a string</refpurpose>
86
</refnamediv>
97

108
<refsect1 role="description">
119
&reftitle.description;
12-
<simpara>
13-
&info.method.alias; <methodname>SplFileObject::fgets</methodname>.
14-
</simpara>
10+
<methodsynopsis>
11+
<modifier>public</modifier> <type>string</type><methodname>SplFileInfo::__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>
1529
</refsect1>
1630

1731
<refsect1 role="changelog">
@@ -26,6 +40,15 @@
2640
</row>
2741
</thead>
2842
<tbody>
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>
2952
<row>
3053
<entry>7.2.19, 7.3.6</entry>
3154
<entry>
@@ -38,7 +61,6 @@
3861
</para>
3962
</refsect1>
4063
</refentry>
41-
4264
<!-- Keep this comment at the end of the file
4365
Local variables:
4466
mode: sgml

0 commit comments

Comments
 (0)