All tasks and values the components contribute via $contribute[\ILIAS\BackgroundTasks\Task::class] and $contribute[\ILIAS\BackgroundTasks\Value::class].
More...
Inheritance diagram for ILIAS\BackgroundTasks\Registry\Registry:
Collaboration diagram for ILIAS\BackgroundTasks\Registry\Registry:
Public Member Functions | |
| isRegistered (string $class_name) | |
| newTask (string $class_name) | |
| newValue (string $class_name) | |
Detailed Description
All tasks and values the components contribute via $contribute[\ILIAS\BackgroundTasks\Task::class] and $contribute[\ILIAS\BackgroundTasks\Value::class].
Buckets store their tasks and values by class name, so every class a component puts into a bucket must be contributed, including deprecated names that buckets created before an update may still reference. The contributed instance serves as prototype, each task or value of a bucket is a clone of it, so a contribution must not carry state of a single bucket.
A component that renames or moves one of its tasks or values is itself responsible for keeping stored buckets loadable. BackgroundTasks does not migrate stored class names, and no other component must write them. Keep the former name as an empty, deprecated subclass of the new class, contribute both, and remove the former name with the next major release.
Definition at line 42 of file Registry.php.
Member Function Documentation
◆ isRegistered()
| ILIAS\BackgroundTasks\Registry\Registry::isRegistered | ( | string | $class_name | ) |
Implemented in ILIAS\BackgroundTasks\Implementation\Registry\BasicRegistry.
◆ newTask()
| ILIAS\BackgroundTasks\Registry\Registry::newTask | ( | string | $class_name | ) |
- Exceptions
-
OutOfBoundsException if no task with this class name is registered
Implemented in ILIAS\BackgroundTasks\Implementation\Registry\BasicRegistry.
◆ newValue()
| ILIAS\BackgroundTasks\Registry\Registry::newValue | ( | string | $class_name | ) |
- Exceptions
-
OutOfBoundsException if no value with this class name is registered
Implemented in ILIAS\BackgroundTasks\Implementation\Registry\BasicRegistry.
The documentation for this interface was generated from the following file:
- components/ILIAS/BackgroundTasks/src/Registry/Registry.php
