HelpScreenId.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\Services\Help\ScreenId;

#[\Attribute(\Attribute::TARGET_CLASS)]
class HelpScreenId
{
    public function __construct(private string $screen_id)
    {
        // $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.');
        }
    }

    public function getScreenId(): string
    {
        return $this->screen_id;
    }
}