DiContainer.php

Go to the documentation of this file.

<?php

class Elgg_Di_DiContainer {

    protected $factories = array();

    protected $cache = array();

    const CLASS_NAME_PATTERN_52 = '/^[a-z_\x7f-\xff][a-z0-9_\x7f-\xff]*$/i';
    const CLASS_NAME_PATTERN_53 = '/^(\\\\?[a-z_\x7f-\xff][a-z0-9_\x7f-\xff]*)+$/i';

    public function __get($name) {
        if (array_key_exists($name, $this->cache)) {
            return $this->cache[$name];
        }
        if (!isset($this->factories[$name])) {
            throw new Elgg_Di_MissingValueException("Value or factory was not set for: $name");
        }
        $value = $this->build($this->factories[$name]['callable'], $name);

        // Why check existence of factory here? A: the builder function may have set the value
        // directly, in which case the factory will no longer exist.
        if (!empty($this->factories[$name]) && $this->factories[$name]['shared']) {
            $this->cache[$name] = $value;
        }
        return $value;
    }

    protected function build($factory, $name) {
        if (is_callable($factory)) {
            return call_user_func($factory, $this);
        }
        $msg = "Factory for '$name' was uncallable";
        if (is_string($factory)) {
            $msg .= ": '$factory'";
        } elseif (is_array($factory)) {
            if (is_string($factory[0])) {
                $msg .= ": '{$factory[0]}::{$factory[1]}'";
            } else {
                $msg .= ": " . get_class($factory[0]) . "->{$factory[1]}";
            }
        }
        throw new Elgg_Di_FactoryUncallableException($msg);
    }

    public function setValue($name, $value) {
        $this->remove($name);
        $this->cache[$name] = $value;
        return $this;
    }

    public function setFactory($name, $callable, $shared = true) {
        if (!is_callable($callable, true)) {
            throw new InvalidArgumentException('$factory must appear callable');
        }
        $this->remove($name);
        $this->factories[$name] = array(
            'callable' => $callable,
            'shared' => $shared
        );
        return $this;
    }

    public function setClassName($name, $class_name, $shared = true) {
        $classname_pattern = version_compare(PHP_VERSION, '5.3', '<') ? self::CLASS_NAME_PATTERN_52 : self::CLASS_NAME_PATTERN_53;
        if (!is_string($class_name) || !preg_match($classname_pattern, $class_name)) {
            throw new InvalidArgumentException('Class names must be valid PHP class names');
        }
        $func = create_function('', "return new $class_name();");
        return $this->setFactory($name, $func, $shared);
    }

    public function remove($name) {
        unset($this->cache[$name]);
        unset($this->factories[$name]);
        return $this;
    }

    public function has($name) {
        return isset($this->factories[$name]) || array_key_exists($name, $this->cache);
    }
}