ILIAS\GlobalScreen\ScreenContext\BasicScreenContext Class Reference

Inheritance diagram for ILIAS\GlobalScreen\ScreenContext\BasicScreenContext:

Collaboration diagram for ILIAS\GlobalScreen\ScreenContext\BasicScreenContext:

Public Member Functions
	__construct (protected string $context_identifier)
	hasReferenceId ()
	getReferenceId ()
	withReferenceId (ReferenceId $reference_id)
	withAdditionalData (Collection $collection)
	getAdditionalData ()
	addAdditionalData (string $key, $value)
	getUniqueContextIdentifier ()
	getUniqueContextIdentifier ()
	hasReferenceId ()
	getReferenceId ()
	withReferenceId (ReferenceId $reference_id)
	withAdditionalData (Collection $collection)
	addAdditionalData (string $key, $value)
	getAdditionalData ()

Protected Attributes
ReferenceId	$reference_id
Collection	$additional_data

Detailed Description

Definition at line 29 of file BasicScreenContext.php.

Constructor & Destructor Documentation

__construct()

ILIAS\GlobalScreen\ScreenContext\BasicScreenContext::__construct

(

protected string

$context_identifier

)

Definition at line 34 of file BasicScreenContext.php.

    {
        $this->additional_data = new Collection();
        $this->reference_id = new ReferenceId(-1);
    }

Member Function Documentation

addAdditionalData()

ILIAS\GlobalScreen\ScreenContext\BasicScreenContext::addAdditionalData	(	string	$key,
			$value
	)

Parameters

string	$key
	$value

Returns

ScreenContext

Implements ILIAS\GlobalScreen\ScreenContext\ScreenContext.

Definition at line 75 of file BasicScreenContext.php.

                                                          : ScreenContext
    {
        $this->additional_data->add($key, $value);
 
        return $this;
    }

getAdditionalData()

ILIAS\GlobalScreen\ScreenContext\BasicScreenContext::getAdditionalData

(

)

Returns

Collection

Implements ILIAS\GlobalScreen\ScreenContext\ScreenContext.

Definition at line 70 of file BasicScreenContext.php.

                                       : Collection
    {
        return $this->additional_data;
    }

References ILIAS\GlobalScreen\ScreenContext\BasicScreenContext\$additional_data.

getReferenceId()

ILIAS\GlobalScreen\ScreenContext\BasicScreenContext::getReferenceId

(

)

Returns

ReferenceId

Implements ILIAS\GlobalScreen\ScreenContext\ScreenContext.

Definition at line 45 of file BasicScreenContext.php.

                                    : ReferenceId
    {
        return $this->reference_id;
    }

References ILIAS\GlobalScreen\ScreenContext\BasicScreenContext\$reference_id.

getUniqueContextIdentifier()

ILIAS\GlobalScreen\ScreenContext\BasicScreenContext::getUniqueContextIdentifier

(

)

Returns

string

Implements ILIAS\GlobalScreen\ScreenContext\ScreenContext.

Definition at line 82 of file BasicScreenContext.php.

                                                : string
    {
        return $this->context_identifier;
    }

hasReferenceId()

ILIAS\GlobalScreen\ScreenContext\BasicScreenContext::hasReferenceId

(

)

Returns

bool

Implements ILIAS\GlobalScreen\ScreenContext\ScreenContext.

Definition at line 40 of file BasicScreenContext.php.

                                    : bool
    {
        return $this->reference_id->toInt() > 0;
    }

withAdditionalData()

ILIAS\GlobalScreen\ScreenContext\BasicScreenContext::withAdditionalData

(

Collection

$collection

)

Parameters

Collection

$collection

Returns

ScreenContext

Implements ILIAS\GlobalScreen\ScreenContext\ScreenContext.

Definition at line 62 of file BasicScreenContext.php.

                                                              : ScreenContext
    {
        $clone = clone $this;
        $clone->additional_data = $collection;
 
        return $clone;
    }

withReferenceId()

ILIAS\GlobalScreen\ScreenContext\BasicScreenContext::withReferenceId

(

ReferenceId

$reference_id

)

Parameters

ReferenceId

$reference_id

Returns

ScreenContext

Implements ILIAS\GlobalScreen\ScreenContext\ScreenContext.

Definition at line 50 of file BasicScreenContext.php.

                                                              : ScreenContext
    {
        if ($reference_id->toInt() < 1) {
            throw new \InvalidArgumentException('ReferenceId must be greater than 0');
        }
 
        $clone = clone $this;
        $clone->reference_id = $reference_id;
 
        return $clone;
    }

References ILIAS\GlobalScreen\ScreenContext\BasicScreenContext\$reference_id, and ILIAS\Data\ReferenceId\toInt().

Here is the call graph for this function:

Field Documentation

$additional_data

Collection ILIAS\GlobalScreen\ScreenContext\BasicScreenContext::$additional_data

protected

Definition at line 32 of file BasicScreenContext.php.

Referenced by ILIAS\GlobalScreen\ScreenContext\BasicScreenContext\getAdditionalData().

$reference_id

ReferenceId ILIAS\GlobalScreen\ScreenContext\BasicScreenContext::$reference_id

protected

Definition at line 31 of file BasicScreenContext.php.

Referenced by ILIAS\GlobalScreen\ScreenContext\BasicScreenContext\getReferenceId(), and ILIAS\GlobalScreen\ScreenContext\BasicScreenContext\withReferenceId().

---

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

• components/ILIAS/GlobalScreen/src/ScreenContext/BasicScreenContext.php