ILIAS\BackgroundTasks\Dependencies\Injector Class Reference

Collaboration diagram for ILIAS\BackgroundTasks\Dependencies\Injector:

Public Member Functions
	__construct (Container $dic, DependencyMap $dependencyMap)
	Factory constructor. More...
	createInstance (string $fullyQualifiedClassName, bool $requireFile=false, callable $with=null)

Protected Member Functions
	createConstructorArguments (string $fullyQualifiedClassName, array $parameters, ?callable $with)
	getDependency (string $fullyQualifiedClassName, ReflectionParameter $parameter, ?callable $with=null)

Protected Attributes
ILIAS DI Container	$dic
ILIAS BackgroundTasks Dependencies DependencyMap DependencyMap	$dependencyMap

Detailed Description

Definition at line 32 of file Injector.php.

Constructor & Destructor Documentation

__construct()

ILIAS\BackgroundTasks\Dependencies\Injector::__construct	(	Container	$dic,
		DependencyMap	$dependencyMap
	)

Factory constructor.

Parameters

$dic

Container

Definition at line 41 of file Injector.php.

    {
        $this->dic = $dic;
        $this->dependencyMap = $dependencyMap;
    }

References ILIAS\BackgroundTasks\Dependencies\Injector\$dependencyMap, and ILIAS\BackgroundTasks\Dependencies\Injector\$dic.

Member Function Documentation

createConstructorArguments()

ILIAS\BackgroundTasks\Dependencies\Injector::createConstructorArguments ( string  $fullyQualifiedClassName, array  $parameters, ?callable  $with  )

protected

Parameters

ReflectionParameter[]

$parameters

Definition at line 76 of file Injector.php.

     : array {
        $constructorArguments = [];
 
        foreach ($parameters as $parameter) {
            // As long as there are given arguments we take those.
            $constructorArguments[] = $this->getDependency($fullyQualifiedClassName, $parameter, $with);
        }
 
        return $constructorArguments;
    }

createInstance()

ILIAS\BackgroundTasks\Dependencies\Injector::createInstance	(	string	$fullyQualifiedClassName,
		bool	$requireFile = false,
		callable	$with = null
	)

Parameters

string

$fullyQualifiedClassName

The given class must type hint all its constructor arguments. Furthermore the types must exist in the DI-Container.

Definition at line 52 of file Injector.php.

     : object {
        // The reflection classes needed.
        $reflectionClass = new \ReflectionClass($fullyQualifiedClassName);
        $constructor = $reflectionClass->getConstructor();
        if ($constructor === null) {
            return $reflectionClass->newInstance();
        }
 
        $parameters = $constructor->getParameters();
 
        // we get the arguments to construct the object from the DIC and Typehinting.
        $constructorArguments = $this->createConstructorArguments($fullyQualifiedClassName, $parameters, $with);
 
        // Crate the instance with the arguments.
        return $reflectionClass->newInstanceArgs($constructorArguments);
    }

getDependency()

ILIAS\BackgroundTasks\Dependencies\Injector::getDependency ( string  $fullyQualifiedClassName, ReflectionParameter  $parameter, ?callable  $with = null  )

protected

Exceptions

InvalidClassException

Definition at line 94 of file Injector.php.

      {
        // These Lines are currently commented while we cant use $parameter->getType() which will be part of PHP7
        //              if (!$parameter->getType()) {
        //                      throw new InvalidClassException("The constructor of $fullyQualifiedClassName is not fully type hinted, or the type hints cannot be resolved.");
        //              }
 
        //              $type = $parameter->getType()->__toString();
        $type = $parameter->getClass()->getName();
 
        //              if ($parameter->getType()->isBuiltin()) {
        //                      throw new InvalidClassException("The DI cannot instantiate $fullyQualifiedClassName because some of the constructors arguments are built in types. Only interfaces (and objects) are stored in the DI-Container.");
        //              }
 
        if (!$type) {
            throw new InvalidClassException("The DI cannot instantiate $fullyQualifiedClassName because some of the constructors arguments are not type hinted. Make sure all parameters in the constructor have type hinting.");
        }
 
        if ($with) {
            return $this->dependencyMap->getDependencyWith($this->dic, $type, $fullyQualifiedClassName, $with);
        } else {
            return $this->dependencyMap->getDependency($this->dic, $type, $fullyQualifiedClassName);
        }
    }

References $type.

Field Documentation

$dependencyMap

ILIAS BackgroundTasks Dependencies DependencyMap DependencyMap ILIAS\BackgroundTasks\Dependencies\Injector::$dependencyMap

protected

Definition at line 35 of file Injector.php.

Referenced by ILIAS\BackgroundTasks\Dependencies\Injector\__construct().

$dic

ILIAS DI Container ILIAS\BackgroundTasks\Dependencies\Injector::$dic

protected

Definition at line 34 of file Injector.php.

Referenced by ILIAS\BackgroundTasks\Dependencies\Injector\__construct().

---

The documentation for this class was generated from the following file:

• src/BackgroundTasks/Dependencies/Injector.php