reference/spl/limititerator/construct.xml
d51166ca16fda8e766849505b84f9306ef443f71
...
...
@@ -1,6 +1,5 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-

4
3
<refentry xml:id="limititerator.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
5
4
<refnamediv>
6
5
<refname>LimitIterator::__construct</refname>
...
...
@@ -9,16 +8,16 @@
9
8

10
9
<refsect1 role="description">
11
10
&reftitle.description;
12
-
<methodsynopsis>
11
+
<constructorsynopsis role="LimitIterator">
13
12
<modifier>public</modifier> <methodname>LimitIterator::__construct</methodname>
14
13
<methodparam><type>Iterator</type><parameter>iterator</parameter></methodparam>
15
14
<methodparam choice="opt"><type>int</type><parameter>offset</parameter><initializer>0</initializer></methodparam>
16
-
<methodparam choice="opt"><type>int</type><parameter>count</parameter><initializer>-1</initializer></methodparam>
17
-
</methodsynopsis>
15
+
<methodparam choice="opt"><type>int</type><parameter>limit</parameter><initializer>-1</initializer></methodparam>
16
+
</constructorsynopsis>
18
17
<para>
19
18
Constructs a new <classname>LimitIterator</classname> from an
20
19
<parameter>iterator</parameter> with a given starting
21
-
<parameter>offset</parameter> and maximum <parameter>count</parameter>.
20
+
<parameter>offset</parameter> and maximum <parameter>limit</parameter>.
22
21
</para>
23
22
</refsect1>
24
23

...
...
@@ -43,7 +42,7 @@
43
42
</listitem>
44
43
</varlistentry>
45
44
<varlistentry>
46
-
<term><parameter>count</parameter></term>
45
+
<term><parameter>limit</parameter></term>
47
46
<listitem>
48
47
<para>
49
48
Optional count of the limit.
...
...
@@ -54,19 +53,46 @@
54
53
</para>
55
54
</refsect1>
56
55

57
-
<refsect1 role="returnvalues">
58
-
&reftitle.returnvalues;
56
+
<refsect1 role="errors">
57
+
&reftitle.errors;
59
58
<para>
60
-
The new <classname>LimitIterator</classname>.
59
+
Throws a <classname>ValueError</classname>
60
+
if the <parameter>offset</parameter> is less than <literal>0</literal>
61
+
or the <parameter>limit</parameter> is less than <literal>-1</literal>.
61
62
</para>
62
63
</refsect1>
63
64

64
-
<refsect1 role="errors">
65
-
&reftitle.errors;
65
+
<refsect1 role="changelog">
66
+
&reftitle.changelog;
66
67
<para>
67
-
Throws an <classname>OutOfRangeException</classname>
68
-
if the <parameter>offset</parameter> is less than <literal>0</literal>
69
-
or the <parameter>count</parameter> is less than <literal>-1</literal>.
68
+
<informaltable>
69
+
<tgroup cols="2">
70
+
<thead>
71
+
<row>
72
+
<entry>&Version;</entry>
73
+
<entry>&Description;</entry>
74
+
</row>
75
+
</thead>
76
+
<tbody>
77
+
<row>
78
+
<entry>8.0.0</entry>
79
+
<entry>
80
+
Now throws a <classname>ValueError</classname> if
81
+
<parameter>offset</parameter> is less than <literal>0</literal>;
82
+
previously it threw a <classname>RuntimeException</classname>.
83
+
</entry>
84
+
</row>
85
+
<row>
86
+
<entry>8.0.0</entry>
87
+
<entry>
88
+
Now throws a <classname>ValueError</classname> if
89
+
<parameter>limit</parameter> is less than <literal>-1</literal>;
90
+
previously it threw a <classname>RuntimeException</classname>.
91
+
</entry>
92
+
</row>
93
+
</tbody>
94
+
</tgroup>
95
+
</informaltable>
70
96
</para>
71
97
</refsect1>
72
98

...
...
@@ -108,7 +134,6 @@ d
108
134
</refsect1>
109
135

110
136
</refentry>
111
-

112
137
<!-- Keep this comment at the end of the file
113
138
Local variables:
114
139
mode: sgml
115
140