DiContainer.php

Go to the documentation of this file.

<?php

namespace Elgg\Di;

class DiContainer {

    private $factories_ = [];

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

    public function __get($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->{$name} = $value;
        }
        return $value;
    }

    private 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) {
        if (substr($name, -1) === '_') {
            throw new \InvalidArgumentException('$name cannot end with "_"');
        }
        $this->{$name} = $value;
        return $this;
    }

    public function reset($name) {
        $this->{$name} = null;
        unset($this->{$name});
    }

    public function setFactory($name, $callable, $shared = true) {
        if (substr($name, -1) === '_') {
            throw new \InvalidArgumentException('$name cannot end with "_"');
        }
        if (!is_callable($callable, true)) {
            throw new \InvalidArgumentException('$factory must appear callable');
        }
        $this->remove($name);
        $this->factories_[$name] = [
            'callable' => $callable,
            'shared' => $shared,
        ];
        return $this;
    }

    public function setClassName($name, $class_name, $shared = true) {
        if (substr($name, -1) === '_') {
            throw new \InvalidArgumentException('$name cannot end with "_"');
        }
        $classname_pattern = 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 = function () use ($class_name) {
            return new $class_name();
        };
        return $this->setFactory($name, $func, $shared);
    }

    public function remove($name) {
        if (substr($name, -1) === '_') {
            throw new \InvalidArgumentException('$name cannot end with "_"');
        }
        unset($this->{$name});
        unset($this->factories_[$name]);
        return $this;
    }

    public function has($name) {
        if (isset($this->factories_[$name])) {
            return true;
        }
        if (substr($name, -1) === '_') {
            return false;
        }
        return (bool) property_exists($this, $name);
    }

    public function getNames() {
        $names = [];

        $refl = new \ReflectionObject($this);
        foreach ($refl->getProperties(\ReflectionProperty::IS_PUBLIC) as $prop) {
            $names[] = $prop->name;
        }
        foreach (array_keys($this->factories_) as $name) {
            $names[] = $name;
        }

        sort($names);
        return $names;
    }
}