Collaboration diagram for ILIAS\Notifications\Model\ilNotificationConfig:

Public Member Functions
	__construct (string $provider, ?NotificationIdentification $identification=null)

	getType ()

	setAutoDisable (bool $value)

	hasDisableAfterDeliverySet ()

	setLinks (array $links)

	getLinks ()

	setIconPath (string $path)

	getIconPath ()

	setTitleVar (string $name, array $parameters=[], string $language_module='notification')

	getTitleVar ()

	setShortDescriptionVar (string $name, array $parameters=[], string $language_module='notification')

	getShortDescriptionVar ()

	setLongDescriptionVar (string $name, array $parameters=[], string $language_module='notification')

	getLongDescriptionVar ()

	getLanguageParameters ()

	setValidForSeconds (int $seconds)

	getValidForSeconds ()

	getVisibleForSeconds ()

	setVisibleForSeconds (int $visibleForSeconds)

	notifyByUsers (array $recipients, bool $processAsync=false)

	notifyByListeners (int $ref_id, $processAsync=false)

	notifyByRoles (array $roles, bool $processAsync=false)

	getUserInstance (ilObjUser $user, array $languageVars, string $defaultLanguage)

	setHandlerParam (string $name, string $value)

	getHandlerParams ()

	unsetHandlerParam (string $name)

	setIdentification (NotificationIdentification $identification)

	getIdentification ()

Data Fields
const	TTL_LONG = 1800

const	TTL_SHORT = 120

const	DEFAULT_TTS = 5

Protected Member Functions
	beforeSendToUsers ()

	afterSendToUsers ()

	beforeSendToListeners ()

	afterSendToListeners ()

Protected Attributes
int	$visibleForSeconds = 0

Private Attributes
string	$type

array	$links = []

ilNotificationParameter	$title

string	$iconPath

ilNotificationParameter	$short_description

ilNotificationParameter	$long_description

bool	$disableAfterDelivery = false

int	$validForSeconds = 0

array	$handlerParams = []

NotificationIdentification	$identification

Detailed Description

Author: Jan Posselt jposs.nosp@m.elt@.nosp@m.datab.nosp@m.ay.d.nosp@m.e

Definition at line 31 of file ilNotificationConfig.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Notifications\Model\ilNotificationConfig::__construct	(	string	$provider,
		?NotificationIdentification	$identification = `null`
	)

Definition at line 52 of file ilNotificationConfig.php.

References ILIAS\Notifications\Model\ilNotificationConfig\$identification, and $provider.

     {
         $this->type = $provider;
         if ($identification === null) {
             $identification = new NotificationIdentification($provider, 'default');
         }
         $this->identification = $identification;
     }

Member Function Documentation

◆ afterSendToListeners()

ILIAS\Notifications\Model\ilNotificationConfig::afterSendToListeners ( )

protected

Definition at line 194 of file ilNotificationConfig.php.

Referenced by ILIAS\Notifications\Model\ilNotificationConfig\notifyByListeners().

                                              : void
     {
     }

Here is the caller graph for this function:

◆ afterSendToUsers()

ILIAS\Notifications\Model\ilNotificationConfig::afterSendToUsers ( )

protected

Definition at line 186 of file ilNotificationConfig.php.

Referenced by ILIAS\Notifications\Model\ilNotificationConfig\notifyByUsers().

                                          : void
     {
     }

Here is the caller graph for this function:

◆ beforeSendToListeners()

ILIAS\Notifications\Model\ilNotificationConfig::beforeSendToListeners ( )

protected

Definition at line 190 of file ilNotificationConfig.php.

Referenced by ILIAS\Notifications\Model\ilNotificationConfig\notifyByListeners().

                                               : void
     {
     }

Here is the caller graph for this function:

◆ beforeSendToUsers()

ILIAS\Notifications\Model\ilNotificationConfig::beforeSendToUsers ( )

protected

Definition at line 182 of file ilNotificationConfig.php.

Referenced by ILIAS\Notifications\Model\ilNotificationConfig\notifyByUsers().

                                           : void
     {
     }

Here is the caller graph for this function:

◆ getHandlerParams()

ILIAS\Notifications\Model\ilNotificationConfig::getHandlerParams ( )

Definition at line 295 of file ilNotificationConfig.php.

References ILIAS\Notifications\Model\ilNotificationConfig\$handlerParams.

                                       : array
     {
         return $this->handlerParams;
     }

◆ getIconPath()

ILIAS\Notifications\Model\ilNotificationConfig::getIconPath ( )

Definition at line 97 of file ilNotificationConfig.php.

References ILIAS\Notifications\Model\ilNotificationConfig\$iconPath.

                                  : ?string
     {
         return $this->iconPath;
     }

◆ getIdentification()

ILIAS\Notifications\Model\ilNotificationConfig::getIdentification ( )

Definition at line 310 of file ilNotificationConfig.php.

References ILIAS\Notifications\Model\ilNotificationConfig\$identification.

                                        : NotificationIdentification
     {
         return $this->identification;
     }

◆ getLanguageParameters()

ILIAS\Notifications\Model\ilNotificationConfig::getLanguageParameters ( )

Returns: array<string, ilNotificationParameter>

Definition at line 144 of file ilNotificationConfig.php.

References $id, ILIAS\Notifications\Model\ilNotificationConfig\$long_description, $params, ILIAS\Notifications\Model\ilNotificationConfig\$short_description, and ILIAS\Notifications\Model\ilNotificationConfig\$title.

Referenced by ILIAS\Notifications\ilNotificationSystem\toUsers().

                                            : array
     {
         $params = [
             'title' => $this->title,
             'longDescription' => $this->long_description,
             'shortDescription' => $this->short_description,
         ];
 
         foreach ($this->links as $id => $link) {
             $params['link_' . $id] = $link->getTitle();
         }
 
         return $params;
     }

Here is the caller graph for this function:

◆ getLinks()

ILIAS\Notifications\Model\ilNotificationConfig::getLinks ( )

Returns: ilNotificationLink[]

Definition at line 87 of file ilNotificationConfig.php.

References ILIAS\Notifications\Model\ilNotificationConfig\$links.

                               : array
     {
         return $this->links;
     }

◆ getLongDescriptionVar()

ILIAS\Notifications\Model\ilNotificationConfig::getLongDescriptionVar ( )

Definition at line 136 of file ilNotificationConfig.php.

                                            : string
     {
         return $this->long_description->getName();
     }

◆ getShortDescriptionVar()

ILIAS\Notifications\Model\ilNotificationConfig::getShortDescriptionVar ( )

Definition at line 123 of file ilNotificationConfig.php.

                                             : string
     {
         return $this->short_description->getName();
     }

◆ getTitleVar()

ILIAS\Notifications\Model\ilNotificationConfig::getTitleVar ( )

Definition at line 110 of file ilNotificationConfig.php.

                                  : string
     {
         return $this->title->getName();
     }

◆ getType()

ILIAS\Notifications\Model\ilNotificationConfig::getType ( )

Definition at line 61 of file ilNotificationConfig.php.

References ILIAS\Notifications\Model\ilNotificationConfig\$type.

Referenced by ILIAS\Notifications\ilNotificationDatabaseHandler\enqueueByListener(), ILIAS\Notifications\ilNotificationSystem\toListeners(), and ILIAS\Notifications\ilNotificationSystem\toUsers().

                              : string
     {
         return $this->type;
     }

Here is the caller graph for this function:

◆ getUserInstance()

ILIAS\Notifications\Model\ilNotificationConfig::getUserInstance	(	ilObjUser	$user,
		array	$languageVars,
		string	$defaultLanguage
	)

Definition at line 223 of file ilNotificationConfig.php.

References $defaultLanguage, ILIAS\Notifications\Model\ilNotificationConfig\$iconPath, ILIAS\Notifications\Model\ilNotificationConfig\$title, ilObjUser\getLanguage(), and ILIAS\Notifications\Model\ilNotificationParameter\getName().

Referenced by ILIAS\Notifications\ilNotificationSystem\toUsers().

                                                                                                   : ilNotificationObject
     {
         $notificationObject = new ilNotificationObject($this, $user);
 
         $title = $this->title->getName();
         if (isset($languageVars[$this->title->getName()])) {
             $var = $languageVars[$this->title->getName()]->lang;
             if (isset($var[$user->getLanguage()])) {
                 $title = $var[$user->getLanguage()];
             } elseif (isset($var[$defaultLanguage])) {
                 $title = $var[$defaultLanguage];
             }
         }
         $notificationObject->title = $title;
 
         $short = $this->short_description->getName();
         if (isset($languageVars[$this->short_description->getName()])) {
             $var = $languageVars[$this->short_description->getName()]->lang;
             if (isset($var[$user->getLanguage()])) {
                 $short = $var[$user->getLanguage()];
             } elseif (isset($var[$defaultLanguage])) {
                 $short = $var[$defaultLanguage];
             }
         }
         $notificationObject->shortDescription = $short;
 
         $long = $this->long_description->getName();
         if (isset($languageVars[$this->long_description->getName()])) {
             $var = $languageVars[$this->long_description->getName()]->lang;
             if (isset($var[$user->getLanguage()])) {
                 $long = $var[$user->getLanguage()];
             } elseif (isset($var[$defaultLanguage])) {
                 $long = $var[$defaultLanguage];
             }
         }
         $notificationObject->longDescription = $long;
 
         $process_links = [];
         foreach ($this->links as $link) {
             $link_title = $link->getTitle()->getName();
             if (isset($languageVars[$link->getTitle()->getName()])) {
                 $var = $languageVars[$link->getTitle()->getName()]->lang;
                 if (isset($var[$user->getLanguage()])) {
                     $link_title = $var[$user->getLanguage()];
                 } elseif (isset($var[$defaultLanguage])) {
                     $link_title = $var[$defaultLanguage];
                 }
             }
 
             $process_link = clone $link;
             $process_link->setTitle($link_title);
             $process_links[] = $process_link;
         }
         $notificationObject->links = $process_links;
 
         $notificationObject->iconPath = $this->iconPath;
 
         return $notificationObject;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getValidForSeconds()

ILIAS\Notifications\Model\ilNotificationConfig::getValidForSeconds ( )

Definition at line 164 of file ilNotificationConfig.php.

References ILIAS\Notifications\Model\ilNotificationConfig\$validForSeconds.

Referenced by ILIAS\Notifications\ilNotificationDatabaseHandler\enqueueByListener(), and ILIAS\Notifications\ilNotificationDatabaseHandler\enqueueByUsers().

                                         : int
     {
         return $this->validForSeconds;
     }

Here is the caller graph for this function:

◆ getVisibleForSeconds()

ILIAS\Notifications\Model\ilNotificationConfig::getVisibleForSeconds ( )

Definition at line 169 of file ilNotificationConfig.php.

References ILIAS\Notifications\Model\ilNotificationConfig\$visibleForSeconds.

Referenced by ILIAS\Notifications\ilNotificationDatabaseHandler\enqueueByListener(), and ILIAS\Notifications\ilNotificationDatabaseHandler\enqueueByUsers().

                                           : int
     {
         return $this->visibleForSeconds;
     }

Here is the caller graph for this function:

◆ hasDisableAfterDeliverySet()

ILIAS\Notifications\Model\ilNotificationConfig::hasDisableAfterDeliverySet ( )

Definition at line 71 of file ilNotificationConfig.php.

References ILIAS\Notifications\Model\ilNotificationConfig\$disableAfterDelivery.

Referenced by ILIAS\Notifications\ilNotificationSystem\toListeners().

                                                 : bool
     {
         return $this->disableAfterDelivery;
     }

Here is the caller graph for this function:

◆ notifyByListeners()

ILIAS\Notifications\Model\ilNotificationConfig::notifyByListeners	(	int	$ref_id,
			$processAsync = `false`
	)

final

Definition at line 208 of file ilNotificationConfig.php.

References ILIAS\Notifications\Model\ilNotificationConfig\afterSendToListeners(), ILIAS\Notifications\Model\ilNotificationConfig\beforeSendToListeners(), and ILIAS\Notifications\ilNotificationSystem\sendNotificationToListeners().

                                                                                : void
     {
         $this->beforeSendToListeners();
         ilNotificationSystem::sendNotificationToListeners($this, $ref_id, $processAsync);
         $this->afterSendToListeners();
     }

Here is the call graph for this function:

◆ notifyByRoles()

ILIAS\Notifications\Model\ilNotificationConfig::notifyByRoles	(	array	$roles,
		bool	$processAsync = `false`
	)

final

Parameters

string[] $roles

Definition at line 218 of file ilNotificationConfig.php.

References ILIAS\Notifications\ilNotificationSystem\sendNotificationToRoles().

                                                                                  : void
     {
         ilNotificationSystem::sendNotificationToRoles($this, $roles, $processAsync);
     }

Here is the call graph for this function:

◆ notifyByUsers()

ILIAS\Notifications\Model\ilNotificationConfig::notifyByUsers	(	array	$recipients,
		bool	$processAsync = `false`
	)

final

Parameters

int[] $recipients

Definition at line 201 of file ilNotificationConfig.php.

References ILIAS\Notifications\Model\ilNotificationConfig\afterSendToUsers(), ILIAS\Notifications\Model\ilNotificationConfig\beforeSendToUsers(), and ILIAS\Notifications\ilNotificationSystem\sendNotificationToUsers().

                                                                                       : void
     {
         $this->beforeSendToUsers();
         ilNotificationSystem::sendNotificationToUsers($this, $recipients, $processAsync);
         $this->afterSendToUsers();
     }

Here is the call graph for this function:

◆ setAutoDisable()

ILIAS\Notifications\Model\ilNotificationConfig::setAutoDisable ( bool $value )

Definition at line 66 of file ilNotificationConfig.php.

                                                : void
     {
         $this->disableAfterDelivery = $value;
     }

◆ setHandlerParam()

ILIAS\Notifications\Model\ilNotificationConfig::setHandlerParam	(	string	$name,
		string	$value
	)

Definition at line 283 of file ilNotificationConfig.php.

References $name.

                                                                 : void
     {
         if (strpos($name, '.')) {
             $nsParts = explode('.', $name, 2);
             $ns = $nsParts[0];
             $field = $nsParts[1];
             $this->handlerParams[$ns][$field] = $value;
         } else {
             $this->handlerParams[''][$name] = $value;
         }
     }

◆ setIconPath()

ILIAS\Notifications\Model\ilNotificationConfig::setIconPath ( string $path )

Definition at line 92 of file ilNotificationConfig.php.

References $path.

                                              : void
     {
         $this->iconPath = $path;
     }

◆ setIdentification()

ILIAS\Notifications\Model\ilNotificationConfig::setIdentification ( NotificationIdentification $identification )

Definition at line 305 of file ilNotificationConfig.php.

References ILIAS\Notifications\Model\ilNotificationConfig\$identification.

                                                                                  : void
     {
         $this->identification = $identification;
     }

◆ setLinks()

ILIAS\Notifications\Model\ilNotificationConfig::setLinks ( array $links )

Parameters

ilNotificationLink[] $links

Definition at line 79 of file ilNotificationConfig.php.

References ILIAS\Notifications\Model\ilNotificationConfig\$links.

                                           : void
     {
         $this->links = $links;
     }

◆ setLongDescriptionVar()

ILIAS\Notifications\Model\ilNotificationConfig::setLongDescriptionVar	(	string	$name,
		array	$parameters = `[]`,
		string	$language_module = `'notification'`
	)

Parameters

string[] $parameters

Definition at line 131 of file ilNotificationConfig.php.

                                                                                                                          : void
     {
         $this->long_description = new ilNotificationParameter($name, $parameters, $language_module);
     }

◆ setShortDescriptionVar()

ILIAS\Notifications\Model\ilNotificationConfig::setShortDescriptionVar	(	string	$name,
		array	$parameters = `[]`,
		string	$language_module = `'notification'`
	)

Parameters

string[] $parameters

Definition at line 118 of file ilNotificationConfig.php.

                                                                                                                           : void
     {
         $this->short_description = new ilNotificationParameter($name, $parameters, $language_module);
     }

◆ setTitleVar()

ILIAS\Notifications\Model\ilNotificationConfig::setTitleVar	(	string	$name,
		array	$parameters = `[]`,
		string	$language_module = `'notification'`
	)

Parameters

string[] $parameters

Definition at line 105 of file ilNotificationConfig.php.

                                                                                                                : void
     {
         $this->title = new ilNotificationParameter($name, $parameters, $language_module);
     }

◆ setValidForSeconds()

ILIAS\Notifications\Model\ilNotificationConfig::setValidForSeconds ( int $seconds )

Definition at line 159 of file ilNotificationConfig.php.

                                                     : void
     {
         $this->validForSeconds = $seconds;
     }

◆ setVisibleForSeconds()

ILIAS\Notifications\Model\ilNotificationConfig::setVisibleForSeconds ( int $visibleForSeconds )

Deprecated:: since notifications are no longer used for popup presentation.

See the GS Scope Toast for more information.

Definition at line 177 of file ilNotificationConfig.php.

References ILIAS\Notifications\Model\ilNotificationConfig\$visibleForSeconds.

                                                                 : void
     {
         $this->visibleForSeconds = $visibleForSeconds;
     }

◆ unsetHandlerParam()

ILIAS\Notifications\Model\ilNotificationConfig::unsetHandlerParam ( string $name )

Definition at line 300 of file ilNotificationConfig.php.

                                                    : void
     {
         unset($this->handlerParams[$name]);
     }

Field Documentation

◆ $disableAfterDelivery

bool ILIAS\Notifications\Model\ilNotificationConfig::$disableAfterDelivery = false

private

Definition at line 46 of file ilNotificationConfig.php.

Referenced by ILIAS\Notifications\Model\ilNotificationConfig\hasDisableAfterDeliverySet().

◆ $handlerParams

array ILIAS\Notifications\Model\ilNotificationConfig::$handlerParams = []

private

Definition at line 49 of file ilNotificationConfig.php.

Referenced by ILIAS\Notifications\Model\ilNotificationConfig\getHandlerParams().

◆ $iconPath

string ILIAS\Notifications\Model\ilNotificationConfig::$iconPath

private

Definition at line 43 of file ilNotificationConfig.php.

Referenced by ILIAS\Notifications\Model\ilNotificationConfig\getIconPath(), and ILIAS\Notifications\Model\ilNotificationConfig\getUserInstance().

◆ $identification

NotificationIdentification ILIAS\Notifications\Model\ilNotificationConfig::$identification

private

Definition at line 50 of file ilNotificationConfig.php.

Referenced by ILIAS\Notifications\Model\ilNotificationConfig\__construct(), ILIAS\Notifications\Model\ilNotificationConfig\getIdentification(), and ILIAS\Notifications\Model\ilNotificationConfig\setIdentification().

◆ $links

array ILIAS\Notifications\Model\ilNotificationConfig::$links = []

private

Definition at line 41 of file ilNotificationConfig.php.

Referenced by ILIAS\Notifications\Model\ilNotificationConfig\getLinks(), and ILIAS\Notifications\Model\ilNotificationConfig\setLinks().

◆ $long_description

ilNotificationParameter ILIAS\Notifications\Model\ilNotificationConfig::$long_description

private

Definition at line 45 of file ilNotificationConfig.php.

Referenced by ILIAS\Notifications\Model\ilNotificationConfig\getLanguageParameters().

◆ $short_description

ilNotificationParameter ILIAS\Notifications\Model\ilNotificationConfig::$short_description

private

Definition at line 44 of file ilNotificationConfig.php.

Referenced by ILIAS\Notifications\Model\ilNotificationConfig\getLanguageParameters().

◆ $title

ilNotificationParameter ILIAS\Notifications\Model\ilNotificationConfig::$title

private

Definition at line 42 of file ilNotificationConfig.php.

Referenced by ILIAS\Notifications\Model\ilNotificationConfig\getLanguageParameters(), and ILIAS\Notifications\Model\ilNotificationConfig\getUserInstance().

◆ $type

string ILIAS\Notifications\Model\ilNotificationConfig::$type

private

Definition at line 37 of file ilNotificationConfig.php.

Referenced by ILIAS\Notifications\Model\ilNotificationConfig\getType().

◆ $validForSeconds

int ILIAS\Notifications\Model\ilNotificationConfig::$validForSeconds = 0

private

Definition at line 47 of file ilNotificationConfig.php.

Referenced by ILIAS\Notifications\Model\ilNotificationConfig\getValidForSeconds().

◆ $visibleForSeconds

int ILIAS\Notifications\Model\ilNotificationConfig::$visibleForSeconds = 0

protected

Definition at line 48 of file ilNotificationConfig.php.

Referenced by ILIAS\Notifications\Model\ilNotificationConfig\getVisibleForSeconds(), and ILIAS\Notifications\Model\ilNotificationConfig\setVisibleForSeconds().

◆ DEFAULT_TTS

const ILIAS\Notifications\Model\ilNotificationConfig::DEFAULT_TTS = 5

Definition at line 35 of file ilNotificationConfig.php.

◆ TTL_LONG

const ILIAS\Notifications\Model\ilNotificationConfig::TTL_LONG = 1800

Definition at line 33 of file ilNotificationConfig.php.

◆ TTL_SHORT

const ILIAS\Notifications\Model\ilNotificationConfig::TTL_SHORT = 120

Definition at line 34 of file ilNotificationConfig.php.

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

Services/Notifications/classes/Model/ilNotificationConfig.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ afterSendToListeners()

◆ afterSendToUsers()

◆ beforeSendToListeners()

◆ beforeSendToUsers()

◆ getHandlerParams()

◆ getIconPath()

◆ getIdentification()

◆ getLanguageParameters()

◆ getLinks()

◆ getLongDescriptionVar()

◆ getShortDescriptionVar()

◆ getTitleVar()

◆ getType()

◆ getUserInstance()

◆ getValidForSeconds()

◆ getVisibleForSeconds()

◆ hasDisableAfterDeliverySet()

◆ notifyByListeners()

◆ notifyByRoles()

◆ notifyByUsers()

◆ setAutoDisable()

◆ setHandlerParam()

◆ setIconPath()

◆ setIdentification()

◆ setLinks()

◆ setLongDescriptionVar()

◆ setShortDescriptionVar()

◆ setTitleVar()

◆ setValidForSeconds()

◆ setVisibleForSeconds()

◆ unsetHandlerParam()

Field Documentation

◆ $disableAfterDelivery

◆ $handlerParams

◆ $iconPath

◆ $identification

◆ $links

◆ $long_description

◆ $short_description

◆ $title

◆ $type

◆ $validForSeconds

◆ $visibleForSeconds

◆ DEFAULT_TTS

◆ TTL_LONG

◆ TTL_SHORT