<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Construct a new array object</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="arrayobject.asort.html">ArrayObject::asort</a></div>
<div class="next" style="text-align: right; float: right;"><a href="arrayobject.count.html">ArrayObject::count</a></div>
<div class="up"><a href="class.arrayobject.html">ArrayObject</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="arrayobject.construct" class="refentry">
<div class="refnamediv">
<h1 class="refname">ArrayObject::__construct</h1>
<p class="verinfo">(PHP 5 >= 5.0.0)</p><p class="refpurpose"><span class="refname">ArrayObject::__construct</span> — <span class="dc-title">Construct a new array object</span></p>
</div>
<div class="refsect1 description" id="refsect1-arrayobject.construct-description">
<h3 class="title">Description</h3>
<div class="constructorsynopsis dc-description">
<span class="modifier">public</span> <span class="methodname"><strong>ArrayObject::__construct()</strong></span>
([ <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$input</code><span class="initializer"> = []</span></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$flags</code><span class="initializer"> = 0</span></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$iterator_class</code><span class="initializer"> = "ArrayIterator"</span></span>
]]] )</div>
<p class="para rdfs-comment">
This constructs a new array <span class="type"><a href="language.types.object.html" class="type object">object</a></span>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-arrayobject.construct-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">input</code></em></span>
<dd>
<p class="para">
The <em><code class="parameter">input</code></em> parameter accepts an
<span class="type"><a href="language.types.array.html" class="type array">array</a></span> or an <span class="type"><a href="language.types.object.html" class="type Object">Object</a></span>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">flags</code></em></span>
<dd>
<p class="para">
Flags to control the behaviour of the <a href="class.arrayobject.html" class="classname">ArrayObject</a> object.
See <span class="methodname"><a href="arrayobject.setflags.html" class="methodname">ArrayObject::setFlags()</a></span>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">iterator_class</code></em></span>
<dd>
<p class="para">
Specify the class that will be used for iteration of the <a href="class.arrayobject.html" class="classname">ArrayObject</a> object.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-arrayobject.construct-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns an ArrayObject object on success.
</p>
</div>
<div class="refsect1 errors" id="refsect1-arrayobject.construct-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
Throws <a href="class.invalidargumentexception.html" class="classname">InvalidArgumentException</a> when:
<ul class="itemizedlist">
<li class="listitem">
<span class="simpara">
<em><code class="parameter">input</code></em> is not an array or object
</span>
</li>
<li class="listitem">
<span class="simpara">
<em><code class="parameter">flags</code></em> is not an integer
</span>
</li>
<li class="listitem">
<span class="simpara">
<em><code class="parameter">iterator_class</code></em> is not an object that implements
<a href="class.iterator.html" class="classname">Iterator</a>
</span>
</li>
</ul>
</p>
</div>
<div class="refsect1 examples" id="refsect1-arrayobject.construct-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3979">
<p><strong>Example #1 <span class="function"><strong>ArrayObject::__construct()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$array </span><span style="color: #007700">= array(</span><span style="color: #DD0000">'1' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'one'</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'2' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'two'</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'3' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'three'</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$arrayobject </span><span style="color: #007700">= new </span><span style="color: #0000BB">ArrayObject</span><span style="color: #007700">(</span><span style="color: #0000BB">$array</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$arrayobject</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
object(ArrayObject)#1 (3) {
[1]=>
string(3) "one"
[2]=>
string(3) "two"
[3]=>
string(5) "three"
}
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-arrayobject.construct-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="methodname"><a href="arrayobject.setflags.html" class="methodname" rel="rdfs-seeAlso">ArrayObject::setflags()</a> - Sets the behavior flags.</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="arrayobject.asort.html">ArrayObject::asort</a></div>
<div class="next" style="text-align: right; float: right;"><a href="arrayobject.count.html">ArrayObject::count</a></div>
<div class="up"><a href="class.arrayobject.html">ArrayObject</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
