OArray.php

Go to the documentation of this file.

<?php
/* vim: set expandtab tabstop=4 shiftwidth=4: */
//  
//  Copyright (c) 2003 Laurent Bedubourg
//  
//  This library is free software; you can redistribute it and/or
//  modify it under the terms of the GNU Lesser General Public
//  License as published by the Free Software Foundation; either
//  version 2.1 of the License, or (at your option) any later version.
//  
//  This library is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
//  Lesser General Public License for more details.
//  
//  You should have received a copy of the GNU Lesser General Public
//  License along with this library; if not, write to the Free Software
//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//  
//  Authors: Laurent Bedubourg <laurent.bedubourg@free.fr>
//  

require_once PT_IP . "/Types.php";
require_once PT_IP . "/Types/Errors.php";
require_once PT_IP . "/Types/Ref.php";
require_once PT_IP . "/Types/Iterator.php";

class OArray extends Iterable 
{
    var $_array;
    var $_size = 0;

    function OArray($array=array())
    {
        $this->__construct($array);
    }
    
    function __construct($array=array())
    {
        $this->_array = array();
        for ($i = 0; $i < count($array); $i++) {
            $this->pushRef($array[$i]);
        }
    }

    function getNewIterator()
    {
        return new ArrayIterator($this);
    }

    function size()
    {
        return count($this->_array);
    }

    function isEmpty()
    {
        return $this->size() == 0;
    }

    function &get($i)
    {
        if ($i > $this->size() || $i < 0) { 
            $err = new OutOfBounds("OArray index out of bounds ($i)");
            // return EX::raise($err);
            return PEAR::raiseError($err);
        }
        return $this->_array[$i]->obj;
    }

    function indexOf($element)
    {
        for ($i=0; $i < count($this->_array); $i++) {
            if ($this->_array[$i]->obj === $element) { 
                return $i; 
            }
        }
        return false;
    }

    function &set($i, $item)
    {
        return $this->setRef($i, $item);
    }

    function &setRef($i, &$item)
    {
        if ($i > $this->size() || $i < 0) { 
            $err = new OutOfBounds("OArray index out of bounds ($i)");
            // return EX::raise($err);
            return PEAR::raiseError($err);
        }
        $temp = $this->_array[$i];
        $this->_array[$i] = Ref($item);
        return $temp->obj;        
    }

    function contains($o)
    {
        for ($i = 0; $i < $this->size(); $i++) {
            if ($this->_array[$i]->obj === $o) return true;
        }
        return false;
    }

    function add($o)
    {
        $this->push($o);
    }

    function remove($o)
    {
        $i = $this->indexOf($o);
        if ($i !== false) {
            $this->removeIndex($i);
            return true;
        }
        return false;
    }

    function removeIndex($i)
    {
        if ($i > $this->size() || $i < 0 ) { 
            $err = new OutOfBounds("OArray index out of bounds ($i)");
            // return EX::raise($err);
            return PEAR::raiseError($err);
        }
        
        // $this->_array = array_splice($this->_array, $i, 1);
        array_splice($this->_array, $i, 1);
    }

    function clear()
    {
        $this->_array = array();
    }

    function push($o)
    {
        array_push($this->_array, Ref($o));
    }

    function pushRef(&$o)
    {
        $this->_array[] = Ref($o);
    }

    function &values()
    {
        $v = array();
        for ($i = 0; $i < $this->size(); $i++) {
            $v[] =& $this->_array[$i]->obj;
        }
        return $v;
    }

    function &pop()
    {
        $ref = array_pop($this->_array);
        return $ref->obj;
    }

    function &shift()
    {
        $ref = array_shift($this->_array);
        return$ $ref->obj;
    }

    function &toArray()
    {
        return $this->values();
    }

    function toString()
    {
        return Types::_arrayToString($this->values());
    }
};

class ArrayIterator extends Iterator
{
    var $_src;
    var $_values;
    var $_value;
    var $_i;

    function ArrayIterator(&$oarray)
    {
        return $this->__construct($oarray);
    }
    
    function __construct(&$oarray)
    {
        if (is_array($oarray)) {
            $this->_src = new OArray($oarray);
        } else if (is_a($oarray, 'OArray')) {
            $this->_src = &$oarray;
        } else {
            // ignore error, should throw a bad type error or something like
            // that but pear does not handle errors in constructors yet
            $err = new TypeError("ArrayIterator requires OArray object or php array.",
                                 PEAR_ERROR_DIE);
            // return EX::raise($err);
            return PEAR::raiseError($err);
        }
        $this->reset();
    }

    function reset()
    {
        $this->_i = 0;
        $this->_end = false;
        $this->_values = $this->_src->_array;
        if (count($this->_values) == 0) {
            $this->_end = true;
            return;
        }

        $this->_value = $this->_values[0];
    }

    function &next()
    {
        if ($this->_end || ++$this->_i >= count($this->_values)) {
            $this->_end = true;
            return null;
        }

        $this->_value = $this->_values[$this->_i];
        return $this->_value->obj;
    }

    function isValid()
    {
        return !$this->_end;
    }

    function index()
    {
        return $this->_i;
    }

    function &value()
    {
        return $this->_value->obj;
    }
    
    function remove()
    {
        $this->_src->remove($this->_value->obj);
    }
}

?>

---