@noinspection ALL More...

Inheritance diagram for ilADNNotification:

Collaboration diagram for ilADNNotification:

Public Member Functions
	getConnectorContainerName ()

	dismiss (ilObjUser $ilObjUser)

	resetForAllUsers ()

	getFullTimeFormated ()

	isUserAllowedToDismiss (ilObjUser $ilUser)

	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)

	getLimitedToRoleIds ()

	setLimitedToRoleIds (array $limited_to_role_ids)

	isLimitToRoles ()

	setLimitToRoles (bool $limit_to_roles)

Public Member Functions inherited from ActiveRecord
	getArConnector ()

	getArFieldList ()

	getConnectorContainerName ()

	setConnectorContainerName ($connector_container_name)

	getPrimaryFieldValue ()

	setPrimaryFieldValue ($value)

	__construct ($primary_key=0, arConnector $connector=null)

	storeObjectToCache ()

	__getConvertedDateFieldsAsArray ($format=null)

	__asCsv ($separator=';', $header=false)

	__asArray ()

	__asStdClass ()

	__asSerializedObject ()

	buildFromArray (array $array)

	fixDateField ($field_name, $value)

	sleep ($field_name)

	wakeUp ($field_name, $field_value)

	getArrayForDb ()

	getArrayForConnector ()

	installConnector ()

	store ()

	save ()

	create ()

	copy ($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 ($old_name, $new_name)

static	tableExists ()

static	fieldExists ($field_name)

static	removeDBField ($field_name)

static	updateDB ()

static	resetDB ()

static	truncateDB ()

static	flushDB ()

static	preloadObjects ()

static	additionalParams (array $additional_params)

static	findOrFail ($primary_key, array $add_constructor_args=array())
	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=array())

static	where ($where, $operator=null)

static	innerjoinAR (ActiveRecord $ar, $on_this, $on_external, $fields=array(' *'), $operator='=', $both_external=false)

static	innerjoin ($tablename, $on_this, $on_external, $fields=array(' *'), $operator='=', $both_external=false)

static	leftjoin ($tablename, $on_this, $on_external, $fields=array(' *'), $operator='=', $both_external=false)

static	orderBy ($orderBy, $orderDirection='ASC')

static	dateFormat ($date_format='d.m.Y - H:i:s')

static	limit ($start, $end)

static	affectedRows ()

static	count ()

static	get ()

static	debug ()

static	first ()

static	getCollection ()

static	last ()

static	getFirstFromLastQuery ()

static	connector (arConnector $connector)

static	raw ($set_raw=true)

static	getArray ($key=null, $values=null)

static	_toCamelCase ($str, $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

Data Fields inherited from ActiveRecord
const	ACTIVE_RECORD_VERSION = '2.0.7'

Protected Member Functions
	hasUserDismissed (ilObjUser $ilObjUser)

	isVisible ()

	isVisibleRoleUserRoles (ilObjUser $ilObjUser)

	hasEventStarted ()

	hasDisplayStarted ()

	hasEventEnded ()

	hasDisplayEnded ()

	getTime ()

Protected Member Functions inherited from ActiveRecord
	serializeToCSV ($field)
	This method is called for every field of your instance if you use __asCsv. More...

	installDatabase ()

Protected Attributes
	$id

	$title = ''

	$body = ''

	$event_start

	$event_end

	$display_start

	$display_end

	$type = self::TYPE_INFO

	$type_during_event = self::TYPE_ERROR

	$dismissable = true

	$permanent = true

	$allowed_users = array(0, 6, 13)

	$parent_id = null

	$create_date

	$last_update

	$created_by = null

	$last_update_by = null

	$active = true

	$limited_to_role_ids = []

	$limit_to_roles = false

	$interruptive = false

	$link = ''

	$link_type = self::LINK_TYPE_NONE

	$link_target = '_top'

Protected Attributes inherited from ActiveRecord
	$ar_safe_read = true

	$connector_container_name = ''

Static Protected Attributes
static	$allowed_user_ids = array(0, 13, 6)

Additional Inherited Members
Static Protected Member Functions inherited from ActiveRecord
static	getCalledClass ()

static	fromCamelCase ($str)

Detailed Description

@noinspection ALL

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 8 of file class.ilADNNotification.php.

Member Function Documentation

◆ create()

ilADNNotification::create ( )

Reimplemented from ActiveRecord.

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

    {
        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 )

Parameters

ilObjUser $ilObjUser

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

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

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

Here is the call graph for this function:

◆ getActiveType()

ilADNNotification::getActiveType ( )

Returns: int

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

    {
        if ($this->isPermanent()) {
            return $this->getType();
        }
        if ($this->hasEventStarted() and !$this->hasEventEnded()) {
            return $this->getTypeDuringEvent();
        }
        if ($this->hasDisplayStarted() and !$this->hasDisplayEnded()) {
            return $this->getType();
        }
    }

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

Here is the call graph for this function:

◆ getBody()

ilADNNotification::getBody ( )

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

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

References $body.

◆ getConnectorContainerName()

ilADNNotification::getConnectorContainerName ( )

Returns: string

Reimplemented from ActiveRecord.

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

    {
        return self::TABLE_NAME;
    }

References TABLE_NAME.

◆ getCreateDate()

ilADNNotification::getCreateDate ( )

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

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

◆ getCreatedBy()

ilADNNotification::getCreatedBy ( )

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

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

References $created_by.

◆ getDismissable()

ilADNNotification::getDismissable ( )

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

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

References $dismissable.

Referenced by hasUserDismissed(), and isUserAllowedToDismiss().

Here is the caller graph for this function:

◆ getDisplayEnd()

ilADNNotification::getDisplayEnd ( )

Definition at line 442 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 452 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 462 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 472 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 ( )

Returns: string

Definition at line 80 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());
        } else {
            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 482 of file class.ilADNNotification.php.

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

References $id.

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

Here is the caller graph for this function:

◆ getLimitedToRoleIds()

ilADNNotification::getLimitedToRoleIds ( )

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

                                          : array
    {
        return (array) $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 582 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 492 of file class.ilADNNotification.php.

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

References $title.

◆ getType()

ilADNNotification::getType ( )

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

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

References $type.

Referenced by getActiveType().

Here is the caller graph for this function:

◆ getTypeDuringEvent()

ilADNNotification::getTypeDuringEvent ( )

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

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

References $type_during_event.

Referenced by getActiveType().

Here is the caller graph for this function:

◆ hasDisplayEnded()

ilADNNotification::hasDisplayEnded ( )

protected

Definition at line 542 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 532 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 537 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 527 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:

◆ hasUserDismissed()

ilADNNotification::hasUserDismissed ( ilObjUser $ilObjUser )

protected

Parameters

ilObjUser $ilObjUser

Returns: bool

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

    {
        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 587 of file class.ilADNNotification.php.

                               : bool
    {
        return $this->active;
    }

References $active.

◆ isDuringEvent()

ilADNNotification::isDuringEvent ( )

Definition at line 557 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 607 of file class.ilADNNotification.php.

                                     : bool
    {
        return (bool) $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 552 of file class.ilADNNotification.php.

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

References $permanent.

Referenced by getActiveType(), and isVisible().

Here is the caller graph for this function:

◆ isUserAllowedToDismiss()

ilADNNotification::isUserAllowedToDismiss ( ilObjUser $ilUser )

Parameters

ilObjUser $ilUser

Returns: bool

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

    {
        return ($this->getDismissable() and $ilUser->getId() != 0 and $ilUser->getId() != ANONYMOUS_USER_ID);
    }

References $ilUser, ANONYMOUS_USER_ID, and getDismissable().

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

Returns: bool

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

    {
        if ($this->isPermanent()) {
            return true;
        }
        $hasEventStarted = $this->hasEventStarted();
        $hasDisplayStarted = $this->hasDisplayStarted();
        $hasEventEnded = !$this->hasEventEnded();
        $hasDisplayEnded = !$this->hasDisplayEnded();
 
        return ($hasEventStarted or $hasDisplayStarted) and ($hasEventEnded or $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 )

Parameters

ilObjUser $ilObjUser

Returns: bool

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

    {
        if ($ilObjUser->getId() == 0 && $this->isInterruptive()) {
            return false;
        }
        if (!$this->isVisible()) {
 
            return false;
        }
        if ($this->hasUserDismissed($ilObjUser)) {
            return false;
        }
        if (!$this->isVisibleRoleUserRoles($ilObjUser)) {
            return false;
        }
 
        return true;
    }

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

Here is the call graph for this function:

◆ isVisibleRoleUserRoles()

ilADNNotification::isVisibleRoleUserRoles ( ilObjUser $ilObjUser )

protected

Parameters

ilObjUser $ilObjUser

Returns: bool

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

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

◆ resetForAllUsers()

ilADNNotification::resetForAllUsers ( )

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

    {
        foreach (ilADNDismiss::where(array('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

Returns: string

Deprecated:

Reimplemented from ActiveRecord.

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

    {
        return self::TABLE_NAME;
    }

References TABLE_NAME.

◆ setActive()

ilADNNotification::setActive ( bool $active )

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

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

References $active.

◆ setBody()

ilADNNotification::setBody ( string $body )

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

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

References $body.

◆ setCreateDate()

ilADNNotification::setCreateDate ( DateTimeImmutable $create_date )

Definition at line 562 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 572 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 517 of file class.ilADNNotification.php.

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

References $dismissable.

◆ setDisplayEnd()

ilADNNotification::setDisplayEnd ( DateTimeImmutable $display_end )

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

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

References $display_end.

◆ setDisplayStart()

ilADNNotification::setDisplayStart ( DateTimeImmutable $display_start )

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

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

References $display_start.

◆ setEventEnd()

ilADNNotification::setEventEnd ( DateTimeImmutable $event_end )

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

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

References $event_end.

◆ setEventStart()

ilADNNotification::setEventStart ( DateTimeImmutable $event_start )

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

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

References $event_start.

◆ setId()

ilADNNotification::setId ( int $id )

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

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

References $id.

◆ setLimitedToRoleIds()

ilADNNotification::setLimitedToRoleIds ( array $limited_to_role_ids )

Definition at line 602 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 612 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 547 of file class.ilADNNotification.php.

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

References $permanent.

◆ setTitle()

ilADNNotification::setTitle ( string $title )

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

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

References $title.

◆ setType()

ilADNNotification::setType ( int $type )

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

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

References $type.

◆ setTypeDuringEvent()

ilADNNotification::setTypeDuringEvent ( int $type_during_event )

Definition at line 507 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
string	$field_value

Returns: int|mixed

Reimplemented from ActiveRecord.

Definition at line 354 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($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;
                break;
            case 'limited_to_role_ids':
                return json_decode($field_value, true);
                break;
        }
    }