PHP 5.4.31 Released

ArrayObject::__construct

(PHP 5 >= 5.0.0)

ArrayObject::__constructConstruct a new array object

Description

public ArrayObject::__construct ([ mixed $input = [] [, int $flags = 0 [, string $iterator_class = "ArrayIterator" ]]] )

This constructs a new array object.

Parameters

input

The input parameter accepts an array or an Object.

flags

Flags to control the behaviour of the ArrayObject object. See ArrayObject::setFlags().

iterator_class

Specify the class that will be used for iteration of the ArrayObject object.

Return Values

Returns an ArrayObject object on success.

Errors/Exceptions

Throws InvalidArgumentException when:

  • input is not an array or object
  • flags is not an integer
  • iterator_class is not an object that implements Iterator

Examples

Example #1 ArrayObject::__construct() example

<?php
$array 
= array('1' => 'one',
               
'2' => 'two',
               
'3' => 'three');

$arrayobject = new ArrayObject($array);

var_dump($arrayobject);
?>

The above example will output:

object(ArrayObject)#1 (3) {
  [1]=>
  string(3) "one"
  [2]=>
  string(3) "two"
  [3]=>
  string(5) "three"
}

See Also

add a note add a note

User Contributed Notes 6 notes

up
2
kjarli at gmail dot com
1 year ago
As of PHP 5.3 I recommend to use this, I have replace "new self" by "new static". This allows you to extend this class by your own and let your class create itself recursively without overwriting the constructor.

<?php
/**
* @author Iltar van der Berg
* @version 2.0.0
*/
class RecursiveArrayObject extends ArrayObject
{
   
/**
     * overwrites the ArrayObject constructor for
     * iteration through the "array". When the item
     * is an array, it creates another self() instead
     * of an array
     *
     * @param Array $array data array
     */
   
public function __construct(Array $array)
    {   
        foreach(
$array as $key => $value) {
            if(
is_array($value)){
               
$value = new static($value);
            }
           
$this->offsetSet($key, $value);
        }
    }
   
   
/**
     * returns Array when printed (like "echo array();")
     * instead of an error
     *
     * @return string
     */
   
public function __ToString()
    {
        return
'Array';
    }
}
?>
up
0
ashley at nospam dot zincdigital dot com
5 years ago
The great confusion with this class is in its naming.  ArrayObject infers it will behave as an Array and as an Object.  It won't.  It behaves as an array.  It would better be called ArrayType.  You can, with some work, get it to work both as an object and as an array, but that is up to you.
up
0
kjarli at gmail dot com
6 years ago
This extend allows multidimensional arrays to be converted aswell. It also returns 'Array' when echoed (unlike ArrayObject which gives an error).
<?php
/**
* @author iltar van der berg
* @version 1.0.1
*/
class RecursiveArrayObject extends ArrayObject
{
   
/**
     * overwrites the ArrayObject constructor for
     * iteration through the "array". When the item
     * is an array, it creates another self() instead
     * of an array
     *
     * @param Array $array data array
     */
   
public function __construct(Array $array)
    {   
        foreach(
$array as $key => $value) {
            if(
is_array($value)){
               
$value = new self($value);
            }
           
$this->offsetSet($key, $value);
        }
    }
   
   
/**
     * returns Array when printed (like "echo array();")
     * instead of an error
     *
     * @return string
     */
   
public function __ToString()
    {
        return
'Array';
    }
}
?>
up
0
german dot rumm at gmail dot com
6 years ago
BTW, if you need to change array later, use exchangeArray() method. Good to know when you are writing a class that extends ArrayObject()

AFAIK, exchangeArray() doesn't return anything.

<?php
    $a
= array('one', 'two', 'three');
   
$ao = new ArrayObject($a);

    foreach (
$ao as $element) {
        echo
$element . ' '; // one two three
   
}

   
$b = array('four', 'five', 'six');
   
$ao->exchangeArray($b); // returns null

   
foreach ($ao as $element) {
        echo
$element . ' '; // four five six
   
}
?>
up
0
agalkin at agalkin dot ru
6 years ago
Note that the first argument to ArrayObject::__construct, the initial array, is passed by reference. Nevertheless, modification of the array doesn't modify the object, so it may cause unexpected behaviour.

<?php
$array
= array('foo' => 'initial');
$obj = new ArrayObject($array);

// array was passed by reference:
$obj['foo'] = 'modified';
var_dump($array); // foo => modified

// but it doesn't work backwards:
$array['foo'] = 'modified_again';
var_dump($obj); // foo => modified
var_dump($array); // foo => modified_again
?>
up
0
Grigori Kochanov
8 years ago
As Marcus explained, the flag ArrayObject::SPL_ARRAY_AS_PROPS means the array element may be used as a property if there is no conflict with visible properties.

If there are visible properties in the class, the array element will not overwrite it's value.

<?php
class Rules extends ArrayObject {
    public
$len = 1;
    function
__construct($array){
       
parent::__construct($array,ArrayObject::ARRAY_AS_PROPS);
       
$this['len'] = 2;
    }
}
$x = new Rules(array(1,2));
echo
$x->len;
?>
Result: 1

<?php
class Rules extends ArrayObject {
    private
$len = 1;
    function
__construct($array){
       
parent::__construct($array,ArrayObject::ARRAY_AS_PROPS);
       
$this['len'] = 2;
    }
}
$x = new Rules(array(1,2));
echo
$x->len;
?>
Result: 2
To Top