reference/spl/arrayobject/construct.xml
d51166ca16fda8e766849505b84f9306ef443f71
...
...
@@ -8,11 +8,11 @@
8
8

9
9
<refsect1 role="description">
10
10
&reftitle.description;
11
-
<constructorsynopsis>
11
+
<constructorsynopsis role="ArrayObject">
12
12
<modifier>public</modifier> <methodname>ArrayObject::__construct</methodname>
13
-
<methodparam choice="opt"><type>mixed</type><parameter>input</parameter><initializer>array()</initializer></methodparam>
13
+
<methodparam choice="opt"><type class="union"><type>array</type><type>object</type></type><parameter>array</parameter><initializer>[]</initializer></methodparam>
14
14
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
15
-
<methodparam choice="opt"><type>string</type><parameter>iterator_class</parameter><initializer>"ArrayIterator"</initializer></methodparam>
15
+
<methodparam choice="opt"><type>string</type><parameter>iteratorClass</parameter><initializer>ArrayIterator::class</initializer></methodparam>
16
16
</constructorsynopsis>
17
17
<para>
18
18
This constructs a new array <type>object</type>.
...
...
@@ -24,10 +24,10 @@
24
24
<para>
25
25
<variablelist>
26
26
<varlistentry>
27
-
<term><parameter>input</parameter></term>
27
+
<term><parameter>array</parameter></term>
28
28
<listitem>
29
29
<para>
30
-
The <parameter>input</parameter> parameter accepts an
30
+
The <parameter>array</parameter> parameter accepts an
31
31
<type>array</type> or an <type>Object</type>.
32
32
</para>
33
33
</listitem>
...
...
@@ -42,10 +42,11 @@
42
42
</listitem>
43
43
</varlistentry>
44
44
<varlistentry>
45
-
<term><parameter>iterator_class</parameter></term>
45
+
<term><parameter>iteratorClass</parameter></term>
46
46
<listitem>
47
47
<para>
48
48
Specify the class that will be used for iteration of the <classname>ArrayObject</classname> object.
49
+
The class must implement <interfacename>ArrayIterator</interfacename>.
49
50
</para>
50
51
</listitem>
51
52
</varlistentry>
...
...
@@ -53,39 +54,6 @@
53
54
</para>
54
55
</refsect1>
55
56

56
-
<refsect1 role="returnvalues">
57
-
&reftitle.returnvalues;
58
-
<para>
59
-
Returns an ArrayObject object on success.
60
-
</para>
61
-
</refsect1>
62
-

63
-

64
-
<refsect1 role="errors">
65
-
&reftitle.errors;
66
-
<para>
67
-
Throws <classname>InvalidArgumentException</classname> when:
68
-
<itemizedlist>
69
-
<listitem>
70
-
<simpara>
71
-
<parameter>input</parameter> is not an array or object
72
-
</simpara>
73
-
</listitem>
74
-
<listitem>
75
-
<simpara>
76
-
<parameter>flags</parameter> is not an integer
77
-
</simpara>
78
-
</listitem>
79
-
<listitem>
80
-
<simpara>
81
-
<parameter>iterator_class</parameter> is not an object that implements
82
-
<classname>Iterator</classname>
83
-
</simpara>
84
-
</listitem>
85
-
</itemizedlist>
86
-
</para>
87
-
</refsect1>
88
-

89
57
<refsect1 role="examples">
90
58
&reftitle.examples;
91
59
<para>
...
...
@@ -131,7 +99,6 @@ object(ArrayObject)#1 (3) {
131
99
</refsect1>
132
100

133
101
</refentry>
134
-

135
102
<!-- Keep this comment at the end of the file
136
103
Local variables:
137
104
mode: sgml
138
105