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
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="arrayobject.construct" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ArrayObject::__construct</refname>
<refpurpose>Construct a new array object</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<constructorsynopsis role="ArrayObject">
<modifier>public</modifier> <methodname>ArrayObject::__construct</methodname>
<methodparam choice="opt"><type class="union"><type>array</type><type>object</type></type><parameter>array</parameter><initializer>[]</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>iteratorClass</parameter><initializer>ArrayIterator::class</initializer></methodparam>
</constructorsynopsis>
<para>
This constructs a new array <type>object</type>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>array</parameter></term>
<listitem>
<para>
The <parameter>array</parameter> parameter accepts an
<type>array</type> or an <type>Object</type>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
Flags to control the behaviour of the <classname>ArrayObject</classname> object.
See <methodname>ArrayObject::setFlags</methodname>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>iteratorClass</parameter></term>
<listitem>
<para>
Specify the class that will be used for iteration of the <classname>ArrayObject</classname> object.
The class must be a subtype of the <classname>ArrayIterator</classname> class.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>ArrayObject::__construct</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$array = [
'1' => 'one',
'2' => 'two',
'3' => 'three'
];
$arrayobject = new ArrayObject($array);
var_dump($arrayobject);
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
object(ArrayObject)#1 (1) {
["storage":"ArrayObject":private]=>
array(3) {
[1]=>
string(3) "one"
[2]=>
string(3) "two"
[3]=>
string(5) "three"
}
}
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>ArrayObject::setflags</methodname></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- 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
-->
|