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...
	withOptions (array $options)
	Get a Signal like this, but provide it with a set of options. More...
	getOptions ()
	Get the options of this signal. More...
	addOption (string $key, $value)
	__toString ()
	getId ()
	Get the ID of this signal. More...
	withOptions (array $options)
	Get a Signal like this, but provide it with a set of options. More...
	getOptions ()
	Get the options of this signal. More...

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.

    {
        $this->id = $id;
    }

References $id.

Member Function Documentation

__toString()

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

(

)

Definition at line 77 of file Signal.php.

                                : string
    {
        return $this->id;
    }

References $id.

addOption()

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

Parameters

mixed

$value

Definition at line 64 of file Signal.php.

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

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.

                           : string
    {
        return $this->id;
    }

References $id.

getOption()

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

protected

Returns

mixed|null

Definition at line 72 of file Signal.php.

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

getOptions()

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

(

)

Get the options of this signal.

Returns

array<string, string> (key => value)

Implements ILIAS\UI\Component\Signal.

Definition at line 56 of file Signal.php.

                                : array
    {
        return $this->options;
    }

References ILIAS\UI\Implementation\Component\Input\Field\$options.

withOptions()

ILIAS\UI\Implementation\Component\Signal::withOptions

(

array

$options

)

Get a Signal like this, but provide it with a set of options.

Parameters

array<string,string>

$options (key => value)

Implements ILIAS\UI\Component\Signal.

Definition at line 47 of file Signal.php.

                                               : static
    {
        $clone = clone $this;
        foreach ($options as $key => $value) {
            $clone->addOption($key, $value);
        }
        return $clone;
    }

References ILIAS\UI\Implementation\Component\Input\Field\$options.

Field Documentation

$id

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

protected

Definition at line 31 of file Signal.php.

$options

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

protected

Definition at line 32 of file Signal.php.

---

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

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