ILIAS\Component\Dependencies\Reader Class Reference

Collaboration diagram for ILIAS\Component\Dependencies\Reader:

Public Member Functions
	read (Component $component)

Protected Member Functions
	addDefine ($_, $name)
	addImplement (int $i, string $name, $value)
	cacheImplement (string $name, $value)
	addUse (string $name)
	addContribute (int $i, string $name, $value)
	cacheContribute (string $name, $value)
	addSeek (string $name)
	addProvide (int $i, string $name, $value)
	cacheProvide (string $name, $value)
	addPull (string $name)
	addInternalOut (string $name, $value)
	cacheInternalOut (string $name, $value)
	resolveInternalOut (string $name)
	addInternalIn (string $name)
	populateTempArrays ()
	flushTempArrays ()
	resolveDependencies ()
	compileResult (Component $component)
	createMock (string $class_name)

Protected Attributes
array	$defines
array	$implements
array	$uses
array	$uses_temp = []
array	$contributes
array	$seeks
array	$seeks_temp = []
array	$provides
array	$pulls
array	$pulls_temp = []
array	$internal_out
array	$internal_in
array	$internal_in_temp = []

Detailed Description

Definition at line 25 of file Reader.php.

Member Function Documentation

addContribute()

ILIAS\Component\Dependencies\Reader::addContribute ( int  $i, string  $name,   $value  )

protected

Definition at line 133 of file Reader.php.

References Vendor\Package\$d, ILIAS\Component\Dependencies\Reader\flushTempArrays(), and ILIAS\Component\Dependencies\Reader\populateTempArrays().

Referenced by ILIAS\Component\Dependencies\Reader\resolveDependencies().

    {
        if (!is_callable($value)) {
            throw new \LogicException(
                "\$implements must be set with a callable."
            );
        }

        $this->populateTempArrays();
        $impl = $value();
        $dependencies = $this->flushTempArrays();

        if (!$impl instanceof $name) {
            throw new \LogicException(
                "Contribution for $name does not implement the correct interface."
            );
        }

        $aux = [
            "position" => $i
        ];
        if ($impl instanceof \ILIAS\Component\EntryPoint) {
            $aux["entry_point_name"] = $impl->getName();
        }
        $d = new Out(OutType::CONTRIBUTE, $name, $aux, $dependencies);
        $this->contributes[$i] = $d;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addDefine()

ILIAS\Component\Dependencies\Reader::addDefine (   $_,   $name  )

protected

Definition at line 72 of file Reader.php.

References Vendor\Package\$d.

Referenced by ILIAS\Component\Dependencies\Reader\read().

    {
        if (!is_string($name) || !interface_exists($name)) {
            throw new \LogicException(
                "Only push interface-names into \$define."
            );
        }
        $d = new Define(new Name($name));
        $this->defines[] = $d;
    }

Here is the caller graph for this function:

addImplement()

ILIAS\Component\Dependencies\Reader::addImplement ( int  $i, string  $name,   $value  )

protected

Definition at line 83 of file Reader.php.

References Vendor\Package\$d, ILIAS\Component\Dependencies\Reader\flushTempArrays(), and ILIAS\Component\Dependencies\Reader\populateTempArrays().

Referenced by ILIAS\Component\Dependencies\Reader\resolveDependencies().

    {
        if (!is_callable($value)) {
            throw new \LogicException(
                "\$implements must be set with a callable."
            );
        }

        $this->populateTempArrays();
        $impl = $value();
        $dependencies = $this->flushTempArrays();

        if (!$impl instanceof $name) {
            throw new \LogicException(
                "Implementation for $name does not implement the correct interface."
            );
        }

        $aux = [
            "class" => get_class($impl),
            "position" => $i
        ];
        $d = new Out(OutType::IMPLEMENT, $name, $aux, $dependencies);
        $this->implements[$i] = $d;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addInternalIn()

ILIAS\Component\Dependencies\Reader::addInternalIn ( string  $name )

protected

Definition at line 267 of file Reader.php.

References Vendor\Package\$d, ILIAS\Component\Dependencies\INTERNAL, and ILIAS\Component\Dependencies\Reader\resolveInternalOut().

Referenced by ILIAS\Component\Dependencies\Reader\read().

    {
        if (is_null($this->internal_in_temp)) {
            throw new \LogicException(
                "getting from \$internal is only allowed when defining other dependencies"
            );
        }

        if (array_key_exists($name, $this->internal_in)) {
            $d = $this->internal_in[$name];
        } else {
            $d = new In(InType::INTERNAL, $name);
        }

        $this->internal_in_temp[0][$name] = $d;

        $this->resolveInternalOut($name);

        return $this->internal_out[$name][1];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addInternalOut()

ILIAS\Component\Dependencies\Reader::addInternalOut ( string  $name,   $value  )

protected

Definition at line 231 of file Reader.php.

References Vendor\Package\$d, ILIAS\Component\Dependencies\Reader\flushTempArrays(), ILIAS\Component\Dependencies\INTERNAL, null, and ILIAS\Component\Dependencies\Reader\populateTempArrays().

Referenced by ILIAS\Component\Dependencies\Reader\resolveInternalOut().

    {
        if (!is_callable($value)) {
            throw new \LogicException(
                "\$internal must be set with a callable."
            );
        }

        $this->populateTempArrays();
        $impl = $value();
        $dependencies = $this->flushTempArrays();

        $d = new Out(OutType::INTERNAL, $name, null, $dependencies);
        $this->internal_out[$name] = [$d, $impl];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addProvide()

ILIAS\Component\Dependencies\Reader::addProvide ( int  $i, string  $name,   $value  )

protected

Definition at line 185 of file Reader.php.

References Vendor\Package\$d, ILIAS\Component\Dependencies\Reader\flushTempArrays(), null, and ILIAS\Component\Dependencies\Reader\populateTempArrays().

Referenced by ILIAS\Component\Dependencies\Reader\resolveDependencies().

    {
        if (!is_callable($value)) {
            throw new \LogicException(
                "\$implements must be set with a callable."
            );
        }

        $this->populateTempArrays();
        $impl = $value();
        $dependencies = $this->flushTempArrays();

        if (!$impl instanceof $name) {
            throw new \LogicException(
                "Provision for $name does not implement the correct interface."
            );
        }

        $d = new Out(OutType::PROVIDE, $name, null, $dependencies);
        $this->provides[$i] = $d;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addPull()

ILIAS\Component\Dependencies\Reader::addPull ( string  $name )

protected

Definition at line 212 of file Reader.php.

References Vendor\Package\$d, and ILIAS\Component\Dependencies\Reader\createMock().

Referenced by ILIAS\Component\Dependencies\Reader\read().

    {
        if (empty($this->pulls_temp)) {
            throw new \LogicException(
                "\$pull is only allowed when defining other dependencies"
            );
        }

        if (array_key_exists($name, $this->pulls)) {
            $d = $this->pulls[$name];
        } else {
            $d = new In(InType::PULL, $name);
        }

        $this->pulls_temp[0][$name] = $d;

        return $this->createMock($name);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addSeek()

ILIAS\Component\Dependencies\Reader::addSeek ( string  $name )

protected

Definition at line 166 of file Reader.php.

References Vendor\Package\$d.

Referenced by ILIAS\Component\Dependencies\Reader\read().

    {
        if (empty($this->seeks_temp)) {
            throw new \LogicException(
                "\$seek is only allowed when defining other dependencies"
            );
        }

        if (array_key_exists($name, $this->seeks)) {
            $d = $this->seeks[$name];
        } else {
            $d = new In(InType::SEEK, $name);
        }

        $this->seeks_temp[0][$name] = $d;

        return [];
    }

Here is the caller graph for this function:

addUse()

ILIAS\Component\Dependencies\Reader::addUse ( string  $name )

protected

Definition at line 114 of file Reader.php.

References Vendor\Package\$d, and ILIAS\Component\Dependencies\Reader\createMock().

Referenced by ILIAS\Component\Dependencies\Reader\read().

    {
        if (empty($this->uses_temp)) {
            throw new \LogicException(
                "\$use is only allowed when defining other dependencies"
            );
        }

        if (array_key_exists($name, $this->uses)) {
            $d = $this->uses[$name];
        } else {
            $d = new In(InType::USE, $name);
        }

        $this->uses_temp[0][$name] = $d;

        return $this->createMock($name);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

cacheContribute()

ILIAS\Component\Dependencies\Reader::cacheContribute ( string  $name,   $value  )

protected

Definition at line 161 of file Reader.php.

Referenced by ILIAS\Component\Dependencies\Reader\read().

    {
        $this->contributes[] = [$name, $value];
    }

Here is the caller graph for this function:

cacheImplement()

ILIAS\Component\Dependencies\Reader::cacheImplement ( string  $name,   $value  )

protected

Definition at line 109 of file Reader.php.

Referenced by ILIAS\Component\Dependencies\Reader\read().

    {
        $this->implements[] = [$name, $value];
    }

Here is the caller graph for this function:

cacheInternalOut()

ILIAS\Component\Dependencies\Reader::cacheInternalOut ( string  $name,   $value  )

protected

Definition at line 247 of file Reader.php.

Referenced by ILIAS\Component\Dependencies\Reader\read().

    {
        $this->internal_out[$name] = [$name, $value];
    }

Here is the caller graph for this function:

cacheProvide()

ILIAS\Component\Dependencies\Reader::cacheProvide ( string  $name,   $value  )

protected

Definition at line 207 of file Reader.php.

Referenced by ILIAS\Component\Dependencies\Reader\read().

    {
        $this->provides[] = [$name, $value];
    }

Here is the caller graph for this function:

compileResult()

ILIAS\Component\Dependencies\Reader::compileResult ( Component  $component )

protected

Definition at line 330 of file Reader.php.

References Vendor\Package\$a.

Referenced by ILIAS\Component\Dependencies\Reader\read().

                                                          : OfComponent
    {
        return new OfComponent(
            $component,
            ...array_merge(
                ...array_map(
                    "array_values",
                    [
                        $this->defines,
                        $this->implements,
                        $this->uses,
                        $this->contributes,
                        $this->seeks,
                        $this->provides,
                        $this->pulls,
                        array_map(fn($a) => $a[0], $this->internal_out),
                        $this->internal_in
                    ]
                )
            )
        );
    }

Here is the caller graph for this function:

createMock()

ILIAS\Component\Dependencies\Reader::createMock ( string  $class_name )

protected

Definition at line 353 of file Reader.php.

Referenced by ILIAS\Component\Dependencies\Reader\addPull(), and ILIAS\Component\Dependencies\Reader\addUse().

                                                     : object
    {
        $mock_builder = new \PHPUnit\Framework\MockObject\MockBuilder(new class ('dummy') extends \PHPUnit\Framework\TestCase {
            public function dummy()
            {
            }
        }, $class_name);
        return $mock_builder
            ->disableOriginalConstructor()
            ->disableOriginalClone()
            ->disableArgumentCloning()
            ->disallowMockingUnknownTypes()
            ->getMock();
    }

Here is the caller graph for this function:

flushTempArrays()

ILIAS\Component\Dependencies\Reader::flushTempArrays ( )

protected

Definition at line 296 of file Reader.php.

Referenced by ILIAS\Component\Dependencies\Reader\addContribute(), ILIAS\Component\Dependencies\Reader\addImplement(), ILIAS\Component\Dependencies\Reader\addInternalOut(), and ILIAS\Component\Dependencies\Reader\addProvide().

                                        : array
    {
        $uses_temp = array_shift($this->uses_temp);
        $seeks_temp = array_shift($this->seeks_temp);
        $pulls_temp = array_shift($this->pulls_temp);
        $internal_in_temp = array_shift($this->internal_in_temp);


        $this->uses = array_merge($this->uses, $uses_temp);
        $this->seeks = array_merge($this->seeks, $seeks_temp);
        $this->pulls = array_merge($this->pulls, $pulls_temp);
        $this->internal_in = array_merge($this->internal_in, $internal_in_temp);

        $dependencies = array_merge(...array_map("array_values", [$uses_temp, $seeks_temp, $pulls_temp, $internal_in_temp]));

        return $dependencies;
    }

Here is the caller graph for this function:

populateTempArrays()

ILIAS\Component\Dependencies\Reader::populateTempArrays ( )

protected

Definition at line 288 of file Reader.php.

Referenced by ILIAS\Component\Dependencies\Reader\addContribute(), ILIAS\Component\Dependencies\Reader\addImplement(), ILIAS\Component\Dependencies\Reader\addInternalOut(), and ILIAS\Component\Dependencies\Reader\addProvide().

                                           : void
    {
        array_unshift($this->uses_temp, []);
        array_unshift($this->seeks_temp, []);
        array_unshift($this->pulls_temp, []);
        array_unshift($this->internal_in_temp, []);
    }

Here is the caller graph for this function:

read()

ILIAS\Component\Dependencies\Reader::read

(

Component

$component

)

Returns

Dependency[]

Definition at line 44 of file Reader.php.

References ILIAS\Component\Dependencies\Reader\addDefine(), ILIAS\Component\Dependencies\Reader\addInternalIn(), ILIAS\Component\Dependencies\Reader\addPull(), ILIAS\Component\Dependencies\Reader\addSeek(), ILIAS\Component\Dependencies\Reader\addUse(), ILIAS\Component\Dependencies\Reader\cacheContribute(), ILIAS\Component\Dependencies\Reader\cacheImplement(), ILIAS\Component\Dependencies\Reader\cacheInternalOut(), ILIAS\Component\Dependencies\Reader\cacheProvide(), ILIAS\Component\Dependencies\Reader\compileResult(), ILIAS\Component\Component\init(), and ILIAS\Component\Dependencies\Reader\resolveDependencies().

                                              : OfComponent
    {
        $this->defines = [];
        $this->implements = [];
        $this->uses = [];
        $this->contributes = [];
        $this->seeks = [];
        $this->provides = [];
        $this->pulls = [];
        $this->internal_out = [];
        $this->internal_in = [];

        $probes = [
            new SetProbe(fn($n, $v) => $this->addDefine($n, $v)),
            new SetProbe(fn($n, $v) => $this->cacheImplement($n, $v)),
            new GetProbe(fn($n) => $this->addUse($n)),
            new SetProbe(fn($n, $v) => $this->cacheContribute($n, $v)),
            new GetProbe(fn($n) => $this->addSeek($n)),
            new SetProbe(fn($n, $v) => $this->cacheProvide($n, $v)),
            new GetProbe(fn($n) => $this->addPull($n)),
            new SetGetProbe(fn($n, $v) => $this->cacheInternalOut($n, $v), fn($n) => $this->addInternalIn($n))
        ];
        $component->init(...$probes);

        $this->resolveDependencies();
        return $this->compileResult($component);
    }

Here is the call graph for this function:

resolveDependencies()

ILIAS\Component\Dependencies\Reader::resolveDependencies ( )

protected

Definition at line 314 of file Reader.php.

References ILIAS\Component\Dependencies\Reader\addContribute(), ILIAS\Component\Dependencies\Reader\addImplement(), ILIAS\Component\Dependencies\Reader\addProvide(), and ILIAS\Component\Dependencies\Reader\resolveInternalOut().

Referenced by ILIAS\Component\Dependencies\Reader\read().

                                            : void
    {
        foreach ($this->implements as $i => $v) {
            $this->addImplement($i, ...$v);
        }
        foreach ($this->contributes as $i => $v) {
            $this->addContribute($i, ...$v);
        }
        foreach ($this->provides as $i => $v) {
            $this->addProvide($i, ...$v);
        }
        foreach (array_keys($this->internal_out) as $i) {
            $this->resolveInternalOut($i);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

resolveInternalOut()

ILIAS\Component\Dependencies\Reader::resolveInternalOut ( string  $name )

protected

Definition at line 252 of file Reader.php.

References ILIAS\Component\Dependencies\Reader\addInternalOut().

Referenced by ILIAS\Component\Dependencies\Reader\addInternalIn(), and ILIAS\Component\Dependencies\Reader\resolveDependencies().

    {
        if (!array_key_exists($name, $this->internal_out)) {
            throw new \LogicException(
                "Cannot resolve dependency \$internal[$name]. It either does not exist or is defined circular."
            );
        }

        if (!$this->internal_out[$name][0] instanceof Out) {
            $values = $this->internal_out[$name];
            unset($this->internal_out[$name]);
            $this->addInternalOut(...$values);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$contributes

array ILIAS\Component\Dependencies\Reader::$contributes

protected

Definition at line 31 of file Reader.php.

$defines

array ILIAS\Component\Dependencies\Reader::$defines

protected

Definition at line 27 of file Reader.php.

$implements

array ILIAS\Component\Dependencies\Reader::$implements

protected

Definition at line 28 of file Reader.php.

$internal_in

array ILIAS\Component\Dependencies\Reader::$internal_in

protected

Definition at line 38 of file Reader.php.

$internal_in_temp

array ILIAS\Component\Dependencies\Reader::$internal_in_temp = []

protected

Definition at line 39 of file Reader.php.

$internal_out

array ILIAS\Component\Dependencies\Reader::$internal_out

protected

Definition at line 37 of file Reader.php.

$provides

array ILIAS\Component\Dependencies\Reader::$provides

protected

Definition at line 34 of file Reader.php.

$pulls

array ILIAS\Component\Dependencies\Reader::$pulls

protected

Definition at line 35 of file Reader.php.

$pulls_temp

array ILIAS\Component\Dependencies\Reader::$pulls_temp = []

protected

Definition at line 36 of file Reader.php.

$seeks

array ILIAS\Component\Dependencies\Reader::$seeks

protected

Definition at line 32 of file Reader.php.

$seeks_temp

array ILIAS\Component\Dependencies\Reader::$seeks_temp = []

protected

Definition at line 33 of file Reader.php.

$uses

array ILIAS\Component\Dependencies\Reader::$uses

protected

Definition at line 29 of file Reader.php.

$uses_temp

array ILIAS\Component\Dependencies\Reader::$uses_temp = []

protected

Definition at line 30 of file Reader.php.

---

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

• components/ILIAS/Component/src/Dependencies/Reader.php