Collaboration diagram for ILIAS\Notifications\Model\ilNotificationConfig:

Public Member Functions
	__construct (private readonly string $provider, private ?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, bool $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
final const	TTL_LONG = 1800

final const	TTL_SHORT = 120

final const	DEFAULT_TTS = 5

Protected Member Functions
	beforeSendToUsers ()

	afterSendToUsers ()

	beforeSendToListeners ()

	afterSendToListeners ()

Protected Attributes
int	$visibleForSeconds = 0

Private Attributes
array	$links = []

ilNotificationParameter	$title

string	$iconPath

ilNotificationParameter	$short_description

ilNotificationParameter	$long_description

bool	$disableAfterDelivery = false

int	$validForSeconds = 0

array	$handlerParams = []

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	(	private readonly string	$provider,
		private ?NotificationIdentification	$identification = `null`
	)

Definition at line 49 of file ilNotificationConfig.php.

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

References $provider.

Member Function Documentation

◆ afterSendToListeners()

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

protected

Definition at line 196 of file ilNotificationConfig.php.

                                             : void
    {
    }

◆ afterSendToUsers()

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

protected

Definition at line 188 of file ilNotificationConfig.php.

                                         : void
    {
    }

◆ beforeSendToListeners()

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

protected

Definition at line 192 of file ilNotificationConfig.php.

                                              : void
    {
    }

◆ beforeSendToUsers()

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

protected

Definition at line 184 of file ilNotificationConfig.php.

                                          : void
    {
    }

◆ getHandlerParams()

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

Returns: array<string, array<string, string>>

Definition at line 303 of file ilNotificationConfig.php.

                                      : array
    {
        return $this->handlerParams;
    }

◆ getIconPath()

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

Definition at line 93 of file ilNotificationConfig.php.

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

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

◆ getIdentification()

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

Definition at line 318 of file ilNotificationConfig.php.

                                       : NotificationIdentification
    {
        return $this->identification;
    }

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

Here is the caller graph for this function:

◆ getLanguageParameters()

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

Returns: array<string, ilNotificationParameter>

Definition at line 146 of file ilNotificationConfig.php.

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

References $id, and $params.

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

Here is the caller graph for this function:

◆ getLinks()

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

Returns: list<ilNotificationLink>

Definition at line 83 of file ilNotificationConfig.php.

                              : array
    {
        return $this->links;
    }

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

◆ getLongDescriptionVar()

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

Definition at line 138 of file ilNotificationConfig.php.

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

◆ getShortDescriptionVar()

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

Definition at line 122 of file ilNotificationConfig.php.

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

◆ getTitleVar()

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

Definition at line 106 of file ilNotificationConfig.php.

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

◆ getType()

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

Definition at line 57 of file ilNotificationConfig.php.

                             : string
    {
        return $this->provider;
    }

References $provider.

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

Here is the caller graph for this function:

◆ getUserInstance()

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

Parameters

array<string,stdClass> $languageVars

Definition at line 228 of file ilNotificationConfig.php.

                                                                                                  : 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->getTitleParameter()->getName();
            if (isset($languageVars[$link->getTitleParameter()->getName()])) {
                $var = $languageVars[$link->getTitleParameter()->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;
    }

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

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

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 166 of file ilNotificationConfig.php.

                                        : int
    {
        return $this->validForSeconds;
    }

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

Here is the caller graph for this function:

◆ getVisibleForSeconds()

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

Definition at line 171 of file ilNotificationConfig.php.

                                          : int
    {
        return $this->visibleForSeconds;
    }

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

Here is the caller graph for this function:

◆ hasDisableAfterDeliverySet()

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

Definition at line 67 of file ilNotificationConfig.php.

                                                : bool
    {
        return $this->disableAfterDelivery;
    }

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

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

Here is the caller graph for this function:

◆ notifyByListeners()

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

final

Definition at line 210 of file ilNotificationConfig.php.

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

References $ref_id.

◆ notifyByRoles()

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

final

Parameters

list<int> $roles

Definition at line 220 of file ilNotificationConfig.php.

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

◆ notifyByUsers()

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

final

Parameters

list<int> $recipients

Definition at line 203 of file ilNotificationConfig.php.

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

◆ setAutoDisable()

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

Definition at line 62 of file ilNotificationConfig.php.

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

◆ setHandlerParam()

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

Definition at line 288 of file ilNotificationConfig.php.

                                                                : 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 88 of file ilNotificationConfig.php.

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

References $path.

◆ setIdentification()

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

Definition at line 313 of file ilNotificationConfig.php.

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

◆ setLinks()

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

Parameters

list<ilNotificationLink> $links

Definition at line 75 of file ilNotificationConfig.php.

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

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

◆ setLongDescriptionVar()

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

Parameters

array<string,string> $parameters

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

array<string,string> $parameters

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

array<string,string> $parameters

Definition at line 101 of file ilNotificationConfig.php.

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

◆ setValidForSeconds()

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

Definition at line 161 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 179 of file ilNotificationConfig.php.

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

◆ unsetHandlerParam()

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

Definition at line 308 of file ilNotificationConfig.php.

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

Field Documentation

◆ $disableAfterDelivery

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

private

Definition at line 43 of file ilNotificationConfig.php.

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

◆ $handlerParams

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

private

Definition at line 47 of file ilNotificationConfig.php.

◆ $iconPath

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

private

Definition at line 40 of file ilNotificationConfig.php.

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

◆ $links

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

private

Definition at line 38 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 42 of file ilNotificationConfig.php.

◆ $short_description

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

private

Definition at line 41 of file ilNotificationConfig.php.

◆ $title

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

private

Definition at line 39 of file ilNotificationConfig.php.

◆ $validForSeconds

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

private

Definition at line 44 of file ilNotificationConfig.php.

◆ $visibleForSeconds

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

protected

Definition at line 45 of file ilNotificationConfig.php.

◆ DEFAULT_TTS

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

Definition at line 35 of file ilNotificationConfig.php.

◆ TTL_LONG

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

Definition at line 33 of file ilNotificationConfig.php.

◆ TTL_SHORT

final 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:

components/ILIAS/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

◆ $links

◆ $long_description

◆ $short_description

◆ $title

◆ $validForSeconds

◆ $visibleForSeconds

◆ DEFAULT_TTS

◆ TTL_LONG

◆ TTL_SHORT