<?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>
   <modifier>public</modifier> <methodname>ArrayObject::__construct</methodname>
   <methodparam choice="opt"><type>mixed</type><parameter>input</parameter><initializer>[]</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>iterator_class</parameter><initializer>"ArrayIterator"</initializer></methodparam>
  </constructorsynopsis>
  <para>
   This constructs a new array <type>object</type>. 
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>input</parameter></term>
     <listitem>
      <para>
       The <parameter>input</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>iterator_class</parameter></term>
     <listitem>
      <para>
       Specify the class that will be used for iteration of the <classname>ArrayObject</classname> object.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns an ArrayObject object on success.
  </para>
 </refsect1>


 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Throws <classname>InvalidArgumentException</classname> when:
   <itemizedlist>
    <listitem>
     <simpara>
      <parameter>input</parameter> is not an array or object
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <parameter>flags</parameter> is not an integer
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <parameter>iterator_class</parameter> is not an object that implements
      <classname>Iterator</classname>
     </simpara>
    </listitem>
   </itemizedlist>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>ArrayObject::__construct</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
$array = array('1' => 'one',
               '2' => 'two',
               '3' => 'three');

$arrayobject = new ArrayObject($array);

var_dump($arrayobject);
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
object(ArrayObject)#1 (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
-->