ILIAS\BackgroundTasks\Bucket Interface Reference

Inheritance diagram for ILIAS\BackgroundTasks\Bucket:

Collaboration diagram for ILIAS\BackgroundTasks\Bucket:

Public Member Functions
	getUserId ()
	setUserId ($user_id)
	setPercentage (Task $task, $percentage)
	Used by a job to notify his percentage. More...
	getOverallPercentage ()
	setOverallPercentage ($percentage)
	setCurrentTask ($task)
	getCurrentTask ()
	setTask (Task $task)
	getTask ()
	setState ($state)
	getState ()
	checkIntegrity ()
	userInteraction (Option $option)
	Let the user interact with the bucket task queue. More...
	getDescription ()
	getTitle ()
	heartbeat ()
	There was something going on in the bucket, it's still working. More...
	setLastHeartbeat ($timestamp)
	getLastHeartbeat ()
	When was the last time that something happened on this bucket? More...
	getUserId ()
	setUserId ($user_id)
	getOverallPercentage ()
	setOverallPercentage ($percentage)
	setState ($state)
	getState ()
	getDescription ()
	getTitle ()

Detailed Description

Definition at line 15 of file Bucket.php.

Member Function Documentation

checkIntegrity()

ILIAS\BackgroundTasks\Bucket::checkIntegrity

(

)

Returns

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

Exceptions

Exception

Implemented in ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket.

Referenced by ILIAS\BackgroundTasks\Implementation\Persistence\BasicPersistence\saveBucketAndItsTasks().

Here is the caller graph for this function:

getCurrentTask()

ILIAS\BackgroundTasks\Bucket::getCurrentTask

(

)

Returns

Task

Implemented in ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket.

Referenced by ilBTPopOverGUI\getItemForObserver(), ILIAS\BackgroundTasks\Implementation\Persistence\BasicPersistence\saveObserver(), and ILIAS\BackgroundTasks\Implementation\Persistence\BasicPersistence\updateBucket().

Here is the caller graph for this function:

getDescription()

ILIAS\BackgroundTasks\Bucket::getDescription

(

)

Returns

string

Implements ILIAS\BackgroundTasks\BucketMeta.

Implemented in ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket.

Referenced by ILIAS\BackgroundTasks\Implementation\Persistence\BasicPersistence\saveObserver(), and ILIAS\BackgroundTasks\Implementation\Persistence\BasicPersistence\updateBucket().

Here is the caller graph for this function:

getLastHeartbeat()

ILIAS\BackgroundTasks\Bucket::getLastHeartbeat

(

)

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

Returns

int Timestamp.

Implemented in ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket.

Referenced by ilBTPopOverGUI\getItemForObserver(), and ILIAS\BackgroundTasks\Implementation\Persistence\BasicPersistence\updateBucket().

Here is the caller graph for this function:

getOverallPercentage()

ILIAS\BackgroundTasks\Bucket::getOverallPercentage

(

)

Returns

integer

Implements ILIAS\BackgroundTasks\BucketMeta.

Implemented in ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket.

Referenced by ilBTPopOverGUI\getProgressbar(), ILIAS\BackgroundTasks\Implementation\Persistence\BasicPersistence\saveObserver(), and ILIAS\BackgroundTasks\Implementation\Persistence\BasicPersistence\updateBucket().

Here is the caller graph for this function:

getState()

ILIAS\BackgroundTasks\Bucket::getState

(

)

Returns

int

Implements ILIAS\BackgroundTasks\BucketMeta.

Implemented in ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket.

Referenced by ILIAS\BackgroundTasks\Implementation\TaskManager\BasicTaskManager\continueTask(), ilBTPopOverGUI\getItemForObserver(), ilBTPopOverGUI\getProgressbar(), ILIAS\BackgroundTasks\Implementation\Persistence\BasicPersistence\saveObserver(), and ILIAS\BackgroundTasks\Implementation\Persistence\BasicPersistence\updateBucket().

Here is the caller graph for this function:

getTask()

ILIAS\BackgroundTasks\Bucket::getTask

(

)

Returns

Task

Implemented in ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket.

Referenced by ILIAS\BackgroundTasks\Implementation\TaskManager\AsyncTaskManager\run(), ILIAS\BackgroundTasks\Implementation\TaskManager\SyncTaskManager\run(), ILIAS\BackgroundTasks\Implementation\Persistence\BasicPersistence\saveObserver(), and ILIAS\BackgroundTasks\Implementation\Persistence\BasicPersistence\updateBucket().

Here is the caller graph for this function:

getTitle()

ILIAS\BackgroundTasks\Bucket::getTitle

(

)

Returns

string

Implements ILIAS\BackgroundTasks\BucketMeta.

Implemented in ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket.

Referenced by ilBTPopOverGUI\getItemForObserver(), ILIAS\BackgroundTasks\Implementation\Persistence\BasicPersistence\saveObserver(), and ILIAS\BackgroundTasks\Implementation\Persistence\BasicPersistence\updateBucket().

Here is the caller graph for this function:

getUserId()

ILIAS\BackgroundTasks\Bucket::getUserId

(

)

Returns

int

Implements ILIAS\BackgroundTasks\BucketMeta.

Implemented in ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket.

Referenced by ILIAS\BackgroundTasks\Implementation\Persistence\BasicPersistence\saveObserver(), and ILIAS\BackgroundTasks\Implementation\Persistence\BasicPersistence\updateBucket().

Here is the caller graph for this function:

heartbeat()

ILIAS\BackgroundTasks\Bucket::heartbeat

(

)

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

Returns

void

Implemented in ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket.

setCurrentTask()

ILIAS\BackgroundTasks\Bucket::setCurrentTask

(

$task

)

Parameters

Task

$task

Returns

mixed

Implemented in ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket.

Referenced by ILIAS\BackgroundTasks\Implementation\TaskManager\AsyncTaskManager\run(), ILIAS\BackgroundTasks\Implementation\TaskManager\SyncTaskManager\run(), and ILIAS\BackgroundTasks\Implementation\Persistence\BasicPersistence\saveObserver().

Here is the caller graph for this function:

setLastHeartbeat()

ILIAS\BackgroundTasks\Bucket::setLastHeartbeat

(

$timestamp

)

Parameters

$timestamp

int

Returns

void

Implemented in ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket.

setOverallPercentage()

ILIAS\BackgroundTasks\Bucket::setOverallPercentage

(

$percentage

)

Parameters

$percentage

int

Implements ILIAS\BackgroundTasks\BucketMeta.

Implemented in ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket.

setPercentage()

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

Used by a job to notify his percentage.

Parameters

$task	Task
$percentage	int

Implemented in ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket.

setState()

ILIAS\BackgroundTasks\Bucket::setState

(

$state

)

Parameters

$state

int From Observer\State

Returns

void

Implements ILIAS\BackgroundTasks\BucketMeta.

Implemented in ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket.

Referenced by ilSumOfWorkspaceFileSizesTooLargeInteraction\interaction(), ilSumOfFileSizesTooLargeInteraction\interaction(), ILIAS\BackgroundTasks\Implementation\TaskManager\AsyncTaskManager\run(), and ILIAS\BackgroundTasks\Implementation\TaskManager\SyncTaskManager\run().

Here is the caller graph for this function:

setTask()

ILIAS\BackgroundTasks\Bucket::setTask

(

Task

$task

)

Parameters

Task

$task

Returns

void

Implemented in ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket.

setUserId()

ILIAS\BackgroundTasks\Bucket::setUserId

(

$user_id

)

Parameters

int

$user_id

Implements ILIAS\BackgroundTasks\BucketMeta.

Implemented in ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket.

userInteraction()

ILIAS\BackgroundTasks\Bucket::userInteraction

(

Option

$option

)

Let the user interact with the bucket task queue.

Parameters

Option

$option

Returns

void

Implemented in ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket.

Referenced by ILIAS\BackgroundTasks\Implementation\TaskManager\BasicTaskManager\continueTask().

Here is the caller graph for this function:

---

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

• src/BackgroundTasks/Bucket.php