ILIAS\BackgroundTasks\Implementation\Registry\BasicRegistry Class Reference

Inheritance diagram for ILIAS\BackgroundTasks\Implementation\Registry\BasicRegistry:

Collaboration diagram for ILIAS\BackgroundTasks\Implementation\Registry\BasicRegistry:

Public Member Functions
	__construct (array $tasks, array $values)
	isRegistered (string $class_name)
	newTask (string $class_name)
	newValue (string $class_name)
	isRegistered (string $class_name)
	newTask (string $class_name)
	newValue (string $class_name)

Private Member Functions
	unique (Task|Value $prototype)

Private Attributes
array	$tasks = []
array	$values = []

Detailed Description

Definition at line 26 of file BasicRegistry.php.

Constructor & Destructor Documentation

__construct()

ILIAS\BackgroundTasks\Implementation\Registry\BasicRegistry::__construct	(	array	$tasks,
		array	$values
	)

Parameters

Task[]	$tasks
Value[]	$values

Definition at line 42 of file BasicRegistry.php.

    {
        foreach ($tasks as $task) {
            $this->tasks[$this->unique($task)] = $task;
        }
        foreach ($values as $value) {
            $this->values[$this->unique($value)] = $value;
        }
    }

References ILIAS\BackgroundTasks\Implementation\Registry\BasicRegistry\$tasks, ILIAS\BackgroundTasks\Implementation\Registry\BasicRegistry\$values, and ILIAS\BackgroundTasks\Implementation\Registry\BasicRegistry\unique().

Here is the call graph for this function:

Member Function Documentation

isRegistered()

ILIAS\BackgroundTasks\Implementation\Registry\BasicRegistry::isRegistered

(

string

$class_name

)

Implements ILIAS\BackgroundTasks\Registry\Registry.

Definition at line 52 of file BasicRegistry.php.

                                                    : bool
    {
        $class_name = ltrim($class_name, '\\');
        return isset($this->tasks[$class_name]) || isset($this->values[$class_name]);
    }

newTask()

ILIAS\BackgroundTasks\Implementation\Registry\BasicRegistry::newTask

(

string

$class_name

)

Exceptions

OutOfBoundsException if no task with this class name is registered

Implements ILIAS\BackgroundTasks\Registry\Registry.

Definition at line 58 of file BasicRegistry.php.

                                               : Task
    {
        $class_name = ltrim($class_name, '\\');
        if (!isset($this->tasks[$class_name])) {
            throw new \OutOfBoundsException("No task $class_name is registered.");
        }
        return clone $this->tasks[$class_name];
    }

newValue()

ILIAS\BackgroundTasks\Implementation\Registry\BasicRegistry::newValue

(

string

$class_name

)

Exceptions

OutOfBoundsException if no value with this class name is registered

Implements ILIAS\BackgroundTasks\Registry\Registry.

Definition at line 67 of file BasicRegistry.php.

                                                : Value
    {
        $class_name = ltrim($class_name, '\\');
        if (!isset($this->values[$class_name])) {
            throw new \OutOfBoundsException("No value $class_name is registered.");
        }
        return clone $this->values[$class_name];
    }

unique()

ILIAS\BackgroundTasks\Implementation\Registry\BasicRegistry::unique ( Task|Value  $prototype )

private

Definition at line 76 of file BasicRegistry.php.

                                                  : string
    {
        $class_name = $prototype::class;
        if (isset($this->tasks[$class_name]) || isset($this->values[$class_name])) {
            throw new \LogicException("$class_name is contributed more than once.");
        }
        return $class_name;
    }

Referenced by ILIAS\BackgroundTasks\Implementation\Registry\BasicRegistry\__construct().

Here is the caller graph for this function:

Field Documentation

$tasks

array ILIAS\BackgroundTasks\Implementation\Registry\BasicRegistry::$tasks = []

private

Definition at line 31 of file BasicRegistry.php.

Referenced by ILIAS\BackgroundTasks\Implementation\Registry\BasicRegistry\__construct().

$values

array ILIAS\BackgroundTasks\Implementation\Registry\BasicRegistry::$values = []

private

Definition at line 36 of file BasicRegistry.php.

Referenced by ILIAS\BackgroundTasks\Implementation\Registry\BasicRegistry\__construct().

---

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

• components/ILIAS/BackgroundTasks/src/Implementation/Registry/BasicRegistry.php