ilForumNotificationEventsFormGUI Class Reference

Collaboration diagram for ilForumNotificationEventsFormGUI:

Public Member Functions
	__construct (private readonly string $action, private ?array $predefined_values, private readonly \ILIAS\UI\Factory $ui_factory, private readonly ilLanguage $lng)
	getValueForEvent (string $event)
	getValidEvents ()
	build ()
	getInputs ()

Private Attributes
array	$events

Detailed Description

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

Constructor & Destructor Documentation

__construct()

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

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

      {
    }

Member Function Documentation

build()

ilForumNotificationEventsFormGUI::build

(

)

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

                           : \ILIAS\UI\Component\Input\Container\Form\Form
    {
        return $this->ui_factory->input()->container()->form()->standard(
            $this->action,
            $this->getInputs()
        );
    }

References getInputs().

Here is the call graph for this function:

getInputs()

ilForumNotificationEventsFormGUI::getInputs

(

)

Returns

array<string, FormInput>

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

                               : array
    {
        $items = [];
 
        foreach (array_keys($this->events) as $key) {
            $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 $items;
    }

References ILIAS\Repository\lng().

Referenced by build().

Here is the call graph for this function:

Here is the caller graph for this function:

getValidEvents()

ilForumNotificationEventsFormGUI::getValidEvents

(

)

Returns

list<string>

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

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

getValueForEvent()

ilForumNotificationEventsFormGUI::getValueForEvent

(

string

$event

)

Definition at line 42 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

$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,
    ]

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

---

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

• components/ILIAS/Forum/classes/Notification/class.ilForumNotificationEventsFormGUI.php