Collaboration diagram for ilForumNotificationEventsFormGUI:

Public Member Functions
	__construct (string $action, ?array $predefined_values, \ILIAS\UI\Factory $ui_factory, ilLanguage $lng)

	getValueForEvent (string $event)

	getValidEvents ()

	build ()

Private Attributes
string	$action

array	$predefined_values

ILIAS UI Factory	$ui_factory

ilLanguage	$lng

array	$events

Detailed Description

Definition at line 21 of file class.ilForumNotificationEventsFormGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilForumNotificationEventsFormGUI::__construct	(	string	$action,
		?array	$predefined_values,
		\ILIAS\UI\Factory	$ui_factory,
		ilLanguage	$lng
	)

Definition at line 36 of file class.ilForumNotificationEventsFormGUI.php.

      {
        $this->action = $action;
        $this->predefined_values = $predefined_values;
        $this->ui_factory = $ui_factory;
        $this->lng = $lng;
    }

References $action, $lng, $predefined_values, $ui_factory, and ILIAS\Repository\lng().

Here is the call graph for this function:

Member Function Documentation

◆ build()

ilForumNotificationEventsFormGUI::build ( )

Definition at line 65 of file class.ilForumNotificationEventsFormGUI.php.

                           : \ILIAS\UI\Component\Input\Container\Form\Form
    {
        $items = [];
 
        foreach ($this->events as $key => $id) {
            $checkbox = $this->ui_factory->input()->field()->checkbox($this->lng->txt($key));
            if ($this->predefined_values !== null && isset($this->predefined_values[$key])) {
                $checkbox = $checkbox->withValue($this->predefined_values[$key]);
            }
 
            $items[$key] = $checkbox;
        }
 
        $hidden = $this->ui_factory->input()->field()->hidden();
        if ($this->predefined_values !== null && isset($this->predefined_values['hidden_value'])) {
            $hidden = $hidden->withValue((string) $this->predefined_values['hidden_value']);
        }
        $items['hidden_value'] = $hidden;
 
        return $this->ui_factory->input()->container()->form()->standard(
            $this->action,
            $items
        );
    }

References $id, ILIAS\LTI\ToolProvider\$key, and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getValidEvents()

ilForumNotificationEventsFormGUI::getValidEvents ( )

Returns: list<string>

Definition at line 60 of file class.ilForumNotificationEventsFormGUI.php.

                                    : array
    {
        return array_keys($this->events);
    }

◆ getValueForEvent()

ilForumNotificationEventsFormGUI::getValueForEvent ( string $event )

Definition at line 48 of file class.ilForumNotificationEventsFormGUI.php.

                                                   : int
    {
        if (isset($this->events[$event])) {
            return $this->events[$event];
        }
 
        throw new InvalidArgumentException(sprintf('Event "%s" is not supported.', $event));
    }

Field Documentation

◆ $action

string ilForumNotificationEventsFormGUI::$action

private

Definition at line 23 of file class.ilForumNotificationEventsFormGUI.php.

Referenced by __construct().

◆ $events

array ilForumNotificationEventsFormGUI::$events

private

Initial value:

= [
        'notify_modified' => ilForumNotificationEvents::UPDATED,
        'notify_censored' => ilForumNotificationEvents::CENSORED,
        'notify_uncensored' => ilForumNotificationEvents::UNCENSORED,
        'notify_post_deleted' => ilForumNotificationEvents::POST_DELETED,
        'notify_thread_deleted' => ilForumNotificationEvents::THREAD_DELETED,
    ]