ILIAS\Notifications\UserSettings\PushNotification Class Reference

Inheritance diagram for ILIAS\Notifications\UserSettings\PushNotification:

Collaboration diagram for ILIAS\Notifications\UserSettings\PushNotification:

Public Member Functions
	getIdentifier ()
	isAvailable ()
	If this function returns false the setting will not be shown, even if it's PropertyAttributes would allow it to be. More...
	getLabel (Language $lng)
	getSettingsPage ()
	getSection ()
	getInput (FieldFactory $field_factory, Language $lng, Refinery $refinery, ilSetting $settings, ?ilObjUser $user=null)
	getLegacyInput (Language $lng, ilSetting $settings, ?ilObjUser $user=null)
	getDefaultValueForDisplay (Language $lng, ilSetting $settings)
	hasUserPersonalizedSetting (ilSetting $settings, ilObjUser $user)
	persistUserInput (ilObjUser $user, mixed $input)
	retrieveValueFromUser (ilObjUser $user)
Public Member Functions inherited from ILIAS\User\Settings\SettingDefinition
	isAvailable ()
	If this function returns false the setting will not be shown, even if it's PropertyAttributes would allow it to be. More...
	getSettingsPage ()
	getDefaultValueForDisplay (Language $lng, \ilSetting $settings)
	hasUserPersonalizedSetting (\ilSetting $settings, \ilObjUser $user)
	getInput (FieldFactory $field_factory, Language $lng, Refinery $refinery, \ilSetting $settings, ?\ilObjUser $user=null)
	getLegacyInput (Language $lng, \ilSetting $settings, ?\ilObjUser $user=null)
	You don't need to add a post_var to the input as the User will handle this for you, thus you can also not rely on the post_var anywhere else, as it will be changed. More...
	persistUserInput (\ilObjUser $user, mixed $input)
Public Member Functions inherited from ILIAS\User\Property
	getIdentifier ()
	getLabel (Language $lng)
	getSection ()
	retrieveValueFromUser (\ilObjUser $user)

Detailed Description

Definition at line 39 of file PushNotification.php.

Member Function Documentation

getDefaultValueForDisplay()

ILIAS\Notifications\UserSettings\PushNotification::getDefaultValueForDisplay	(	Language	$lng,
		ilSetting	$settings
	)

Definition at line 98 of file PushNotification.php.

                                                                                 : string
    {
        return $lng->txt('none');
    }

References $lng.

getIdentifier()

ILIAS\Notifications\UserSettings\PushNotification::getIdentifier

(

)

Implements ILIAS\User\Property.

Definition at line 41 of file PushNotification.php.

                                   : string
    {
        return 'push_notification';
    }

Referenced by ILIAS\Notifications\UserSettings\PushNotification\getLabel().

Here is the caller graph for this function:

getInput()

ILIAS\Notifications\UserSettings\PushNotification::getInput	(	FieldFactory	$field_factory,
		Language	$lng,
		Refinery	$refinery,
		ilSetting	$settings,
		?ilObjUser	$user = null
	)

Definition at line 67 of file PushNotification.php.

     : Input {
        $lng->loadLanguageModule('notifications_adm');
 
        $pref = $user ? $this->retrieveValueFromUser($user) : [];
        $provider = [];
 
        foreach (require PushNotificationObjective::PATH() as $class) {
            $obj = new $class();
            $provider[$obj->getIdentifier()] = $field_factory->checkbox(
                $obj->getName($lng),
                $obj->getDescription($lng),
            )->withValue(in_array($obj->getIdentifier(), $pref));
        }
 
        return $field_factory->section(
            $provider,
            $lng->txt('push_settings')
        );
    }

References $lng, and $provider.

getLabel()

ILIAS\Notifications\UserSettings\PushNotification::getLabel

(

Language

$lng

)

Definition at line 51 of file PushNotification.php.

                                           : string
    {
        $lng->loadLanguageModule('notifications');
        return $lng->txt($this->getIdentifier());
    }

References $lng, and ILIAS\Notifications\UserSettings\PushNotification\getIdentifier().

Here is the call graph for this function:

getLegacyInput()

ILIAS\Notifications\UserSettings\PushNotification::getLegacyInput	(	Language	$lng,
		ilSetting	$settings,
		?ilObjUser	$user = null
	)

Definition at line 93 of file PushNotification.php.

                                                                                               : ilFormPropertyGUI
    {
        throw new Exception('This Setting does not provide an legacy Input.');
    }

getSection()

ILIAS\Notifications\UserSettings\PushNotification::getSection

(

)

Implements ILIAS\User\Property.

Definition at line 62 of file PushNotification.php.

                                : AvailableSections
    {
        return AvailableSections::Communication;
    }

getSettingsPage()

ILIAS\Notifications\UserSettings\PushNotification::getSettingsPage

(

)

Implements ILIAS\User\Settings\SettingDefinition.

Definition at line 57 of file PushNotification.php.

                                     : AvailablePages
    {
        return AvailablePages::MainSettings;
    }

hasUserPersonalizedSetting()

ILIAS\Notifications\UserSettings\PushNotification::hasUserPersonalizedSetting	(	ilSetting	$settings,
		ilObjUser	$user
	)

Definition at line 103 of file PushNotification.php.

                                                                                    : bool
    {
        return $user->getPref('push_notification_provider') !== null;
    }

References ilObjUser\getPref().

Here is the call graph for this function:

isAvailable()

ILIAS\Notifications\UserSettings\PushNotification::isAvailable

(

)

If this function returns false the setting will not be shown, even if it's PropertyAttributes would allow it to be.

This is meant e.g. to check if the chat server is configured or the badges enabled. Settings that are not available will also not be available on the table to define their PropertyAttributes

Implements ILIAS\User\Settings\SettingDefinition.

Definition at line 46 of file PushNotification.php.

                                 : bool
    {
        return (new ilSetting('notifications'))->get('enable_push') === '1' && count(require PushNotificationObjective::PATH()) > 0;
    }

References ILIAS\Setup\Artifact\BuildArtifactObjective\PATH().

Here is the call graph for this function:

persistUserInput()

ILIAS\Notifications\UserSettings\PushNotification::persistUserInput	(	ilObjUser	$user,
		mixed	$input
	)

Definition at line 108 of file PushNotification.php.

                                                                   : ilObjUser
    {
        $active = [];
        foreach ($input ?? [] as $key => $value) {
            if ($value === true) {
                $active[] = $key;
            }
        }
        $user->setPref('push_notification_provider', json_encode($active));
        $user->update();
        return $user;
    }

References ilObjUser\setPref(), and ilObjUser\update().

Here is the call graph for this function:

retrieveValueFromUser()

ILIAS\Notifications\UserSettings\PushNotification::retrieveValueFromUser

(

ilObjUser

$user

)

Definition at line 121 of file PushNotification.php.

                                                          : ?array
    {
        return json_decode($user->getPref('push_notification_provider') ?? '[]');
    }

References ilObjUser\getPref().

Here is the call graph for this function:

---

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

• components/ILIAS/Notifications/UserSettings/PushNotification.php