ilADNDismiss Class Reference

Class ilADNDismiss. More...

Inheritance diagram for ilADNDismiss:

Collaboration diagram for ilADNDismiss:

Public Member Functions
	getConnectorContainerName ()
	getId ()
	setId ($id)
	getUsrId ()
	setUsrId ($usr_id)
	getNotificationId ()
	setNotificationId ($notification_id)
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	hasDimissed (ilObjUser $ilObjUser, ilADNNotification $ilADNNotification)
static	dismiss (ilObjUser $ilObjUser, ilADNNotification $ilADNNotification)
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	TABLE_NAME = 'il_adn_dismiss'
Data Fields inherited from ActiveRecord
const	ACTIVE_RECORD_VERSION = '2.0.7'

Protected Attributes
	$id = 0
	$usr_id = 0
	$notification_id = 0
Protected Attributes inherited from ActiveRecord
	$ar_safe_read = true
	$connector_container_name = ''

Static Protected Attributes
static	$request_cache = array()

Additional Inherited Members
Protected Member Functions inherited from ActiveRecord
	serializeToCSV ($field)
	This method is called for every field of your instance if you use __asCsv. More...
	installDatabase ()
Static Protected Member Functions inherited from ActiveRecord
static	getCalledClass ()
static	fromCamelCase ($str)

Detailed Description

Class ilADNDismiss.

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.ilADNDismiss.php.

Member Function Documentation

dismiss()

static ilADNDismiss::dismiss ( ilObjUser  $ilObjUser, ilADNNotification  $ilADNNotification  )

static

Parameters

ilObjUser	$ilObjUser
ilADNNotification	$ilADNNotification

Definition at line 58 of file class.ilADNDismiss.php.

References ilObject\getId(), ilADNNotification\getId(), and ilADNNotification\isUserAllowedToDismiss().

Referenced by ilADNNotification\dismiss().

                                                                                               : void
    {
        if (!self::hasDimissed($ilObjUser, $ilADNNotification) and $ilADNNotification->isUserAllowedToDismiss($ilObjUser)) {
            $obj = new self();
            $obj->setNotificationId($ilADNNotification->getId());
            $obj->setUsrId($ilObjUser->getId());
            $obj->create();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getConnectorContainerName()

ilADNDismiss::getConnectorContainerName

(

)

Returns

string

Definition at line 16 of file class.ilADNDismiss.php.

    {
        return self::TABLE_NAME;
    }

getId()

ilADNDismiss::getId

(

)

Returns

int

Definition at line 109 of file class.ilADNDismiss.php.

References $id.

    {
        return $this->id;
    }

getNotificationId()

ilADNDismiss::getNotificationId

(

)

Returns

int

Definition at line 141 of file class.ilADNDismiss.php.

References $notification_id.

    {
        return $this->notification_id;
    }

getUsrId()

ilADNDismiss::getUsrId

(

)

Returns

int

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

References $usr_id.

    {
        return $this->usr_id;
    }

hasDimissed()

static ilADNDismiss::hasDimissed ( ilObjUser  $ilObjUser, ilADNNotification  $ilADNNotification  )

static

Parameters

ilObjUser	$ilObjUser
ilADNNotification	$ilADNNotification

Returns

bool

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

References $usr_id, ilObject\getId(), and ilADNNotification\getId().

Referenced by ILIAS\AdministrativeNotification\GlobalScreen\ADNProvider\getNotifications(), and ilADNNotification\hasUserDismissed().

                                                                                                   : bool
    {
        $not_id = $ilADNNotification->getId();
        $usr_id = $ilObjUser->getId();
        if (!isset(self::$request_cache[$usr_id][$not_id])) {
            self::$request_cache[$usr_id][$not_id] = self::where(array(
                'usr_id'          => $usr_id,
                'notification_id' => $not_id,
            ))->hasSets();
        }

        return (bool) self::$request_cache[$usr_id][$not_id];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

returnDbTableName()

static ilADNDismiss::returnDbTableName ( )

static

Returns

string

Deprecated:

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

    {
        return self::TABLE_NAME;
    }

setId()

ilADNDismiss::setId

(

$id

)

Parameters

int

$id

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

References $id.

    {
        $this->id = $id;
    }

setNotificationId()

ilADNDismiss::setNotificationId

(

$notification_id

)

Parameters

int

$notification_id

Definition at line 149 of file class.ilADNDismiss.php.

References $notification_id.

    {
        $this->notification_id = $notification_id;
    }

setUsrId()

ilADNDismiss::setUsrId

(

$usr_id

)

Parameters

int

$usr_id

Definition at line 133 of file class.ilADNDismiss.php.

References $usr_id.

    {
        $this->usr_id = $usr_id;
    }

Field Documentation

$id

ilADNDismiss::$id = 0

protected

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

Referenced by getId(), and setId().

$notification_id

ilADNDismiss::$notification_id = 0

protected

Definition at line 104 of file class.ilADNDismiss.php.

Referenced by getNotificationId(), and setNotificationId().

$request_cache

ilADNDismiss::$request_cache = array()

staticprotected

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

$usr_id

ilADNDismiss::$usr_id = 0

protected

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

Referenced by getUsrId(), hasDimissed(), and setUsrId().

TABLE_NAME

const ilADNDismiss::TABLE_NAME = 'il_adn_dismiss'

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

---

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

• Services/AdministrativeNotification/classes/class.ilADNDismiss.php