ILIAS  trunk Revision v11.0_alpha-1715-g7fc467680fb
All Data Structures Namespaces Files Functions Variables Enumerations Enumerator Modules Pages
Bucket.php
Go to the documentation of this file.
1 <?php
2 
19 namespace ILIAS\BackgroundTasks;
20 
23 
29 interface Bucket extends BucketMeta
30 {
31  public function getUserId(): int;
32 
33  public function setUserId(int $user_id): void;
34 
38  public function setPercentage(Task $task, int $percentage): void;
39 
40  public function getOverallPercentage(): int;
41 
42  public function setOverallPercentage(int $percentage): void;
43 
44  public function setCurrentTask(Task $task): void;
45 
46  public function getCurrentTask(): Task;
47 
48  public function hasCurrentTask(): bool;
49 
50  public function setTask(Task $task): void;
51 
52  public function getTask(): Task;
53 
54  public function setState(int $state): void;
55 
56  public function getState(): int;
57 
62  public function checkIntegrity(): bool;
63 
67  public function userInteraction(Option $option): void;
68 
69  public function getDescription(): string;
70 
71  public function getTitle(): string;
72 
76  public function heartbeat(): void;
77 
78  public function setLastHeartbeat(int $timestamp): void;
79 
83  public function getLastHeartbeat(): int;
84 }
setPercentage(Task $task, int $percentage)
Used by a job to notify his percentage.
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
setOverallPercentage(int $percentage)
getLastHeartbeat()
When was the last time that something happened on this bucket?
heartbeat()
There was something going on in the bucket, it&#39;s still working.
foreach($mandatory_scripts as $file) $timestamp
Definition: buildRTE.php:70
userInteraction(Option $option)
Let the user interact with the bucket task queue.
setLastHeartbeat(int $timestamp)