DiContainer.php

Go to the documentation of this file.

<?php

namespace Elgg\Di;

use DI\Container;
use DI\ContainerBuilder;

abstract class DiContainer extends Container {

    public function __get($name) {
        $service = $this->get($name);
        
        // get the traits implemented directly by the service
        $traits = class_uses($service, true);
        
        // check for certain global cases
        if (in_array(\Elgg\Traits\Debug\Profilable::class, $traits) && !$service->hasTimer()) {
            // profiling is supported
            if ($service instanceof \Elgg\Database) {
                // the database uses a different config flag to enable profiling
                if ($this->config->profiling_sql) {
                    // need to get the timer from the InternalContainer
                    // especially if the current DiContainer is the PublicContainer
                    $service->setTimer(_elgg_services()->timer);
                }
            } elseif ($this->config->enable_profiling) {
                // need to get the timer from the InternalContainer
                // especially if the current DiContainer is the PublicContainer
                $service->setTimer(_elgg_services()->timer);
            }
        }
        
        return $service;
    }

    public function __set($name, $value) {
        // prevent setting of class variables using container->service
        $this->set($name, $value);
    }

    public function set(string $name, $value) {
        parent::set($name, $value);
        
        if (is_object($value)) {
            // need to also reset related class name as it is also stored as a reference for autowired classes
            // this happens for example in the installer where the plugins service is autowired with 'old' config (found by classname) as config by name is set
            $this->reset(get_class($value));
        }
    }

    public function reset(string $name): void {
        if (!isset($this->resolvedEntries[$name])) {
            return;
        }
        
        $value = $this->resolvedEntries[$name];
        
        unset($this->resolvedEntries[$name]);
        if (is_object($value)) {
            // need to also reset related class name as it is also stored as a reference for autowired classes
            unset($this->resolvedEntries[get_class($value)]);
        }
    }

    public static function factory(array $options = []) {
        $dic_builder = new ContainerBuilder(static::class);
        $dic_builder->useAnnotations(false);
        
        foreach (static::getDefinitionSources() as $location) {
            $dic_builder->addDefinitions($location);
        }
        
        return $dic_builder->build();
    }

    abstract public static function getDefinitionSources(): array;
}