ILIAS\UI\Implementation\Component\Signal Class Reference

Inheritance diagram for ILIAS\UI\Implementation\Component\Signal:

Collaboration diagram for ILIAS\UI\Implementation\Component\Signal:

Public Member Functions
	__construct (string $id)
	getId ()
	Get the ID of this signal. More...
	getOptions ()
	Get the options of this signal. More...
	addOption (string $key, $value)
	__toString ()

Protected Member Functions
	getOption (string $key)

Protected Attributes
string	$id
array	$options = array()

Detailed Description

Definition at line 29 of file Signal.php.

Constructor & Destructor Documentation

__construct()

ILIAS\UI\Implementation\Component\Signal::__construct

(

string

$id

)

Definition at line 34 of file Signal.php.

References ILIAS\UI\Implementation\Component\Signal\$id.

    {
        $this->id = $id;
    }

Member Function Documentation

__toString()

ILIAS\UI\Implementation\Component\Signal::__toString

(

)

Definition at line 68 of file Signal.php.

References ILIAS\UI\Implementation\Component\Signal\$id.

                                : string
    {
        return $this->id;
    }

addOption()

ILIAS\UI\Implementation\Component\Signal::addOption	(	string	$key,
			$value
	)

Parameters

mixed

$value

Definition at line 55 of file Signal.php.

Referenced by ILIAS\UI\Implementation\Component\ReplaceSignal\withAsyncRenderUrl(), and ILIAS\UI\Implementation\Component\ReplaceContentSignal\withAsyncRenderUrl().

                                                  : void
    {
        $this->options[$key] = $value;
    }

Here is the caller graph for this function:

getId()

ILIAS\UI\Implementation\Component\Signal::getId

(

)

Get the ID of this signal.

Implements ILIAS\UI\Component\Signal.

Definition at line 42 of file Signal.php.

References ILIAS\UI\Implementation\Component\Signal\$id.

                           : string
    {
        return $this->id;
    }

getOption()

ILIAS\UI\Implementation\Component\Signal::getOption ( string  $key )

protected

Returns

mixed|null

Definition at line 63 of file Signal.php.

References null.

Referenced by ILIAS\UI\Implementation\Component\ReplaceSignal\getAsyncRenderUrl(), and ILIAS\UI\Implementation\Component\ReplaceContentSignal\getAsyncRenderUrl().

    {
        return (isset($this->options[$key])) ? $this->options[$key] : null;
    }

Here is the caller graph for this function:

getOptions()

ILIAS\UI\Implementation\Component\Signal::getOptions

(

)

Get the options of this signal.

Implements ILIAS\UI\Component\Signal.

Definition at line 47 of file Signal.php.

References ILIAS\UI\Implementation\Component\Signal\$options.

                                : array
    {
        return $this->options;
    }

Field Documentation

$id

string ILIAS\UI\Implementation\Component\Signal::$id

protected

Definition at line 31 of file Signal.php.

Referenced by ILIAS\UI\Implementation\Component\Signal\__construct(), ILIAS\UI\Implementation\Component\Signal\__toString(), and ILIAS\UI\Implementation\Component\Signal\getId().

$options

array ILIAS\UI\Implementation\Component\Signal::$options = array()

protected

Definition at line 32 of file Signal.php.

Referenced by ILIAS\UI\Implementation\Component\Signal\getOptions().

---

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

• components/ILIAS/UI/src/Implementation/Component/Signal.php