ILIAS\Services\Help\ScreenId\HelpScreenId Class Reference

Inheritance diagram for ILIAS\Services\Help\ScreenId\HelpScreenId:

Collaboration diagram for ILIAS\Services\Help\ScreenId\HelpScreenId:

Public Member Functions
	__construct (private string $screen_id)
	getScreenId ()

Detailed Description

Author

Fabian Schmid fabia.nosp@m.n@sr.nosp@m..solu.nosp@m.tion.nosp@m.s

    Short screen name for the class which will be added to the help ID.

Definition at line 29 of file HelpScreenId.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Services\Help\ScreenId\HelpScreenId::__construct

(

private string

$screen_id

)

Definition at line 31 of file HelpScreenId.php.

    {
        // $screen id can only constist of lowercase letters and underscores. Otherwise, a InvalidArgumentException is thrown.
        if (!preg_match('/^[a-z0-9_]+$/', $screen_id)) {
            throw new \InvalidArgumentException('Screen name must only consist of lowercase letters, numbers and underscores.');
        }
    }

Member Function Documentation

getScreenId()

ILIAS\Services\Help\ScreenId\HelpScreenId::getScreenId

(

)

Definition at line 39 of file HelpScreenId.php.

                                 : string
    {
        return $this->screen_id;
    }

---

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

• components/ILIAS/Help/ScreenId/HelpScreenId.php