PHP ArrayAccess（数组式访问）接口

简介

提供像访问数组一样访问对象的能力的接口。

接口摘要

ArrayAccess {
/* 方法 */
abstract public boolean offsetExists ( mixed $offset )
abstract public mixed offsetGet ( mixed $offset )
abstract public void offsetSet ( mixed $offset , mixed $value )
abstract public void offsetUnset ( mixed $offset )
}

使用：

<?php
class obj implements arrayaccess {
    private $container = array();
    public function __construct() {
        $this->container = array(
            "one"   => 1,
            "two"   => 2,
            "three" => 3,
        );
    }
    public function offsetSet($offset, $value) {
        if (is_null($offset)) {
            $this->container[] = $value;
        } else {
            $this->container[$offset] = $value;
        }
    }
    public function offsetExists($offset) {
        return isset($this->container[$offset]);
    }
    public function offsetUnset($offset) {
        unset($this->container[$offset]);
    }
    public function offsetGet($offset) {
        return isset($this->container[$offset]) ? $this->container[$offset] : null;
    }
}

$obj = new obj;

var_dump(isset($obj["two"]));
var_dump($obj["two"]);
unset($obj["two"]);
var_dump(isset($obj["two"]));
$obj["two"] = "A value";
var_dump($obj["two"]);
$obj[] = 'Append 1';
$obj[] = 'Append 2';
$obj[] = 'Append 3';
print_r($obj);
?>

以上例程的输出类似于：

bool(true)
int(2)
bool(false)
string(7) "A value"
obj Object
(
    [container:obj:private] => Array
        (
            [one] => 1
            [three] => 3
            [two] => A value
            [0] => Append 1
            [1] => Append 2
            [2] => Append 3
        )

)

解读：

• ArrayAccess::offsetExists — 检查一个偏移位置是否存在
  用于例子中isset()函数的使用。
• ArrayAccess::offsetGet — 获取一个偏移位置的值
  用于例子中$obj[“two”]对象获取使用。
• ArrayAccess::offsetSet — 设置一个偏移位置的值
  用于例子中$obj[“two”] = “A value”设置使用。
• ArrayAccess::offsetUnset — 复位一个偏移位置的值
  用于例子中unset()函数的使用。

使用场合

用于配置的自动加载
Config .class.php

class Config implements \ArrayAccess {

    protected $path;
    protected $configs = array();

    // 传入配置文件目录
    public function  __construct($path)
    {
        $this -> path = $path;
    }

    public function offsetExists($key)
    {
        return isset($this -> configs[$key]);
    }

    public function offsetGet($key)
    {
        if(empty($this -> configs[$key]))
        {
            $file_path = $this -> path . '/' . $key . '.php';
            $config = require_once $file_path;
            $this -> configs[$key] = $config;
        }
        return  $this -> configs[$key];
    }

    public function offsetSet($offset, $value)
    {
        // 不能修改配置
        throw new \Exception("cannot write config file");
    }

    public function offsetUnset($key)
    {
        unset($this -> configs[$key]);
    }
}

Conf/Controller.php

return array(
    'dbhost' => '127.0.0.1',
    'dbuser' => 'root',
    'dbpsw' => '',
    'dbname' => '',
    'dbcharset' => 'utf8'
);

$config = new Config('Conf');
$arr_config = $config['Controller'];
var_dump($arr_config);
// 获取到Conf/Controller.php中的数据