Describes a notification and provides methods for publishing this notification. More...

Collaboration diagram for ilNotificationConfig:

Public Member Functions
	__construct ($type)

	getType ()

	setAutoDisable ($value)

	hasDisableAfterDeliverySet ()

	setLink ($link)

	getLink ()

	setIconPath ($path)

	getIconPath ()

	setTitleVar ($name, $parameters=array(), $language_module='notification')
	Sets the name of the language variable to use as title. More...

	getTitleVar ()

	setShortDescriptionVar ($name, $parameters=array(), $language_module='notification')
	Sets the name of the language variable to use as short description text. More...

	getShortDescriptionVar ()

	setLongDescriptionVar ($name, $parameters=array(), $language_module='notification')
	Sets the name of the language variable to use as long description text. More...

	getLongDescriptionVar ()

	getLanguageParameters ()

	getLinktarget ()

	setLinktarget ($linktarget)

	setValidForSeconds ($seconds)

	getValidForSeconds ()

	getVisibleForSeconds ()

	setVisibleForSeconds ($visibleForSeconds)

	notifyByUsers (array $recipients, $processAsync=false)
	sends this notification to a list of users More...

	notifyByListeners ($ref_id, $processAsync=false)

	notifyByRoles (array $roles, $processAsync=false)

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

	setHandlerParam ($name, $value)

	getHandlerParams ()

	unsetHandlerParam ($name)

Data Fields
const	TTL_LONG = 1800

const	TTL_SHORT = 120

const	DEFAULT_TTS = 5

Protected Member Functions
	beforeSendToUsers ()

	afterSendToUsers ()

	beforeSendToListeners ()

	afterSendToListeners ()

Protected Attributes
	$visibleForSeconds = 0

Private Attributes
	$type

	$link

	$linktarget = '_self'

	$title

	$iconPath

	$short_description

	$long_description

	$disableAfterDelivery = false

	$validForSeconds = 0

	$handlerParams = array()

Detailed Description

Describes a notification and provides methods for publishing this notification.

Definition at line 6 of file class.ilNotificationConfig.php.

Constructor & Destructor Documentation

◆ __construct()

ilNotificationConfig::__construct ( $type )

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

References $type.

     {
         $this->type = $type;
     }

Member Function Documentation

◆ afterSendToListeners()

ilNotificationConfig::afterSendToListeners ( )

protected

Definition at line 231 of file class.ilNotificationConfig.php.

Referenced by notifyByListeners().

232 {

233 }

Here is the caller graph for this function:

◆ afterSendToUsers()

ilNotificationConfig::afterSendToUsers ( )

protected

Definition at line 223 of file class.ilNotificationConfig.php.

Referenced by notifyByUsers().

224 {

225 }

Here is the caller graph for this function:

◆ beforeSendToListeners()

ilNotificationConfig::beforeSendToListeners ( )

protected

Definition at line 227 of file class.ilNotificationConfig.php.

Referenced by notifyByListeners().

228 {

229 }

Here is the caller graph for this function:

◆ beforeSendToUsers()

ilNotificationConfig::beforeSendToUsers ( )

protected

Definition at line 219 of file class.ilNotificationConfig.php.

Referenced by notifyByUsers().

220 {

221 }

Here is the caller graph for this function:

◆ getHandlerParams()

ilNotificationConfig::getHandlerParams ( )

Definition at line 316 of file class.ilNotificationConfig.php.

References $handlerParams.

     {
         return $this->handlerParams;
     }

◆ getIconPath()

ilNotificationConfig::getIconPath ( )

Definition at line 105 of file class.ilNotificationConfig.php.

References $iconPath.

     {
         return $this->iconPath;
     }

◆ getLanguageParameters()

ilNotificationConfig::getLanguageParameters ( )

Definition at line 174 of file class.ilNotificationConfig.php.

Referenced by ilNotificationSystem\toUsers().

     {
         return array(
             'title' => $this->title,
             'longDescription' => $this->long_description,
             'shortDescription' => $this->short_description,
         );
     }

Here is the caller graph for this function:

◆ getLink()

ilNotificationConfig::getLink ( )

Definition at line 95 of file class.ilNotificationConfig.php.

References $link.

     {
         return $this->link;
     }

◆ getLinktarget()

ilNotificationConfig::getLinktarget ( )

Definition at line 183 of file class.ilNotificationConfig.php.

References $linktarget.

     {
         return $this->linktarget;
     }

◆ getLongDescriptionVar()

ilNotificationConfig::getLongDescriptionVar ( )

Definition at line 169 of file class.ilNotificationConfig.php.

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

◆ getShortDescriptionVar()

ilNotificationConfig::getShortDescriptionVar ( )

Definition at line 147 of file class.ilNotificationConfig.php.

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

◆ getTitleVar()

ilNotificationConfig::getTitleVar ( )

Definition at line 125 of file class.ilNotificationConfig.php.

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

◆ getType()

ilNotificationConfig::getType ( )

Definition at line 75 of file class.ilNotificationConfig.php.

References $type.

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

     {
         return $this->type;
     }

Here is the caller graph for this function:

◆ getUserInstance()

ilNotificationConfig::getUserInstance	(	ilObjUser	$user,
			$languageVars,
			$defaultLanguage
	)

Definition at line 263 of file class.ilNotificationConfig.php.

References $defaultLanguage, $iconPath, $title, and ilObjUser\getLanguage().

Referenced by ilNotificationSystem\toUsers().

     {
         $notificationObject = new ilNotificationObject($this, $user);
 
         $title = '';
         $short = '';
         $long = '';
 
         if ($languageVars[$this->title->getName()]->lang[$user->getLanguage()]) {
             $title = $languageVars[$this->title->getName()]->lang[$user->getLanguage()];
         } elseif ($languageVars[$this->title->getName()]->lang[$defaultLanguage]) {
             $title = $languageVars[$this->title->getName()]->lang[$defaultLanguage];
         } else {
             $title = $this->title->getName();
         }
 
         if ($languageVars[$this->short_description->getName()]->lang[$user->getLanguage()]) {
             $short = $languageVars[$this->short_description->getName()]->lang[$user->getLanguage()];
         } elseif ($languageVars[$this->short_description->getName()]->lang[$defaultLanguage]) {
             $short = $languageVars[$this->short_description->getName()]->lang[$defaultLanguage];
         } else {
             $short = $this->short_description->getName();
         }
 
         if ($languageVars[$this->long_description->getName()]->lang[$user->getLanguage()]) {
             $long = $languageVars[$this->long_description->getName()]->lang[$user->getLanguage()];
         } elseif ($languageVars[$this->long_description->getName()]->lang[$defaultLanguage]) {
             $long = $languageVars[$this->long_description->getName()]->lang[$defaultLanguage];
         } else {
             $long = $this->long_description->getName();
         }
 
         $notificationObject->title = $title;
         $notificationObject->shortDescription = $short;
         $notificationObject->longDescription = $long;
 
         $notificationObject->iconPath = $this->iconPath;
 
         return $notificationObject;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getValidForSeconds()

ilNotificationConfig::getValidForSeconds ( )

Definition at line 198 of file class.ilNotificationConfig.php.

References $validForSeconds.

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

     {
         return $this->validForSeconds;
     }

Here is the caller graph for this function:

◆ getVisibleForSeconds()

ilNotificationConfig::getVisibleForSeconds ( )

Returns: int

Definition at line 206 of file class.ilNotificationConfig.php.

References $visibleForSeconds.

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

     {
         return $this->visibleForSeconds;
     }

Here is the caller graph for this function:

◆ hasDisableAfterDeliverySet()

ilNotificationConfig::hasDisableAfterDeliverySet ( )

Definition at line 85 of file class.ilNotificationConfig.php.

References $disableAfterDelivery.

Referenced by ilNotificationSystem\toListeners().

     {
         return (bool) $this->disableAfterDelivery;
     }

Here is the caller graph for this function:

◆ notifyByListeners()

ilNotificationConfig::notifyByListeners	(	$ref_id,
		$processAsync = `false`
	)

final

Definition at line 247 of file class.ilNotificationConfig.php.

References afterSendToListeners(), beforeSendToListeners(), and ilNotificationSystem\sendNotificationToListeners().

     {
         require_once 'Services/Notifications/classes/class.ilNotificationSystem.php';
         $this->beforeSendToListeners();
         ilNotificationSystem::sendNotificationToListeners($this, $ref_id, $processAsync);
         $this->afterSendToListeners();
     }

Here is the call graph for this function:

◆ notifyByRoles()

ilNotificationConfig::notifyByRoles	(	array	$roles,
			$processAsync = `false`
	)

final

Definition at line 255 of file class.ilNotificationConfig.php.

References ilNotificationSystem\sendNotificationToRoles().

     {
         require_once 'Services/Notifications/classes/class.ilNotificationSystem.php';
         //$this->beforeSendToListeners();
         ilNotificationSystem::sendNotificationToRoles($this, $roles, $processAsync);
         //$this->afterSendToListeners();
     }

Here is the call graph for this function:

◆ notifyByUsers()

ilNotificationConfig::notifyByUsers	(	array	$recipients,
			$processAsync = `false`
	)

final

sends this notification to a list of users

Parameters

array $recipients

Definition at line 239 of file class.ilNotificationConfig.php.

References afterSendToUsers(), beforeSendToUsers(), and ilNotificationSystem\sendNotificationToUsers().

     {
         require_once 'Services/Notifications/classes/class.ilNotificationSystem.php';
         $this->beforeSendToUsers();
         ilNotificationSystem::sendNotificationToUsers($this, $recipients, $processAsync);
         $this->afterSendToUsers();
     }

Here is the call graph for this function:

◆ setAutoDisable()

ilNotificationConfig::setAutoDisable ( $value )

Definition at line 80 of file class.ilNotificationConfig.php.

     {
         $this->disableAfterDelivery = $value;
     }

◆ setHandlerParam()

ilNotificationConfig::setHandlerParam	(	$name,
		$value
	)

Definition at line 304 of file class.ilNotificationConfig.php.

References $name.

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

◆ setIconPath()

ilNotificationConfig::setIconPath ( $path )

Definition at line 100 of file class.ilNotificationConfig.php.

References $path.

     {
         $this->iconPath = $path;
     }

◆ setLink()

ilNotificationConfig::setLink ( $link )

Definition at line 90 of file class.ilNotificationConfig.php.

References $link.

     {
         $this->link = $link;
     }

◆ setLinktarget()

ilNotificationConfig::setLinktarget ( $linktarget )

Definition at line 188 of file class.ilNotificationConfig.php.

References $linktarget.

     {
         $this->linktarget = $linktarget;
     }

◆ setLongDescriptionVar()

ilNotificationConfig::setLongDescriptionVar	(	$name,
		$parameters = `array()`,
		$language_module = `'notification'`
	)

Sets the name of the language variable to use as long description text.

The translation may include [name] parts wich will be replaced by the matching parameter found in $parameters. The language var is loaded from the language module given as third parameter. The channel itself decided if the short description or the long description should be used Placeholders of type ##name## are deprecated

Parameters

string	$name
array	$parameters
string	$language_module

Definition at line 164 of file class.ilNotificationConfig.php.

References $name.

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

◆ setShortDescriptionVar()

ilNotificationConfig::setShortDescriptionVar	(	$name,
		$parameters = `array()`,
		$language_module = `'notification'`
	)

Sets the name of the language variable to use as short description text.

The translation may include [NAME] parts wich will be replaced by the matching parameter found in $parameters. The language var is loaded from the language module given as third parameter. Placeholders of type ##name## are deprecated The channel itself decided if the short description or the long description should be used

Parameters

string	$name
array	$parameters
string	$language_module

Definition at line 142 of file class.ilNotificationConfig.php.

References $name.

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

◆ setTitleVar()

ilNotificationConfig::setTitleVar	(	$name,
		$parameters = `array()`,
		$language_module = `'notification'`
	)

Sets the name of the language variable to use as title.

The translation may include [NAME] parts wich will be replaced by the matching parameter found in $parameters. The language var is loaded from the language module given as third parameter. Placeholders of type ##name## are deprecated

Parameters

type	$name
type	$parameters
type	$language_module

Definition at line 120 of file class.ilNotificationConfig.php.

References $name.

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

◆ setValidForSeconds()

ilNotificationConfig::setValidForSeconds ( $seconds )

Definition at line 193 of file class.ilNotificationConfig.php.

     {
         $this->validForSeconds = $seconds;
     }

◆ setVisibleForSeconds()

ilNotificationConfig::setVisibleForSeconds ( $visibleForSeconds )

Parameters

int $visibleForSeconds

Definition at line 214 of file class.ilNotificationConfig.php.

References $visibleForSeconds.

     {
         $this->visibleForSeconds = $visibleForSeconds;
     }

◆ unsetHandlerParam()

ilNotificationConfig::unsetHandlerParam ( $name )

Definition at line 321 of file class.ilNotificationConfig.php.

References $name.

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

Field Documentation

◆ $disableAfterDelivery

ilNotificationConfig::$disableAfterDelivery = false

private

Definition at line 50 of file class.ilNotificationConfig.php.

Referenced by hasDisableAfterDeliverySet().

◆ $handlerParams

ilNotificationConfig::$handlerParams = array()

private

Definition at line 68 of file class.ilNotificationConfig.php.

Referenced by getHandlerParams().

◆ $iconPath

ilNotificationConfig::$iconPath

private

Definition at line 35 of file class.ilNotificationConfig.php.

Referenced by getIconPath(), and getUserInstance().

◆ $link

ilNotificationConfig::$link

private

Definition at line 25 of file class.ilNotificationConfig.php.

Referenced by getLink(), and setLink().

◆ $linktarget

ilNotificationConfig::$linktarget = '_self'

private

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

Referenced by getLinktarget(), and setLinktarget().

◆ $long_description

ilNotificationConfig::$long_description

private

Definition at line 38 of file class.ilNotificationConfig.php.

◆ $short_description

ilNotificationConfig::$short_description

private

Definition at line 37 of file class.ilNotificationConfig.php.

◆ $title

ilNotificationConfig::$title

private

Definition at line 28 of file class.ilNotificationConfig.php.

Referenced by getUserInstance().

◆ $type

ilNotificationConfig::$type

private

Definition at line 17 of file class.ilNotificationConfig.php.

Referenced by __construct(), and getType().

◆ $validForSeconds

ilNotificationConfig::$validForSeconds = 0

private

Definition at line 56 of file class.ilNotificationConfig.php.

Referenced by getValidForSeconds().

◆ $visibleForSeconds

ilNotificationConfig::$visibleForSeconds = 0

protected

Definition at line 62 of file class.ilNotificationConfig.php.

Referenced by getVisibleForSeconds(), and setVisibleForSeconds().

◆ DEFAULT_TTS

const ilNotificationConfig::DEFAULT_TTS = 5

Definition at line 11 of file class.ilNotificationConfig.php.

Referenced by ilChatroom\isOwnerOfPrivateRoom(), ilAwarenessAct\notifyOnNewOnlineContacts(), ilBuddySystemNotification\send(), and ilBadgeHandler\sendNotification().

◆ TTL_LONG

const ilNotificationConfig::TTL_LONG = 1800

Definition at line 8 of file class.ilNotificationConfig.php.

Referenced by ilChatroom\isOwnerOfPrivateRoom(), and ilBuddySystemNotification\send().

◆ TTL_SHORT

const ilNotificationConfig::TTL_SHORT = 120

Definition at line 9 of file class.ilNotificationConfig.php.

Referenced by ilAwarenessAct\notifyOnNewOnlineContacts(), and ilBadgeHandler\sendNotification().

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

Services/Notifications/classes/class.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()

◆ getLanguageParameters()

◆ getLink()

◆ getLinktarget()

◆ getLongDescriptionVar()

◆ getShortDescriptionVar()

◆ getTitleVar()

◆ getType()

◆ getUserInstance()

◆ getValidForSeconds()

◆ getVisibleForSeconds()

◆ hasDisableAfterDeliverySet()

◆ notifyByListeners()

◆ notifyByRoles()

◆ notifyByUsers()

◆ setAutoDisable()

◆ setHandlerParam()

◆ setIconPath()

◆ setLink()

◆ setLinktarget()

◆ setLongDescriptionVar()

◆ setShortDescriptionVar()

◆ setTitleVar()

◆ setValidForSeconds()

◆ setVisibleForSeconds()

◆ unsetHandlerParam()

Field Documentation

◆ $disableAfterDelivery

◆ $handlerParams

◆ $iconPath

◆ $link

◆ $linktarget

◆ $long_description

◆ $short_description

◆ $title

◆ $type

◆ $validForSeconds

◆ $visibleForSeconds

◆ DEFAULT_TTS

◆ TTL_LONG

◆ TTL_SHORT