ilADNNotification Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilADNNotification:

Collaboration diagram for ilADNNotification:

Public Member Functions
	getConnectorContainerName ()
	@description Return the Name of your Connector Table More...
	dismiss (ilObjUser $ilObjUser)
	resetForAllUsers ()
	getFullTimeFormated ()
	isUserAllowedToDismiss (ilObjUser $user)
	getActiveType ()
	isVisibleForUser (ilObjUser $ilObjUser)
	wakeUp ($field_name, $field_value)
	create ()
	setBody (string $body)
	getBody ()
	setDisplayEnd (DateTimeImmutable $display_end)
	getDisplayEnd ()
	setDisplayStart (DateTimeImmutable $display_start)
	getDisplayStart ()
	setEventEnd (DateTimeImmutable $event_end)
	getEventEnd ()
	setEventStart (DateTimeImmutable $event_start)
	getEventStart ()
	setId (int $id)
	getId ()
	setTitle (string $title)
	getTitle ()
	setType (int $type)
	getType ()
	setTypeDuringEvent (int $type_during_event)
	getTypeDuringEvent ()
	setDismissable (bool $dismissable)
	getDismissable ()
	setPermanent (bool $permanent)
	isPermanent ()
	isDuringEvent ()
	setCreateDate (DateTimeImmutable $create_date)
	getCreateDate ()
	setCreatedBy (int $created_by)
	getCreatedBy ()
	isActive ()
	setActive (bool $active)
	getLimitedToLanguages ()
	setLimitedToLanguages (array $limited_to_languages)
	hasLanguageLimitation ()
	setHasLanguageLimitation (bool $has_language_limitation)
	getLimitedToRoleIds ()
	setLimitedToRoleIds (array $limited_to_role_ids)
	isLimitToRoles ()
	setLimitToRoles (bool $limit_to_roles)
Public Member Functions inherited from ActiveRecord
	getArConnector ()
	getArFieldList ()
	getConnectorContainerName ()
	@description Return the Name of your Connector Table More...
	setConnectorContainerName (string $connector_container_name)
	getPrimaryFieldValue ()
	setPrimaryFieldValue ($value)
	__construct (mixed $primary_key=0)
	storeObjectToCache ()
	asStdClass ()
	asArray ()
	buildFromArray (array $array)
	fixDateField ($field_name, string $value)
	sleep ($field_name)
	wakeUp ($field_name, $field_value)
	getArrayForConnector ()
	installConnector ()
	store ()
	save ()
	create ()
	copy (int $new_id=0)
	afterObjectLoad ()
	read ()
	update ()
	delete ()
	__call ($name, $arguments)

Static Public Member Functions
static	returnDbTableName ()
Static Public Member Functions inherited from ActiveRecord
static	returnDbTableName ()
static	installDB ()
static	renameDBField (string $old_name, string $new_name)
static	tableExists ()
static	fieldExists (string $field_name)
static	removeDBField (string $field_name)
static	updateDB ()
static	resetDB ()
static	truncateDB ()
static	flushDB ()
	@depracated never use in ILIAS Core, Plugins only More...
static	preloadObjects ()
static	additionalParams (array $additional_params)
static	findOrFail ($primary_key, array $add_constructor_args=[])
	Tries to find the object and throws an Exception if object is not found, instead of returning null. More...
static	findOrGetInstance ($primary_key, array $add_constructor_args=[])
static	where ($where, $operator=null)
static	innerjoinAR (ActiveRecord $activeRecord, $on_this, string $on_external, array $fields=[' *'], string $operator='=', bool $both_external=false)
static	innerjoin (string $tablename, $on_this, string $on_external, array $fields=[' *'], string $operator='=', bool $both_external=false)
static	leftjoin (string $tablename, $on_this, string $on_external, array $fields=[' *'], string $operator='=', bool $both_external=false)
static	orderBy (string $orderBy, string $orderDirection='ASC')
static	dateFormat (string $date_format='d.m.Y - H:i:s')
static	limit (int $start, int $end)
static	affectedRows ()
static	count ()
static	get ()
static	debug ()
static	first ()
static	getCollection ()
static	last ()
static	getFirstFromLastQuery ()
static	connector (arConnector $arConnector)
static	raw (bool $set_raw=true)
static	getArray (?string $key=null, string|array|null $values=null)
static	_toCamelCase (string $str, bool $capitalise_first_char=false)

Data Fields
const	POS_TOP = 1
const	POS_RIGHT = 2
const	POST_LEFT = 3
const	POS_BOTTOM = 4
const	DATE_FORMAT = 'd.m.Y'
const	TIME_FORMAT = 'H:i'
const	DATE_TIME_FORMAT = 'd.m.Y H:i'
const	TYPE_INFO = 1
const	TYPE_WARNING = 2
const	TYPE_ERROR = 3
const	TABLE_NAME = 'il_adn_notifications'
const	LINK_TYPE_NONE = 0
const	LINK_TYPE_REF_ID = 1
const	LINK_TYPE_URL = 2

Protected Member Functions
	hasUserDismissed (ilObjUser $ilObjUser)
	isVisible ()
	isVisibleToUserBasedOnLanguage (ilObjUser $user)
	isVisibleRoleUserRoles (ilObjUser $ilObjUser)
	hasEventStarted ()
	hasDisplayStarted ()
	hasEventEnded ()
	hasDisplayEnded ()
	getTime ()
Protected Member Functions inherited from ActiveRecord
	installDatabase ()

Protected Attributes
int	$id = null
	@con_is_primary true @con_sequence true @con_is_unique true @con_has_field true @con_fieldtype integer @con_length 8 More...
string	$title = ''
	@con_has_field true @con_fieldtype text @con_length 256 More...
string	$body = ''
	@con_has_field true @con_fieldtype clob More...
DateTimeImmutable	$event_start = null
	@con_has_field true @con_fieldtype integer @con_length 8 More...
DateTimeImmutable	$event_end = null
	@con_has_field true @con_fieldtype integer @con_length 8 More...
DateTimeImmutable	$display_start = null
	@con_has_field true @con_fieldtype integer @con_length 8 More...
DateTimeImmutable	$display_end = null
	@con_has_field true @con_fieldtype integer @con_length 8 More...
int	$type = self::TYPE_INFO
	@con_has_field true @con_fieldtype integer @con_length 1 More...
int	$type_during_event = self::TYPE_ERROR
	@con_has_field true @con_fieldtype integer @con_length 1 More...
bool	$dismissable = true
	@con_has_field true @con_fieldtype integer @con_length 1 More...
bool	$permanent = true
	@con_has_field true @con_fieldtype integer @con_length 1 More...
array	$allowed_users = [0, 6, 13]
	@con_has_field true @con_fieldtype text @con_length 256 More...
int	$parent_id = null
	@con_has_field true @con_fieldtype integer @con_length 8 More...
DateTimeImmutable	$create_date = null
	@con_has_field true @con_fieldtype integer @con_length 8 More...
DateTimeImmutable	$last_update
	@con_has_field true @con_fieldtype integer @con_length 8 More...
int	$created_by = null
	@con_has_field true @con_fieldtype integer @con_length 8 More...
int	$last_update_by = null
	@con_has_field true @con_fieldtype integer @con_length 8 More...
bool	$active = true
	@con_has_field true @con_fieldtype integer @con_length 1 More...
array	$limited_to_languages = []
	@con_has_field true @con_fieldtype text @con_length 256 More...
bool	$has_language_limitation = false
	@con_has_field true @con_fieldtype integer @con_length 1 More...
array	$limited_to_role_ids = []
	@con_has_field true @con_fieldtype text @con_length 256 More...
bool	$limit_to_roles = false
	@con_has_field true @con_fieldtype integer @con_length 1 More...
bool	$interruptive = false
	@con_has_field true @con_fieldtype integer @con_length 1 More...
string	$link = ''
	@con_has_field true @con_fieldtype text @con_length 256 More...
int	$link_type = self::LINK_TYPE_NONE
	@con_has_field true @con_fieldtype integer @con_length 1 More...
string	$link_target = '_top'
	@con_has_field true @con_fieldtype text @con_length 256 More...
Protected Attributes inherited from ActiveRecord
bool	$ar_safe_read = true
string	$connector_container_name = ''
bool	$is_new = true

Static Protected Attributes
static array	$allowed_user_ids = [0, 13, 6]

Additional Inherited Members
Static Protected Member Functions inherited from ActiveRecord
static	getCalledClass ()
	@description Returns an instance of the instatiated calling active record (needs to be done in static methods) @TODO : This should be cached somehow More...
static	fromCamelCase (string $str)

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Class ilADNNotification

Author

Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Version

1.0.0

Definition at line 24 of file class.ilADNNotification.php.

Member Function Documentation

create()

ilADNNotification::create

(

)

Reimplemented from ActiveRecord.

Definition at line 411 of file class.ilADNNotification.php.

                            : void
    {
        global $DIC;
        $this->setCreateDate(new DateTimeImmutable());
        $this->setCreatedBy($DIC->user()->getId());
        parent::create();
    }

References $DIC, setCreateDate(), and setCreatedBy().

Here is the call graph for this function:

dismiss()

ilADNNotification::dismiss

(

ilObjUser

$ilObjUser

)

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

                                                 : void
    {
        if ($this->isUserAllowedToDismiss($ilObjUser)) {
            ilADNDismiss::dismiss($ilObjUser, $this);
        }
    }

References ilADNDismiss\dismiss(), and isUserAllowedToDismiss().

Here is the call graph for this function:

getActiveType()

ilADNNotification::getActiveType

(

)

Definition at line 102 of file class.ilADNNotification.php.

                                   : int
    {
        if ($this->isPermanent()) {
            return $this->getType();
        }
        if ($this->hasEventStarted() && !$this->hasEventEnded()) {
            return $this->getTypeDuringEvent();
        }
        if ($this->hasDisplayStarted() && !$this->hasDisplayEnded()) {
            return $this->getType();
        }
        return self::TYPE_INFO;
    }

References getType(), getTypeDuringEvent(), hasDisplayEnded(), hasDisplayStarted(), hasEventEnded(), hasEventStarted(), isPermanent(), and TYPE_INFO.

Here is the call graph for this function:

getBody()

ilADNNotification::getBody

(

)

Definition at line 424 of file class.ilADNNotification.php.

                             : string
    {
        return $this->body;
    }

References $body.

getConnectorContainerName()

ilADNNotification::getConnectorContainerName

(

)

@description Return the Name of your Connector Table

Reimplemented from ActiveRecord.

Definition at line 43 of file class.ilADNNotification.php.

                                               : string
    {
        return self::TABLE_NAME;
    }

References TABLE_NAME.

getCreateDate()

ilADNNotification::getCreateDate

(

)

Definition at line 562 of file class.ilADNNotification.php.

                                   : DateTimeImmutable
    {
        return $this->create_date ?? new DateTimeImmutable();
    }

getCreatedBy()

ilADNNotification::getCreatedBy

(

)

Definition at line 572 of file class.ilADNNotification.php.

                                  : int
    {
        return (int) $this->created_by;
    }

References $created_by.

getDismissable()

ilADNNotification::getDismissable

(

)

Definition at line 517 of file class.ilADNNotification.php.

                                    : bool
    {
        return $this->dismissable;
    }

References $dismissable.

Referenced by hasUserDismissed(), and isUserAllowedToDismiss().

Here is the caller graph for this function:

getDisplayEnd()

ilADNNotification::getDisplayEnd

(

)

Definition at line 434 of file class.ilADNNotification.php.

                                   : DateTimeImmutable
    {
        return $this->display_end ?? new DateTimeImmutable();
    }

Referenced by hasDisplayEnded().

Here is the caller graph for this function:

getDisplayStart()

ilADNNotification::getDisplayStart

(

)

Definition at line 444 of file class.ilADNNotification.php.

                                     : DateTimeImmutable
    {
        return $this->display_start ?? new DateTimeImmutable();
    }

Referenced by hasDisplayStarted().

Here is the caller graph for this function:

getEventEnd()

ilADNNotification::getEventEnd

(

)

Definition at line 454 of file class.ilADNNotification.php.

                                 : DateTimeImmutable
    {
        return $this->event_end ?? new DateTimeImmutable();
    }

Referenced by getFullTimeFormated(), and hasEventEnded().

Here is the caller graph for this function:

getEventStart()

ilADNNotification::getEventStart

(

)

Definition at line 464 of file class.ilADNNotification.php.

                                   : DateTimeImmutable
    {
        return $this->event_start ?? new DateTimeImmutable();
    }

Referenced by getFullTimeFormated(), and hasEventStarted().

Here is the caller graph for this function:

getFullTimeFormated()

ilADNNotification::getFullTimeFormated

(

)

Definition at line 79 of file class.ilADNNotification.php.

                                         : string
    {
        if ($this->getEventStart() == 0 && $this->getEventEnd() == 0) {
            return '';
        }
        if (date(self::DATE_FORMAT, $this->getEventStart()) === date(self::DATE_FORMAT, $this->getEventEnd())) {
            return date(self::DATE_FORMAT, $this->getEventEnd()) . ', ' . date(
                self::TIME_FORMAT,
                $this->getEventStart()
            ) . " - "
                . date(self::TIME_FORMAT, $this->getEventEnd());
        }
        return date(self::DATE_TIME_FORMAT, $this->getEventStart()) . ' - ' . date(
            self::DATE_TIME_FORMAT,
            $this->getEventEnd()
        );
    }

References getEventEnd(), and getEventStart().

Here is the call graph for this function:

getId()

ilADNNotification::getId

(

)

Definition at line 474 of file class.ilADNNotification.php.

                           : int
    {
        return (int) $this->id;
    }

References $id.

Referenced by ilADNNotificationGUI\confirmDelete(), ilADNDismiss\dismiss(), ilADNDismiss\hasDimissed(), and resetForAllUsers().

Here is the caller graph for this function:

getLimitedToLanguages()

ilADNNotification::getLimitedToLanguages

(

)

Definition at line 592 of file class.ilADNNotification.php.

                                           : array
    {
        return $this->limited_to_languages;
    }

References $limited_to_languages.

Referenced by isVisibleToUserBasedOnLanguage().

Here is the caller graph for this function:

getLimitedToRoleIds()

ilADNNotification::getLimitedToRoleIds

(

)

Definition at line 612 of file class.ilADNNotification.php.

                                         : array
    {
        return $this->limited_to_role_ids;
    }

References $limited_to_role_ids.

Referenced by isVisibleRoleUserRoles().

Here is the caller graph for this function:

getTime()

ilADNNotification::getTime ( )

protected

Definition at line 577 of file class.ilADNNotification.php.

                                : DateTimeImmutable
    {
        return new DateTimeImmutable();
    }

Referenced by hasDisplayEnded(), hasDisplayStarted(), hasEventEnded(), and hasEventStarted().

Here is the caller graph for this function:

getTitle()

ilADNNotification::getTitle

(

)

Definition at line 484 of file class.ilADNNotification.php.

                              : string
    {
        return $this->title;
    }

References $title.

Referenced by ilADNNotificationGUI\confirmDelete().

Here is the caller graph for this function:

getType()

ilADNNotification::getType

(

)

Definition at line 494 of file class.ilADNNotification.php.

                             : int
    {
        return $this->type;
    }

References $type.

Referenced by getActiveType().

Here is the caller graph for this function:

getTypeDuringEvent()

ilADNNotification::getTypeDuringEvent

(

)

Definition at line 504 of file class.ilADNNotification.php.

                                        : int
    {
        return in_array(
            $this->type_during_event,
            [self::TYPE_WARNING, self::TYPE_ERROR, self::TYPE_INFO]
        ) ? $this->type_during_event : self::TYPE_INFO;
    }

References TYPE_INFO.

Referenced by getActiveType().

Here is the caller graph for this function:

hasDisplayEnded()

ilADNNotification::hasDisplayEnded ( )

protected

Definition at line 537 of file class.ilADNNotification.php.

                                        : bool
    {
        return $this->getTime() > $this->getDisplayEnd();
    }

References getDisplayEnd(), and getTime().

Referenced by getActiveType(), and isVisible().

Here is the call graph for this function:

Here is the caller graph for this function:

hasDisplayStarted()

ilADNNotification::hasDisplayStarted ( )

protected

Definition at line 527 of file class.ilADNNotification.php.

                                          : bool
    {
        return $this->getTime() > $this->getDisplayStart();
    }

References getDisplayStart(), and getTime().

Referenced by getActiveType(), and isVisible().

Here is the call graph for this function:

Here is the caller graph for this function:

hasEventEnded()

ilADNNotification::hasEventEnded ( )

protected

Definition at line 532 of file class.ilADNNotification.php.

                                      : bool
    {
        return $this->getTime() > $this->getEventEnd();
    }

References getEventEnd(), and getTime().

Referenced by getActiveType(), isDuringEvent(), and isVisible().

Here is the call graph for this function:

Here is the caller graph for this function:

hasEventStarted()

ilADNNotification::hasEventStarted ( )

protected

Definition at line 522 of file class.ilADNNotification.php.

                                        : bool
    {
        return $this->getTime() > $this->getEventStart();
    }

References getEventStart(), and getTime().

Referenced by getActiveType(), isDuringEvent(), and isVisible().

Here is the call graph for this function:

Here is the caller graph for this function:

hasLanguageLimitation()

ilADNNotification::hasLanguageLimitation

(

)

Definition at line 602 of file class.ilADNNotification.php.

                                           : bool
    {
        return $this->has_language_limitation;
    }

References $has_language_limitation.

Referenced by isVisibleToUserBasedOnLanguage().

Here is the caller graph for this function:

hasUserDismissed()

ilADNNotification::hasUserDismissed ( ilObjUser  $ilObjUser )

protected

Definition at line 63 of file class.ilADNNotification.php.

                                                             : bool
    {
        if (!$this->getDismissable()) {
            return false;
        }
 
        return ilADNDismiss::hasDimissed($ilObjUser, $this);
    }

References getDismissable(), and ilADNDismiss\hasDimissed().

Referenced by isVisibleForUser().

Here is the call graph for this function:

Here is the caller graph for this function:

isActive()

ilADNNotification::isActive

(

)

Definition at line 582 of file class.ilADNNotification.php.

                              : bool
    {
        return $this->active;
    }

References $active.

isDuringEvent()

ilADNNotification::isDuringEvent

(

)

Definition at line 552 of file class.ilADNNotification.php.

                                   : bool
    {
        return $this->hasEventStarted() && !$this->hasEventEnded();
    }

References hasEventEnded(), and hasEventStarted().

Here is the call graph for this function:

isLimitToRoles()

ilADNNotification::isLimitToRoles

(

)

Definition at line 622 of file class.ilADNNotification.php.

                                    : bool
    {
        return $this->limit_to_roles;
    }

References $limit_to_roles.

Referenced by isVisibleRoleUserRoles().

Here is the caller graph for this function:

isPermanent()

ilADNNotification::isPermanent

(

)

Definition at line 547 of file class.ilADNNotification.php.

                                 : bool
    {
        return $this->permanent;
    }

References $permanent.

Referenced by getActiveType(), and isVisible().

Here is the caller graph for this function:

isUserAllowedToDismiss()

ilADNNotification::isUserAllowedToDismiss

(

ilObjUser

$user

)

Definition at line 97 of file class.ilADNNotification.php.

                                                           : bool
    {
        return ($this->getDismissable() && $user->getId() !== 0 && $user->getId() !== ANONYMOUS_USER_ID);
    }

References ANONYMOUS_USER_ID, getDismissable(), and ilObject\getId().

Referenced by dismiss(), and ilADNDismiss\dismiss().

Here is the call graph for this function:

Here is the caller graph for this function:

isVisible()

ilADNNotification::isVisible ( )

protected

Definition at line 117 of file class.ilADNNotification.php.

                                  : bool
    {
        if ($this->isPermanent()) {
            return true;
        }
        $hasEventStarted = $this->hasEventStarted();
        $hasDisplayStarted = $this->hasDisplayStarted();
        $hasEventEnded = !$this->hasEventEnded();
        $hasDisplayEnded = !$this->hasDisplayEnded();
 
        return ($hasEventStarted || $hasDisplayStarted)
            && ($hasEventEnded || $hasDisplayEnded);
    }

References hasDisplayEnded(), hasDisplayStarted(), hasEventEnded(), hasEventStarted(), and isPermanent().

Referenced by isVisibleForUser().

Here is the call graph for this function:

Here is the caller graph for this function:

isVisibleForUser()

ilADNNotification::isVisibleForUser

(

ilObjUser

$ilObjUser

)

Definition at line 131 of file class.ilADNNotification.php.

                                                          : bool
    {
        if ($ilObjUser->getId() === 0 && $this->interruptive) {
            return false;
        }
        if (!$this->isVisible()) {
            return false;
        }
        if ($this->hasUserDismissed($ilObjUser)) {
            return false;
        }
        return ($this->isVisibleToUserBasedOnLanguage($ilObjUser) && $this->isVisibleRoleUserRoles($ilObjUser));
    }

References ilObject\getId(), hasUserDismissed(), isVisible(), isVisibleRoleUserRoles(), and isVisibleToUserBasedOnLanguage().

Here is the call graph for this function:

isVisibleRoleUserRoles()

ilADNNotification::isVisibleRoleUserRoles ( ilObjUser  $ilObjUser )

protected

Definition at line 165 of file class.ilADNNotification.php.

                                                                   : bool
    {
        if (!$this->isLimitToRoles()) {
            return true;
        }
        global $DIC;
 
        if ($ilObjUser->getId() === 0 && in_array(0, $this->getLimitedToRoleIds())) {
            return true;
        }
 
        return $DIC->rbac()->review()->isAssignedToAtLeastOneGivenRole(
            $ilObjUser->getId(),
            $this->getLimitedToRoleIds()
        );
    }

References $DIC, ilObject\getId(), getLimitedToRoleIds(), and isLimitToRoles().

Referenced by isVisibleForUser().

Here is the call graph for this function:

Here is the caller graph for this function:

isVisibleToUserBasedOnLanguage()

ilADNNotification::isVisibleToUserBasedOnLanguage ( ilObjUser  $user )

protected

Definition at line 145 of file class.ilADNNotification.php.

                                                                      : bool
    {
        if (!$this->hasLanguageLimitation()) {
            return true;
        }
 
        // Special case for anonymous user
        if ($user->isAnonymous()) {
            // current language
            global $DIC;
            $current_language = $DIC->http()->request()->getQueryParams()['lang']
                ?? $DIC->language()->getDefaultLanguage();
        } else {
            $current_language = $user->getLanguage();
        }
 
        return in_array($current_language, $this->getLimitedToLanguages(), true);
    }

References $DIC, ilObjUser\getLanguage(), getLimitedToLanguages(), hasLanguageLimitation(), and ilObjUser\isAnonymous().

Referenced by isVisibleForUser().

Here is the call graph for this function:

Here is the caller graph for this function:

resetForAllUsers()

ilADNNotification::resetForAllUsers

(

)

Definition at line 72 of file class.ilADNNotification.php.

                                      : void
    {
        foreach (ilADNDismiss::where(['notification_id' => $this->getId()])->get() as $not) {
            $not->delete();
        }
    }

References getId(), and ActiveRecord\where().

Here is the call graph for this function:

returnDbTableName()

static ilADNNotification::returnDbTableName ( )

static

Deprecated:

Reimplemented from ActiveRecord.

Definition at line 51 of file class.ilADNNotification.php.

                                              : string
    {
        return self::TABLE_NAME;
    }

References TABLE_NAME.

setActive()

ilADNNotification::setActive

(

bool

$active

)

Definition at line 587 of file class.ilADNNotification.php.

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

References $active.

setBody()

ilADNNotification::setBody

(

string

$body

)

Definition at line 419 of file class.ilADNNotification.php.

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

References $body.

setCreateDate()

ilADNNotification::setCreateDate

(

DateTimeImmutable

$create_date

)

Definition at line 557 of file class.ilADNNotification.php.

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

References $create_date.

Referenced by create().

Here is the caller graph for this function:

setCreatedBy()

ilADNNotification::setCreatedBy

(

int

$created_by

)

Definition at line 567 of file class.ilADNNotification.php.

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

References $created_by.

Referenced by create().

Here is the caller graph for this function:

setDismissable()

ilADNNotification::setDismissable

(

bool

$dismissable

)

Definition at line 512 of file class.ilADNNotification.php.

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

References $dismissable.

setDisplayEnd()

ilADNNotification::setDisplayEnd

(

DateTimeImmutable

$display_end

)

Definition at line 429 of file class.ilADNNotification.php.

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

References $display_end.

setDisplayStart()

ilADNNotification::setDisplayStart

(

DateTimeImmutable

$display_start

)

Definition at line 439 of file class.ilADNNotification.php.

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

References $display_start.

setEventEnd()

ilADNNotification::setEventEnd

(

DateTimeImmutable

$event_end

)

Definition at line 449 of file class.ilADNNotification.php.

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

References $event_end.

setEventStart()

ilADNNotification::setEventStart

(

DateTimeImmutable

$event_start

)

Definition at line 459 of file class.ilADNNotification.php.

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

References $event_start.

setHasLanguageLimitation()

ilADNNotification::setHasLanguageLimitation

(

bool

$has_language_limitation

)

Definition at line 607 of file class.ilADNNotification.php.

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

References $has_language_limitation.

setId()

ilADNNotification::setId

(

int

$id

)

Definition at line 469 of file class.ilADNNotification.php.

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

References $id.

setLimitedToLanguages()

ilADNNotification::setLimitedToLanguages

(

array

$limited_to_languages

)

Definition at line 597 of file class.ilADNNotification.php.

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

References $limited_to_languages.

setLimitedToRoleIds()

ilADNNotification::setLimitedToRoleIds

(

array

$limited_to_role_ids

)

Definition at line 617 of file class.ilADNNotification.php.

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

References $limited_to_role_ids.

setLimitToRoles()

ilADNNotification::setLimitToRoles

(

bool

$limit_to_roles

)

Definition at line 627 of file class.ilADNNotification.php.

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

References $limit_to_roles.

setPermanent()

ilADNNotification::setPermanent

(

bool

$permanent

)

Definition at line 542 of file class.ilADNNotification.php.

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

References $permanent.

setTitle()

ilADNNotification::setTitle

(

string

$title

)

Definition at line 479 of file class.ilADNNotification.php.

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

References $title.

setType()

ilADNNotification::setType

(

int

$type

)

Definition at line 489 of file class.ilADNNotification.php.

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

References $type.

setTypeDuringEvent()

ilADNNotification::setTypeDuringEvent

(

int

$type_during_event

)

Definition at line 499 of file class.ilADNNotification.php.

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

References $type_during_event.

wakeUp()

ilADNNotification::wakeUp	(		$field_name,
			$field_value
	)

Parameters

string	$field_name
mixed	$field_value

Returns

int|mixed

Reimplemented from ActiveRecord.

Definition at line 346 of file class.ilADNNotification.php.

    {
        switch ($field_name) {
            case 'event_start':
            case 'event_end':
            case 'display_end':
            case 'display_start':
            case 'create_date':
            case 'last_update':
                return (new DateTimeImmutable())->setTimestamp((int) $field_value);
 
            case 'allowed_users':
                if ($field_value === null) {
                    $array_unique = self::$allowed_user_ids;
                } else {
                    $json_decode = json_decode((string) $field_value, true);
                    if (!is_array($json_decode)) {
                        $json_decode = self::$allowed_user_ids;
                    }
                    $array_unique = array_unique($json_decode);
                }
 
                sort($array_unique);
 
                return $array_unique;
            case 'limited_to_languages':
            case 'limited_to_role_ids':
                return json_decode((string) $field_value, true);
        }
        return null;
    }

References $allowed_user_ids, and ILIAS\UI\examples\Symbol\Glyph\Sort\sort().

Here is the call graph for this function:

Field Documentation

$active

bool ilADNNotification::$active = true

protected

@con_has_field true @con_fieldtype integer @con_length 1

Definition at line 291 of file class.ilADNNotification.php.

Referenced by isActive(), and setActive().

$allowed_user_ids

array ilADNNotification::$allowed_user_ids = [0, 13, 6]

staticprotected

Definition at line 40 of file class.ilADNNotification.php.

Referenced by wakeUp().

$allowed_users

array ilADNNotification::$allowed_users = [0, 6, 13]

protected

@con_has_field true @con_fieldtype text @con_length 256

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

$body

string ilADNNotification::$body = ''

protected

@con_has_field true @con_fieldtype clob

Definition at line 201 of file class.ilADNNotification.php.

Referenced by getBody(), and setBody().

$create_date

DateTimeImmutable ilADNNotification::$create_date = null

protected

@con_has_field true @con_fieldtype integer @con_length 8

Definition at line 267 of file class.ilADNNotification.php.

Referenced by setCreateDate().

$created_by

int ilADNNotification::$created_by = null

protected

@con_has_field true @con_fieldtype integer @con_length 8

Definition at line 279 of file class.ilADNNotification.php.

Referenced by getCreatedBy(), and setCreatedBy().

$dismissable

bool ilADNNotification::$dismissable = true

protected

@con_has_field true @con_fieldtype integer @con_length 1

Definition at line 243 of file class.ilADNNotification.php.

Referenced by getDismissable(), and setDismissable().

$display_end

DateTimeImmutable ilADNNotification::$display_end = null

protected

@con_has_field true @con_fieldtype integer @con_length 8

Definition at line 225 of file class.ilADNNotification.php.

Referenced by setDisplayEnd().

$display_start

DateTimeImmutable ilADNNotification::$display_start = null

protected

@con_has_field true @con_fieldtype integer @con_length 8

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

Referenced by setDisplayStart().

$event_end

DateTimeImmutable ilADNNotification::$event_end = null

protected

@con_has_field true @con_fieldtype integer @con_length 8

Definition at line 213 of file class.ilADNNotification.php.

Referenced by setEventEnd().

$event_start

DateTimeImmutable ilADNNotification::$event_start = null

protected

@con_has_field true @con_fieldtype integer @con_length 8

Definition at line 207 of file class.ilADNNotification.php.

Referenced by setEventStart().

$has_language_limitation

bool ilADNNotification::$has_language_limitation = false

protected

@con_has_field true @con_fieldtype integer @con_length 1

Definition at line 303 of file class.ilADNNotification.php.

Referenced by hasLanguageLimitation(), and setHasLanguageLimitation().

$id

int ilADNNotification::$id = null

protected

@con_is_primary true @con_sequence true @con_is_unique true @con_has_field true @con_fieldtype integer @con_length 8

Definition at line 190 of file class.ilADNNotification.php.

Referenced by getId(), and setId().

$interruptive

bool ilADNNotification::$interruptive = false

protected

@con_has_field true @con_fieldtype integer @con_length 1

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

$last_update

DateTimeImmutable ilADNNotification::$last_update

protected

@con_has_field true @con_fieldtype integer @con_length 8

Definition at line 273 of file class.ilADNNotification.php.

$last_update_by

int ilADNNotification::$last_update_by = null

protected

@con_has_field true @con_fieldtype integer @con_length 8

Definition at line 285 of file class.ilADNNotification.php.

$limit_to_roles

bool ilADNNotification::$limit_to_roles = false

protected

@con_has_field true @con_fieldtype integer @con_length 1

Definition at line 315 of file class.ilADNNotification.php.

Referenced by isLimitToRoles(), and setLimitToRoles().

$limited_to_languages

array ilADNNotification::$limited_to_languages = []

protected

@con_has_field true @con_fieldtype text @con_length 256

Definition at line 297 of file class.ilADNNotification.php.

Referenced by getLimitedToLanguages(), and setLimitedToLanguages().

$limited_to_role_ids

array ilADNNotification::$limited_to_role_ids = []

protected

@con_has_field true @con_fieldtype text @con_length 256

Definition at line 309 of file class.ilADNNotification.php.

Referenced by getLimitedToRoleIds(), and setLimitedToRoleIds().

$link

string ilADNNotification::$link = ''

protected

@con_has_field true @con_fieldtype text @con_length 256

Definition at line 327 of file class.ilADNNotification.php.

$link_target

string ilADNNotification::$link_target = '_top'

protected

@con_has_field true @con_fieldtype text @con_length 256

Definition at line 339 of file class.ilADNNotification.php.

$link_type

int ilADNNotification::$link_type = self::LINK_TYPE_NONE

protected

@con_has_field true @con_fieldtype integer @con_length 1

Definition at line 333 of file class.ilADNNotification.php.

$parent_id

int ilADNNotification::$parent_id = null

protected

@con_has_field true @con_fieldtype integer @con_length 8

Definition at line 261 of file class.ilADNNotification.php.

$permanent

bool ilADNNotification::$permanent = true

protected

@con_has_field true @con_fieldtype integer @con_length 1

Definition at line 249 of file class.ilADNNotification.php.

Referenced by isPermanent(), and setPermanent().

$title

string ilADNNotification::$title = ''

protected

@con_has_field true @con_fieldtype text @con_length 256

Definition at line 196 of file class.ilADNNotification.php.

Referenced by getTitle(), and setTitle().

$type

int ilADNNotification::$type = self::TYPE_INFO

protected

@con_has_field true @con_fieldtype integer @con_length 1

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

Referenced by getType(), and setType().

$type_during_event

int ilADNNotification::$type_during_event = self::TYPE_ERROR

protected

@con_has_field true @con_fieldtype integer @con_length 1

Definition at line 237 of file class.ilADNNotification.php.

Referenced by setTypeDuringEvent().

DATE_FORMAT

const ilADNNotification::DATE_FORMAT = 'd.m.Y'

Definition at line 30 of file class.ilADNNotification.php.

DATE_TIME_FORMAT

const ilADNNotification::DATE_TIME_FORMAT = 'd.m.Y H:i'

Definition at line 32 of file class.ilADNNotification.php.

LINK_TYPE_NONE

const ilADNNotification::LINK_TYPE_NONE = 0

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

LINK_TYPE_REF_ID

const ilADNNotification::LINK_TYPE_REF_ID = 1

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

LINK_TYPE_URL

const ilADNNotification::LINK_TYPE_URL = 2

Definition at line 39 of file class.ilADNNotification.php.

POS_BOTTOM

const ilADNNotification::POS_BOTTOM = 4

Definition at line 29 of file class.ilADNNotification.php.

POS_RIGHT

const ilADNNotification::POS_RIGHT = 2

Definition at line 27 of file class.ilADNNotification.php.

POS_TOP

const ilADNNotification::POS_TOP = 1

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

POST_LEFT

const ilADNNotification::POST_LEFT = 3

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

TABLE_NAME

const ilADNNotification::TABLE_NAME = 'il_adn_notifications'

Definition at line 36 of file class.ilADNNotification.php.

Referenced by getConnectorContainerName(), and returnDbTableName().

TIME_FORMAT

const ilADNNotification::TIME_FORMAT = 'H:i'

Definition at line 31 of file class.ilADNNotification.php.

TYPE_ERROR

const ilADNNotification::TYPE_ERROR = 3

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

Referenced by ilADNNotificationUIFormGUI\getDenotations(), ILIAS\AdministrativeNotification\GlobalScreen\ADNProvider\handleDenotation(), and ilServicesAdministrativeNotificationTest\testBasisc().

TYPE_INFO

const ilADNNotification::TYPE_INFO = 1

Definition at line 33 of file class.ilADNNotification.php.

Referenced by getActiveType(), ilADNNotificationUIFormGUI\getDenotations(), and getTypeDuringEvent().

TYPE_WARNING

const ilADNNotification::TYPE_WARNING = 2

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

Referenced by ilADNNotificationUIFormGUI\getDenotations(), ILIAS\AdministrativeNotification\GlobalScreen\ADNProvider\handleDenotation(), and ilServicesAdministrativeNotificationTest\testBasisc().

---

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

• components/ILIAS/AdministrativeNotification/classes/class.ilADNNotification.php