Inheritance diagram for ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer:

Collaboration diagram for ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer:

Public Member Functions
	getId ()

	setId (int $id)

	getUserId ()

	setUserId (int $user_id)

	getRootTaskid ()

	setRootTaskid (int $root_task_id)

	getCurrentTaskid ()

	setCurrentTaskid (int $current_task_id)

	getState ()

	setState (int $state)

	getTotalNumberoftasks ()

	setTotalNumberoftasks (int $total_number_of_tasks)

	getPercentage ()

	setPercentage (int $percentage)

	getTitle ()

	setTitle (string $title)

	getDescription ()

	setDescription (string $description)

	getLastHeartbeat ()

	setLastHeartbeat (int $last_heartbeat)

Public Member Functions inherited from ActiveRecord
	getArConnector ()

	getArFieldList ()

	getConnectorContainerName ()
	@description Return the Name of your Connector Table More...

	setConnectorContainerName (string $connector_container_name)

	getPrimaryFieldValue ()

	setPrimaryFieldValue ($value)

	__construct (mixed $primary_key=0)

	storeObjectToCache ()

	asStdClass ()

	asArray ()

	buildFromArray (array $array)

	fixDateField ($field_name, string $value)

	sleep ($field_name)

	wakeUp ($field_name, $field_value)

	getArrayForConnector ()

	installConnector ()

	store ()

	save ()

	create ()

	copy (int $new_id=0)

	afterObjectLoad ()

	read ()

	update ()

	delete ()

	__call ($name, $arguments)

Static Public Member Functions
static	returnDbTableName ()

Static Public Member Functions inherited from ActiveRecord
static	returnDbTableName ()

static	installDB ()

static	renameDBField (string $old_name, string $new_name)

static	tableExists ()

static	fieldExists (string $field_name)

static	removeDBField (string $field_name)

static	updateDB ()

static	resetDB ()

static	truncateDB ()

static	flushDB ()
	@depracated never use in ILIAS Core, Plugins only More...

static	preloadObjects ()

static	additionalParams (array $additional_params)

static	findOrFail ($primary_key, array $add_constructor_args=[])
	Tries to find the object and throws an Exception if object is not found, instead of returning null. More...

static	findOrGetInstance ($primary_key, array $add_constructor_args=[])

static	where ($where, $operator=null)

static	innerjoinAR (ActiveRecord $activeRecord, $on_this, string $on_external, array $fields=[' *'], string $operator='=', bool $both_external=false)

static	innerjoin (string $tablename, $on_this, string $on_external, array $fields=[' *'], string $operator='=', bool $both_external=false)

static	leftjoin (string $tablename, $on_this, string $on_external, array $fields=[' *'], string $operator='=', bool $both_external=false)

static	orderBy (string $orderBy, string $orderDirection='ASC')

static	dateFormat (string $date_format='d.m.Y - H:i:s')

static	limit (int $start, int $end)

static	affectedRows ()

static	count ()

static	get ()

static	debug ()

static	first ()

static	getCollection ()

static	last ()

static	getFirstFromLastQuery ()

static	connector (arConnector $arConnector)

static	raw (bool $set_raw=true)

static	getArray (?string $key=null, string\|array\|null $values=null)

static	_toCamelCase (string $str, bool $capitalise_first_char=false)

Protected Attributes
int	$id = null
	@con_is_primary true @con_is_unique true @con_has_field true @con_sequence true @con_fieldtype integer @con_length 8 More...

int	$user_id = 0
	@con_has_field true @con_fieldtype integer @con_length 8 More...

int	$root_task_id = 0
	@con_has_field true @con_fieldtype integer @con_length 8 More...

int	$current_task_id = 0
	@con_has_field true @con_fieldtype integer @con_length 8 More...

int	$state = State::ERROR
	@con_has_field true @con_fieldtype integer @con_length 2 More...

int	$total_number_of_tasks = 0
	@con_has_field true @con_fieldtype integer @con_length 4 More...

int	$percentage = 0
	@con_has_field true @con_fieldtype integer @con_length 2 More...

string	$title = ''
	@con_has_field true @con_fieldtype text @con_length 255 More...

string	$description = ''
	@con_has_field true @con_fieldtype text @con_length 255 More...

int	$last_heartbeat = 0
	@con_has_field true @con_fieldtype timestamp More...

Protected Attributes inherited from ActiveRecord
bool	$ar_safe_read = true

string	$connector_container_name = ''

bool	$is_new = true

Additional Inherited Members
Protected Member Functions inherited from ActiveRecord
	installDatabase ()

Static Protected Member Functions inherited from ActiveRecord
static	getCalledClass ()
	@description Returns an instance of the instatiated calling active record (needs to be done in static methods) @TODO : This should be cached somehow More...

static	fromCamelCase (string $str)

Detailed Description

Definition at line 23 of file BucketContainer.php.

Member Function Documentation

◆ getCurrentTaskid()

ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer::getCurrentTaskid ( )

Definition at line 123 of file BucketContainer.php.

                                      : int
    {
        return $this->current_task_id;
    }

References ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer\$current_task_id.

◆ getDescription()

ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer::getDescription ( )

Definition at line 173 of file BucketContainer.php.

                                    : string
    {
        return $this->description;
    }

References ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer\$description.

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

Here is the caller graph for this function:

◆ getId()

ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer::getId ( )

Definition at line 93 of file BucketContainer.php.

                           : ?int
    {
        return $this->id;
    }

References ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer\$id.

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

Here is the caller graph for this function:

◆ getLastHeartbeat()

ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer::getLastHeartbeat ( )

Definition at line 183 of file BucketContainer.php.

                                      : int
    {
        return $this->last_heartbeat;
    }

References ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer\$last_heartbeat.

◆ getPercentage()

ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer::getPercentage ( )

Definition at line 153 of file BucketContainer.php.

                                   : int
    {
        return $this->percentage;
    }

References ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer\$percentage.

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

Here is the caller graph for this function:

◆ getRootTaskid()

ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer::getRootTaskid ( )

Definition at line 113 of file BucketContainer.php.

                                   : int
    {
        return $this->root_task_id;
    }

References ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer\$root_task_id.

◆ getState()

ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer::getState ( )

Definition at line 133 of file BucketContainer.php.

                              : int
    {
        return $this->state;
    }

References ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer\$state.

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

Here is the caller graph for this function:

◆ getTitle()

ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer::getTitle ( )

Definition at line 163 of file BucketContainer.php.

                              : string
    {
        return $this->title;
    }

References ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer\$title.

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

Here is the caller graph for this function:

◆ getTotalNumberoftasks()

ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer::getTotalNumberoftasks ( )

Definition at line 143 of file BucketContainer.php.

                                           : int
    {
        return $this->total_number_of_tasks;
    }

References ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer\$total_number_of_tasks.

◆ getUserId()

ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer::getUserId ( )

Definition at line 103 of file BucketContainer.php.

                               : int
    {
        return $this->user_id;
    }

References ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer\$user_id.

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

Here is the caller graph for this function:

◆ returnDbTableName()

static ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer::returnDbTableName ( )

static

Returns: never

Exceptions

arException

Deprecated:

Reimplemented from ActiveRecord.

Definition at line 25 of file BucketContainer.php.

                                              : string
    {
        return "il_bt_bucket";
    }

◆ setCurrentTaskid()

ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer::setCurrentTaskid ( int $current_task_id )

Definition at line 128 of file BucketContainer.php.

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

References ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer\$current_task_id.

◆ setDescription()

ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer::setDescription ( string $description )

Definition at line 178 of file BucketContainer.php.

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

References ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer\$description.

◆ setId()

ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer::setId ( int $id )

Definition at line 98 of file BucketContainer.php.

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

References ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer\$id.

◆ setLastHeartbeat()

ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer::setLastHeartbeat ( int $last_heartbeat )

Definition at line 188 of file BucketContainer.php.

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

References ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer\$last_heartbeat.

◆ setPercentage()

ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer::setPercentage ( int $percentage )

Definition at line 158 of file BucketContainer.php.

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

References ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer\$percentage.

◆ setRootTaskid()

ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer::setRootTaskid ( int $root_task_id )

Definition at line 118 of file BucketContainer.php.

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

References ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer\$root_task_id.

◆ setState()

ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer::setState ( int $state )

Definition at line 138 of file BucketContainer.php.

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

References ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer\$state.

◆ setTitle()

ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer::setTitle ( string $title )

Definition at line 168 of file BucketContainer.php.

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

References ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer\$title.

◆ setTotalNumberoftasks()

ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer::setTotalNumberoftasks ( int $total_number_of_tasks )

Definition at line 148 of file BucketContainer.php.

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

References ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer\$total_number_of_tasks.

◆ setUserId()

ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer::setUserId ( int $user_id )

Definition at line 108 of file BucketContainer.php.

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

References ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer\$user_id.

Field Documentation

◆ $current_task_id

int ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer::$current_task_id = 0

protected

@con_has_field true @con_fieldtype integer @con_length 8

Definition at line 56 of file BucketContainer.php.

Referenced by ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer\getCurrentTaskid(), and ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer\setCurrentTaskid().

◆ $description

string ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer::$description = ''

protected

@con_has_field true @con_fieldtype text @con_length 255

Definition at line 86 of file BucketContainer.php.

Referenced by ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer\getDescription(), and ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer\setDescription().

◆ $id

int ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer::$id = null

protected

@con_is_primary true @con_is_unique true @con_has_field true @con_sequence true @con_fieldtype integer @con_length 8

Definition at line 38 of file BucketContainer.php.

Referenced by ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer\getId(), and ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer\setId().

◆ $last_heartbeat

int ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer::$last_heartbeat = 0

protected

@con_has_field true @con_fieldtype timestamp

Definition at line 91 of file BucketContainer.php.

Referenced by ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer\getLastHeartbeat(), and ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer\setLastHeartbeat().

◆ $percentage

int ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer::$percentage = 0

protected

@con_has_field true @con_fieldtype integer @con_length 2

Definition at line 74 of file BucketContainer.php.

Referenced by ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer\getPercentage(), and ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer\setPercentage().

◆ $root_task_id

int ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer::$root_task_id = 0

protected

@con_has_field true @con_fieldtype integer @con_length 8

Definition at line 50 of file BucketContainer.php.

Referenced by ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer\getRootTaskid(), and ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer\setRootTaskid().

◆ $state

int ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer::$state = State::ERROR

protected

@con_has_field true @con_fieldtype integer @con_length 2

Definition at line 62 of file BucketContainer.php.

Referenced by ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer\getState(), and ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer\setState().

◆ $title

string ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer::$title = ''

protected

@con_has_field true @con_fieldtype text @con_length 255

Definition at line 80 of file BucketContainer.php.

Referenced by ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer\getTitle(), and ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer\setTitle().

◆ $total_number_of_tasks

int ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer::$total_number_of_tasks = 0

protected

@con_has_field true @con_fieldtype integer @con_length 4

Definition at line 68 of file BucketContainer.php.

Referenced by ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer\getTotalNumberoftasks(), and ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer\setTotalNumberoftasks().

◆ $user_id

int ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer::$user_id = 0

protected

@con_has_field true @con_fieldtype integer @con_length 8

Definition at line 44 of file BucketContainer.php.

Referenced by ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer\getUserId(), and ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer\setUserId().

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

components/ILIAS/BackgroundTasks/src/Implementation/Persistence/BucketContainer.php

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getCurrentTaskid()

◆ getDescription()

◆ getId()

◆ getLastHeartbeat()

◆ getPercentage()

◆ getRootTaskid()

◆ getState()

◆ getTitle()

◆ getTotalNumberoftasks()

◆ getUserId()

◆ returnDbTableName()

◆ setCurrentTaskid()

◆ setDescription()

◆ setId()

◆ setLastHeartbeat()

◆ setPercentage()

◆ setRootTaskid()

◆ setState()

◆ setTitle()

◆ setTotalNumberoftasks()

◆ setUserId()

Field Documentation

◆ $current_task_id

◆ $description

◆ $id

◆ $last_heartbeat

◆ $percentage

◆ $root_task_id

◆ $state

◆ $title

◆ $total_number_of_tasks

◆ $user_id