Inheritance diagram for ILIAS\BackgroundTasks\Persistence:
Collaboration diagram for ILIAS\BackgroundTasks\Persistence:
Public Member Functions | |
| saveBucketAndItsTasks (Bucket $bucket) | |
| getBucketIdsOfUser ($user_id, $order_by="id", $order_direction="ASC") | |
| getBucketIdsByState ($state) | |
| loadBucket ($bucket_container_id) | |
| loadBuckets ($bucket_container_id) | |
| deleteBucketById ($bucket_id) | |
| Deletes the Observer AND all its tasks and values. More... | |
| deleteBucket ($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 ($user_id) | |
Detailed Description
Definition at line 13 of file Persistence.php.
Member Function Documentation
◆ deleteBucket()
| ILIAS\BackgroundTasks\Persistence::deleteBucket | ( | $bucket | ) |
Delete the bucket and all its stuff.
- Parameters
-
$bucket Bucket
- Returns
- void
Implemented in ILIAS\BackgroundTasks\Implementation\Persistence\BasicPersistence.
◆ deleteBucketById()
| ILIAS\BackgroundTasks\Persistence::deleteBucketById | ( | $bucket_id | ) |
Deletes the Observer AND all its tasks and values.
- Parameters
-
$bucket_id int
- Returns
- void
Referenced by ILIAS\BackgroundTasks\Implementation\Persistence\BasicPersistence\deleteBucket(), and ILIAS\BackgroundTasks\Implementation\Persistence\BasicPersistence\getValueContainerId().
Here is the caller graph for this function:
◆ getBucketContainerId()
| ILIAS\BackgroundTasks\Persistence::getBucketContainerId | ( | Bucket | $bucket | ) |
- Parameters
-
Bucket $bucket
- Returns
- int Returns the container id of an obvserver.
Implemented in ILIAS\BackgroundTasks\Implementation\Persistence\BasicPersistence.
◆ getBucketIdsByState()
| ILIAS\BackgroundTasks\Persistence::getBucketIdsByState | ( | $state | ) |
- Parameters
-
$state int
- Returns
- int[] Returns a list of bucket ids for the given Observer State
Implemented in ILIAS\BackgroundTasks\Implementation\Persistence\BasicPersistence.
◆ getBucketIdsOfUser()
| ILIAS\BackgroundTasks\Persistence::getBucketIdsOfUser | ( | $user_id, | |
$order_by = "id", |
|||
$order_direction = "ASC" |
|||
| ) |
- Parameters
-
int $user_id string $order_by string $order_direction
- Returns
- [] Returns an array of bucket ids for the given user Id.
Implemented in ILIAS\BackgroundTasks\Implementation\Persistence\BasicPersistence.
◆ getBucketMetaOfUser()
| ILIAS\BackgroundTasks\Persistence::getBucketMetaOfUser | ( | $user_id | ) |
- Parameters
-
int $user_id
- Returns
- BucketMeta[]
Implemented in ILIAS\BackgroundTasks\Implementation\Persistence\BasicPersistence.
◆ loadBucket()
| ILIAS\BackgroundTasks\Persistence::loadBucket | ( | $bucket_container_id | ) |
- Parameters
-
int $bucket_container_id
- Returns
- Bucket
Referenced by ILIAS\BackgroundTasks\Implementation\Persistence\BasicPersistence\getValueContainerId(), and ILIAS\BackgroundTasks\Implementation\Persistence\BasicPersistence\loadBuckets().
Here is the caller graph for this function:
◆ loadBuckets()
| ILIAS\BackgroundTasks\Persistence::loadBuckets | ( | $bucket_container_id | ) |
- Parameters
-
$bucket_container_id
- 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.
- Parameters
-
Bucket $bucket
Implemented in ILIAS\BackgroundTasks\Implementation\Persistence\BasicPersistence.
The documentation for this interface was generated from the following file:
- src/BackgroundTasks/Persistence.php
