ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucketMeta Class Reference

Inheritance diagram for ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucketMeta:

Collaboration diagram for ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucketMeta:

Public Member Functions
	getUserId ()
	setUserId (int $user_id)
	getState ()
	setState (int $state)
	getTitle ()
	setTitle (string $title)
	getDescription ()
	setDescription (string $description)
	getPercentage ()
	setPercentage (Task $task, int $percentage)
	getOverallPercentage ()
	setOverallPercentage (int $percentage)

Protected Attributes
int	$user_id
int	$state
string	$title = ""
string	$description = ""
int	$percentage = 0

Detailed Description

Definition at line 32 of file BasicBucketMeta.php.

Member Function Documentation

getDescription()

ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucketMeta::getDescription

(

)

Implements ILIAS\BackgroundTasks\BucketMeta.

Definition at line 70 of file BasicBucketMeta.php.

References ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucketMeta\$description.

                                    : string
    {
        return $this->description;
    }

getOverallPercentage()

ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucketMeta::getOverallPercentage

(

)

Implements ILIAS\BackgroundTasks\BucketMeta.

Definition at line 90 of file BasicBucketMeta.php.

References ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucketMeta\$percentage.

                                          : int
    {
        return $this->percentage;
    }

getPercentage()

ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucketMeta::getPercentage

(

)

Definition at line 80 of file BasicBucketMeta.php.

References ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucketMeta\$percentage.

                                   : int
    {
        return $this->percentage;
    }

getState()

ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucketMeta::getState

(

)

Implements ILIAS\BackgroundTasks\BucketMeta.

Definition at line 50 of file BasicBucketMeta.php.

References ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucketMeta\$state.

                              : int
    {
        return $this->state;
    }

getTitle()

ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucketMeta::getTitle

(

)

Implements ILIAS\BackgroundTasks\BucketMeta.

Definition at line 60 of file BasicBucketMeta.php.

References ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucketMeta\$title.

                              : string
    {
        return $this->title;
    }

getUserId()

ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucketMeta::getUserId

(

)

Implements ILIAS\BackgroundTasks\BucketMeta.

Definition at line 40 of file BasicBucketMeta.php.

References ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucketMeta\$user_id.

                               : int
    {
        return $this->user_id;
    }

setDescription()

ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucketMeta::setDescription

(

string

$description

)

Definition at line 75 of file BasicBucketMeta.php.

References ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucketMeta\$description.

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

setOverallPercentage()

ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucketMeta::setOverallPercentage

(

int

$percentage

)

Implements ILIAS\BackgroundTasks\BucketMeta.

Definition at line 95 of file BasicBucketMeta.php.

References ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucketMeta\$percentage.

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

setPercentage()

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

Definition at line 85 of file BasicBucketMeta.php.

                                                              : void
    {
        throw new BucketNotFoundException("You cannot set the percentage on an empty bucket.");
    }

setState()

ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucketMeta::setState

(

int

$state

)

Implements ILIAS\BackgroundTasks\BucketMeta.

Definition at line 55 of file BasicBucketMeta.php.

References ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucketMeta\$state.

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

setTitle()

ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucketMeta::setTitle

(

string

$title

)

Definition at line 65 of file BasicBucketMeta.php.

References ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucketMeta\$title.

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

setUserId()

ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucketMeta::setUserId

(

int

$user_id

)

Implements ILIAS\BackgroundTasks\BucketMeta.

Definition at line 45 of file BasicBucketMeta.php.

References ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucketMeta\$user_id.

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

Field Documentation

$description

string ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucketMeta::$description = ""

protected

Definition at line 37 of file BasicBucketMeta.php.

Referenced by ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucketMeta\getDescription(), and ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucketMeta\setDescription().

$percentage

int ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucketMeta::$percentage = 0

protected

Definition at line 38 of file BasicBucketMeta.php.

Referenced by ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucketMeta\getOverallPercentage(), ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucketMeta\getPercentage(), and ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucketMeta\setOverallPercentage().

$state

int ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucketMeta::$state

protected

Definition at line 35 of file BasicBucketMeta.php.

Referenced by ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucketMeta\getState(), and ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucketMeta\setState().

$title

string ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucketMeta::$title = ""

protected

Definition at line 36 of file BasicBucketMeta.php.

Referenced by ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucketMeta\getTitle(), and ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucketMeta\setTitle().

$user_id

int ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucketMeta::$user_id

protected

Definition at line 34 of file BasicBucketMeta.php.

Referenced by ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucketMeta\getUserId(), and ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucketMeta\setUserId().

---

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

• components/ILIAS/BackgroundTasks/src/Implementation/Bucket/BasicBucketMeta.php