Access.php 2.02 KB
Newer Older
doctrine's avatar
doctrine committed
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
<?php
/**
 * Doctrine_Access
 *
 * the purpose of Doctrine_Access is to provice array access
 * and property overload interface for subclasses
 *
 * @package     Doctrine ORM
 * @url         www.phpdoctrine.com
 * @license     LGPL
 */
abstract class Doctrine_Access implements ArrayAccess {
    /**
     * setArray
     * @param array $array          an array of key => value pairs
     */
    public function setArray(array $array) {
        foreach($array as $k=>$v):
            $this->set($k,$v);
        endforeach;
    }
    /**
     * __set -- an alias of set()
     * @see set, offsetSet
     * @param $name
     * @param $value
     */
    public function __set($name,$value) {
        $this->set($name,$value);
    }
    /**
     * __get -- an alias of get()
     * @see get,  offsetGet
     * @param mixed $name
     * @return mixed
     */
    public function __get($name) {
        return $this->get($name);
    }
    /**
     * @param mixed $offset
     * @return boolean -- whether or not the data has a field $offset
     */
    public function offsetExists($offset) {
        return (bool) isset($this->data[$offset]);
    }
    /**
     * offsetGet -- an alias of get()
     * @see get,  __get
     * @param mixed $offset
     * @return mixed
     */
    public function offsetGet($offset) {
        return $this->get($offset);
    }
    /**
     * sets $offset to $value
     * @see set,  __set
     * @param mixed $offset
     * @param mixed $value
     * @return void
     */
    public function offsetSet($offset, $value) {
        if( ! isset($offset)) {
            $this->add($value);
        } else
            $this->set($offset,$value);
    }
    /**
     * unset a given offset
     * @see set, offsetSet, __set
     * @param mixed $offset
     */
    public function offsetUnset($offset) {
        if($this instanceof Doctrine_Collection) {
            return $this->remove($offset);
        } else {
            $this->set($offset,null);
        }
    }
}
?>