ILIAS\BackgroundTasks\Persistence Interface Reference

Inheritance diagram for ILIAS\BackgroundTasks\Persistence:

Collaboration diagram for ILIAS\BackgroundTasks\Persistence:

Public Member Functions
	saveBucketAndItsTasks (Bucket $bucket)
	getBucketIdsOfUser (int $user_id, string $order_by="id", string $order_direction="ASC")
	getBucketIdsByState (int $state)
	loadBucket (int $bucket_container_id)
	loadBuckets (array $bucket_container_ids)
	deleteBucketById (int $bucket_id)
	Deletes the Observer AND all its tasks and values. More...
	deleteBucket (Bucket $bucket)
	Delete the bucket and all its stuff. More...
	updateBucket (Bucket $bucket)
	Updates only the bucket! Use this if e.g. More...
	getBucketContainerId (Bucket $bucket)
	getBucketMetaOfUser (int $user_id)

Detailed Description

Definition at line 27 of file Persistence.php.

Member Function Documentation

deleteBucket()

ILIAS\BackgroundTasks\Persistence::deleteBucket

(

Bucket

$bucket

)

Delete the bucket and all its stuff.

Implemented in ILIAS\BackgroundTasks\Implementation\Persistence\BasicPersistence.

Referenced by ILIAS\BackgroundTasks\Implementation\TaskManager\AsyncTaskManager\runAsync().

Here is the caller graph for this function:

deleteBucketById()

ILIAS\BackgroundTasks\Persistence::deleteBucketById

(

int

$bucket_id

)

Deletes the Observer AND all its tasks and values.

Referenced by ILIAS\BackgroundTasks\Implementation\Persistence\BasicPersistence\deleteBucket(), ILIAS\BackgroundTasks\Implementation\Persistence\BasicPersistence\getValueContainerId(), and ILIAS\BackgroundTasks\Implementation\Persistence\BasicPersistence\loadBuckets().

Here is the caller graph for this function:

getBucketContainerId()

ILIAS\BackgroundTasks\Persistence::getBucketContainerId

(

Bucket

$bucket

)

Returns

int Returns the container id of an observer.

Implemented in ILIAS\BackgroundTasks\Implementation\Persistence\BasicPersistence.

getBucketIdsByState()

ILIAS\BackgroundTasks\Persistence::getBucketIdsByState

(

int

$state

)

Returns

int[] Returns a list of bucket ids for the given Observer State

Implemented in ILIAS\BackgroundTasks\Implementation\Persistence\BasicPersistence.

Referenced by ILIAS\BackgroundTasks\Implementation\TaskManager\AsyncTaskManager\runAsync().

Here is the caller graph for this function:

getBucketIdsOfUser()

ILIAS\BackgroundTasks\Persistence::getBucketIdsOfUser	(	int	$user_id,
		string	$order_by = "id",
		string	$order_direction = "ASC"
	)

Returns

[] Returns an array of bucket ids for the given user Id.

Implemented in ILIAS\BackgroundTasks\Implementation\Persistence\BasicPersistence.

getBucketMetaOfUser()

ILIAS\BackgroundTasks\Persistence::getBucketMetaOfUser

(

int

$user_id

)

Returns

BucketMeta[]

Implemented in ILIAS\BackgroundTasks\Implementation\Persistence\BasicPersistence.

loadBucket()

ILIAS\BackgroundTasks\Persistence::loadBucket

(

int

$bucket_container_id

)

Referenced by ILIAS\BackgroundTasks\Implementation\Persistence\BasicPersistence\getValueContainerId(), ILIAS\BackgroundTasks\Implementation\Persistence\BasicPersistence\loadBuckets(), and ILIAS\BackgroundTasks\Implementation\TaskManager\AsyncTaskManager\runAsync().

Here is the caller graph for this function:

loadBuckets()

ILIAS\BackgroundTasks\Persistence::loadBuckets

(

array

$bucket_container_ids

)

Returns

Bucket[]

Implemented in ILIAS\BackgroundTasks\Implementation\Persistence\BasicPersistence.

saveBucketAndItsTasks()

ILIAS\BackgroundTasks\Persistence::saveBucketAndItsTasks

(

Bucket

$bucket

)

Parameters

Bucket

$bucket

The bucket you want to save.

Implemented in ILIAS\BackgroundTasks\Implementation\Persistence\BasicPersistence.

updateBucket()

ILIAS\BackgroundTasks\Persistence::updateBucket

(

Bucket

$bucket

)

Updates only the bucket! Use this if e.g.

the percentage or the current task changes.

Implemented in ILIAS\BackgroundTasks\Implementation\Persistence\BasicPersistence.

---

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

• components/ILIAS/BackgroundTasks/src/Persistence.php