Inheritance diagram for ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket:

Collaboration diagram for ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket:

Public Member Functions
	getUserId ()

	setUserId (int $user_id)

	setPercentage (Task $task, int $percentage)

	setOverallPercentage (int $percentage)

	setCurrentTask (Task $task)

	setTask (Task $task)

	getOverallPercentage ()

	setState (int $state)

	getCurrentTask ()

	hasCurrentTask ()

	getTask ()

	getState ()

	checkIntegrity ()

	userInteraction (Option $option)

	getTitle ()

	setTitle (string $title)

	getDescription ()

	setDescription (string $description)

	heartbeat ()
	There was something going on in the bucket, it's still working. More...

	setLastHeartbeat (int $timestamp)

	getLastHeartbeat ()
	When was the last time that something happened on this bucket? More...

Public Member Functions inherited from ILIAS\BackgroundTasks\Bucket
	setPercentage (Task $task, int $percentage)
	Used by a job to notify his percentage. More...

	setCurrentTask (Task $task)

	setTask (Task $task)

	userInteraction (Option $option)
	Let the user interact with the bucket task queue. More...

Protected Member Functions
	replaceThunkValue (Task $currentTask, Value $resulting_value)
	In the structure of the task of this bucket the result of $currentTask is replaced with the $resulting_value. More...

Protected Attributes
int	$user_id

Task	$root_task

Task	$current_task

array	$tasks = []

int	$state

int	$total_number_of_tasks

array	$percentages = []

string	$title = ""

string	$description = ""

int	$percentage = 0

int	$last_heartbeat = 0

Detailed Description

Definition at line 30 of file BasicBucket.php.

Member Function Documentation

◆ checkIntegrity()

ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket::checkIntegrity ( )

Returns: bool Returns true if everything's alright. Throws an exception otherwise.

Exceptions

Exception

Implements ILIAS\BackgroundTasks\Bucket.

Definition at line 131 of file BasicBucket.php.

References ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket\getTask(), and ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket\getUserId().

                                     : bool
     {
         if ($this->getUserId() === 0) {
             foreach ($this->getTask()->unfoldTask() as $task) {
                 if ($task instanceof UserInteraction) {
                     throw new Exception("Your task contains user interactions and thus needs a user that observes the task.");
                 }
             }
         }
 
         return true;
     }

Here is the call graph for this function:

◆ getCurrentTask()

ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket::getCurrentTask ( )

Implements ILIAS\BackgroundTasks\Bucket.

Definition at line 111 of file BasicBucket.php.

References ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket\$current_task.

Referenced by ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket\userInteraction().

                                     : Task
     {
         return $this->current_task;
     }

Here is the caller graph for this function:

◆ getDescription()

ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket::getDescription ( )

Implements ILIAS\BackgroundTasks\Bucket.

Definition at line 203 of file BasicBucket.php.

References ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket\$description.

                                     : string
     {
         return $this->description;
     }

◆ getLastHeartbeat()

ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket::getLastHeartbeat ( )

When was the last time that something happened on this bucket?

Implements ILIAS\BackgroundTasks\Bucket.

Definition at line 227 of file BasicBucket.php.

References ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket\$last_heartbeat.

                                       : int
     {
         return $this->last_heartbeat;
     }

◆ getOverallPercentage()

ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket::getOverallPercentage ( )

Implements ILIAS\BackgroundTasks\Bucket.

Definition at line 101 of file BasicBucket.php.

References ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket\$percentage.

                                           : int
     {
         return $this->percentage;
     }

◆ getState()

ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket::getState ( )

Implements ILIAS\BackgroundTasks\Bucket.

Definition at line 126 of file BasicBucket.php.

References ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket\$state.

Referenced by ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket\userInteraction().

                               : int
     {
         return $this->state;
     }

Here is the caller graph for this function:

◆ getTask()

ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket::getTask ( )

Implements ILIAS\BackgroundTasks\Bucket.

Definition at line 121 of file BasicBucket.php.

References ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket\$root_task.

Referenced by ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket\checkIntegrity(), and ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket\replaceThunkValue().

                              : Task
     {
         return $this->root_task;
     }

Here is the caller graph for this function:

◆ getTitle()

ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket::getTitle ( )

Implements ILIAS\BackgroundTasks\Bucket.

Definition at line 193 of file BasicBucket.php.

References ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket\$title.

                               : string
     {
         return $this->title;
     }

◆ getUserId()

ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket::getUserId ( )

Implements ILIAS\BackgroundTasks\Bucket.

Definition at line 47 of file BasicBucket.php.

Referenced by ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket\checkIntegrity().

                                : int
     {
         return $this->user_id ?? 0;
     }

Here is the caller graph for this function:

◆ hasCurrentTask()

ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket::hasCurrentTask ( )

Implements ILIAS\BackgroundTasks\Bucket.

Definition at line 116 of file BasicBucket.php.

                                     : bool
     {
         return isset($this->current_task);
     }

◆ heartbeat()

ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket::heartbeat ( )

There was something going on in the bucket, it's still working.

Implements ILIAS\BackgroundTasks\Bucket.

Definition at line 216 of file BasicBucket.php.

                                : void
     {
         $now = new \DateTime('now', new \DateTimeZone('UTC'));
         $this->last_heartbeat = $now->getTimestamp();
     }

◆ replaceThunkValue()

ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket::replaceThunkValue	(	Task	$currentTask,
		Value	$resulting_value
	)

protected

In the structure of the task of this bucket the result of $currentTask is replaced with the $resulting_value.

Definition at line 176 of file BasicBucket.php.

References ILIAS\BackgroundTasks\Implementation\Values\AbstractValue\getParentTask(), and ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket\getTask().

Referenced by ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket\userInteraction().

                                                                                    : void
     {
         $tasks = $this->getTask()->unfoldTask();
 
         foreach ($tasks as $task) {
             $newInputs = [];
             foreach ($task->getInput() as $input) {
                 if ($input instanceof ThunkValue && $input->getParentTask() === $currentTask) {
                     $newInputs[] = $resulting_value;
                 } else {
                     $newInputs[] = $input;
                 }
             }
             $task->setInput($newInputs);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setCurrentTask()

ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket::setCurrentTask ( Task $task )

Definition at line 68 of file BasicBucket.php.

                                               : void
     {
         $this->current_task = $task;
     }

◆ setDescription()

ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket::setDescription ( string $description )

Definition at line 208 of file BasicBucket.php.

                                                        : void
     {
         $this->description = mb_substr($description, 0, 255);
     }

◆ setLastHeartbeat()

ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket::setLastHeartbeat ( int $timestamp )

Implements ILIAS\BackgroundTasks\Bucket.

Definition at line 222 of file BasicBucket.php.

References $timestamp.

                                                     : void
     {
         $this->last_heartbeat = $timestamp;
     }

◆ setOverallPercentage()

ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket::setOverallPercentage ( int $percentage )

Implements ILIAS\BackgroundTasks\Bucket.

Definition at line 63 of file BasicBucket.php.

References ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket\$percentage.

                                                          : void
     {
         $this->percentage = $percentage;
     }

◆ setPercentage()

ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket::setPercentage	(	Task	$task,
		int	$percentage
	)

Definition at line 57 of file BasicBucket.php.

References ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket\$percentage.

                                                               : void
     {
         $this->percentages[spl_object_hash($task)] = $percentage;
         $this->calculateOverallPercentage();
     }

◆ setState()

ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket::setState ( int $state )

Implements ILIAS\BackgroundTasks\Bucket.

Definition at line 106 of file BasicBucket.php.

References ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket\$state.

Referenced by ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket\userInteraction().

                                         : void
     {
         $this->state = $state;
     }

Here is the caller graph for this function:

◆ setTask()

ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket::setTask ( Task $task )

Definition at line 73 of file BasicBucket.php.

References ILIAS\BackgroundTasks\Task\unfoldTask().

                                        : void
     {
         $this->tasks = $task->unfoldTask();
         $this->total_number_of_tasks = count($this->tasks);
         $this->root_task = $task;
         foreach ($this->tasks as $subTask) {
             $this->percentages[spl_object_hash($subTask)] = 0;
         }
     }

Here is the call graph for this function:

◆ setTitle()

ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket::setTitle ( string $title )

Definition at line 198 of file BasicBucket.php.

References ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket\$title.

                                            : void
     {
         $this->title = $title;
     }

◆ setUserId()

ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket::setUserId ( int $user_id )

Implements ILIAS\BackgroundTasks\Bucket.

Definition at line 52 of file BasicBucket.php.

References ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket\$user_id.

                                            : void
     {
         $this->user_id = $user_id;
     }

◆ userInteraction()

ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket::userInteraction ( Option $option )

Exceptions

Exception

Definition at line 147 of file BasicBucket.php.

References ILIAS\UI\Implementation\Component\Input\$inputs, ILIAS\BackgroundTasks\Implementation\Bucket\State\FINISHED, ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket\getCurrentTask(), ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket\getState(), ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket\replaceThunkValue(), ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket\setState(), and ILIAS\BackgroundTasks\Implementation\Bucket\State\USER_INTERACTION.

                                                    : void
     {
         $currentTask = $this->getCurrentTask();
 
         if ($this->getState() != State::USER_INTERACTION) {
             throw new Exception("Cannot continue a task that is not in the state 'user interaction'");
         }
         if (!$currentTask instanceof UserInteraction) {
             // TODO: Maybe cleanup task?
             throw new Exception("Observer is in an invalid state! state: userInteraction but current task is not a user interaction!");
         }
 
         // From the current task we do the interaction.
         $inputs = $currentTask->getInput();
         $resulting_value = $currentTask->interaction($inputs, $option, $this);
 
         if ($currentTask === $this->root_task) {
             // If this user interaction was the last thing to do, we set the state to finished. We can throw away the resulting value.
             $this->setState(State::FINISHED);
         } else {
             // Then we replace the thunk value with the resulting value.
             $this->replaceThunkValue($currentTask, $resulting_value);
         }
     }

Here is the call graph for this function:

Field Documentation

◆ $current_task

Task ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket::$current_task

protected

Definition at line 34 of file BasicBucket.php.

Referenced by ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket\getCurrentTask().

◆ $description

string ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket::$description = ""

protected

Definition at line 43 of file BasicBucket.php.

Referenced by ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket\getDescription().

◆ $last_heartbeat

int ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket::$last_heartbeat = 0

protected

Definition at line 45 of file BasicBucket.php.

Referenced by ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket\getLastHeartbeat().

◆ $percentage

int ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket::$percentage = 0

protected

Definition at line 44 of file BasicBucket.php.

Referenced by ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket\getOverallPercentage(), ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket\setOverallPercentage(), and ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket\setPercentage().

◆ $percentages

array ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket::$percentages = []

protected

Definition at line 41 of file BasicBucket.php.

◆ $root_task

Task ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket::$root_task

protected

Definition at line 33 of file BasicBucket.php.

Referenced by ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket\getTask().

◆ $state

int ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket::$state

protected

Definition at line 39 of file BasicBucket.php.

Referenced by ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket\getState(), and ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket\setState().

◆ $tasks

array ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket::$tasks = []

protected

Definition at line 38 of file BasicBucket.php.

◆ $title

string ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket::$title = ""

protected

Definition at line 42 of file BasicBucket.php.

Referenced by ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket\getTitle(), and ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket\setTitle().

◆ $total_number_of_tasks

int ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket::$total_number_of_tasks

protected

Definition at line 40 of file BasicBucket.php.

◆ $user_id

int ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket::$user_id

protected

Definition at line 32 of file BasicBucket.php.

Referenced by ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket\setUserId().

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

components/ILIAS/BackgroundTasks/src/Implementation/Bucket/BasicBucket.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ checkIntegrity()

◆ getCurrentTask()

◆ getDescription()

◆ getLastHeartbeat()

◆ getOverallPercentage()

◆ getState()

◆ getTask()

◆ getTitle()

◆ getUserId()

◆ hasCurrentTask()

◆ heartbeat()

◆ replaceThunkValue()

◆ setCurrentTask()

◆ setDescription()

◆ setLastHeartbeat()

◆ setOverallPercentage()

◆ setPercentage()

◆ setState()

◆ setTask()

◆ setTitle()

◆ setUserId()

◆ userInteraction()

Field Documentation

◆ $current_task

◆ $description

◆ $last_heartbeat

◆ $percentage

◆ $percentages

◆ $root_task

◆ $state

◆ $tasks

◆ $title

◆ $total_number_of_tasks

◆ $user_id