Collaboration diagram for ilCalendarUserNotification:

Public Member Functions
	__construct (int $a_cal_id=0)

	setEntryId (int $a_id)

	getEntryId ()

	getRecipients ()

	validate ()

	save ()

	addRecipient (int $a_type, int $a_usr_id=0, string $a_email='')

	setRecipients (array $a_rcps)

	deleteRecipients ()

Static Public Member Functions
static	deleteUser (int $a_usr_id)

static	deleteCalendarEntry (int $a_cal_id)

static	createTable ()

Data Fields
const	TYPE_USER = 1

const	TYPE_EMAIL = 2

Protected Member Functions
	read ()

Protected Attributes
ilLanguage	$lng

ilDBInterface	$db

ilErrorHandling	$error

Private Attributes
int	$cal_id = 0

array	$rcps = array()

Detailed Description

Author: Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

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

Constructor & Destructor Documentation

◆ __construct()

ilCalendarUserNotification::__construct ( int $a_cal_id = 0 )

Definition at line 21 of file class.ilCalendarUserNotification.php.

    {
        global $DIC;
 
        $this->lng = $DIC->language();
        $this->db = $DIC->database();
        $this->error = $DIC['ilErr'];
 
        $this->cal_id = $a_cal_id;
        $this->read();
    }

References $DIC, error(), ILIAS\Repository\lng(), and read().

Here is the call graph for this function:

Member Function Documentation

◆ addRecipient()

ilCalendarUserNotification::addRecipient	(	int	$a_type,
		int	$a_usr_id = `0`,
		string	$a_email = `''`
	)

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

                                                                                      : void
    {
        $this->rcps[] = array(
            'type' => $a_type,
            'usr_id' => $a_usr_id,
            'email' => $a_email
        );
    }

Referenced by read().

Here is the caller graph for this function:

◆ createTable()

static ilCalendarUserNotification::createTable ( )

static

Definition at line 143 of file class.ilCalendarUserNotification.php.

                                        : void
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        if ($ilDB->tableExists('cal_notification')) {
            return;
        }
 
        // Create notification table
        $ilDB->createTable(
            'cal_notification',
            array(
                'notification_id' => array('type' => 'integer', 'length' => 4, 'notnull' => true),
                'cal_id' => array('type' => 'integer', 'length' => 4, 'notnull' => true, 'default' => 0),
                'user_type' => array('type' => 'integer', 'length' => 1, 'notnull' => true, 'default' => 0),
                'user_id' => array('type' => 'integer', 'length' => 4, 'notnull' => true, 'default' => 0),
                'email' => array('type' => 'text', 'length' => 64, 'notnull' => false)
            )
        );
        $ilDB->addPrimaryKey(
            'cal_notification',
            array(
                'notification_id'
            )
        );
        $ilDB->createSequence('cal_notification');
        $ilDB->addIndex('cal_notification', array('cal_id'), 'i1');
    }

References $DIC, and $ilDB.

◆ deleteCalendarEntry()

static ilCalendarUserNotification::deleteCalendarEntry ( int $a_cal_id )

static

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

                                                             : void
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        $query = 'DELETE FROM cal_notification ' .
            'WHERE cal_id = ' . $ilDB->quote($a_cal_id, 'integer');
        $res = $ilDB->manipulate($query);
    }

References $DIC, $ilDB, $query, and $res.

Referenced by ilCalendarAppointmentGUI\delete().

Here is the caller graph for this function:

◆ deleteRecipients()

ilCalendarUserNotification::deleteRecipients ( )

Definition at line 116 of file class.ilCalendarUserNotification.php.

                                      : void
    {
        $query = 'DELETE FROM cal_notification ' .
            'WHERE cal_id = ' . $this->db->quote($this->getEntryId(), 'integer');
        $res = $this->db->manipulate($query);
    }

References $query, $res, and getEntryId().

Referenced by save().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteUser()

static ilCalendarUserNotification::deleteUser ( int $a_usr_id )

static

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

                                                    : void
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        $query = 'DELETE FROM cal_notification ' .
            'WHERE user_id = ' . $ilDB->quote($a_usr_id, 'integer');
        $res = $ilDB->manipulate($query);
    }

References $DIC, $ilDB, $query, and $res.

◆ getEntryId()

ilCalendarUserNotification::getEntryId ( )

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

                                : int
    {
        return $this->cal_id;
    }

References $cal_id.

Referenced by deleteRecipients(), read(), and save().

Here is the caller graph for this function:

◆ getRecipients()

ilCalendarUserNotification::getRecipients ( )

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

                                   : array
    {
        return $this->rcps;
    }

References $rcps.

Referenced by save(), and validate().

Here is the caller graph for this function:

◆ read()

ilCalendarUserNotification::read ( )

protected

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

                             : void
    {
        if (!$this->getEntryId()) {
            return;
        }
 
        $query = 'SELECT * FROM cal_notification ' .
            'WHERE cal_id = ' . $this->db->quote($this->getEntryId(), 'integer');
        $res = $this->db->query($query);
 
        $this->rcps = array();
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->addRecipient(
                (int) $row->user_type,
                (int) $row->user_id,
                $row->email
            );
        }
    }

References $query, $res, addRecipient(), ilDBConstants\FETCHMODE_OBJECT, and getEntryId().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ save()

ilCalendarUserNotification::save ( )

Definition at line 84 of file class.ilCalendarUserNotification.php.

                          : bool
    {
        $this->deleteRecipients();
        foreach ($this->getRecipients() as $rcp) {
            $query = 'INSERT INTO cal_notification ' .
                '(notification_id,cal_id, user_type, user_id, email) ' .
                'VALUES ( ' .
                $this->db->quote($this->db->nextId('cal_notification'), 'integer') . ', ' .
                $this->db->quote($this->getEntryId(), 'integer') . ', ' .
                $this->db->quote((int) $rcp['type'], 'integer') . ', ' .
                $this->db->quote((int) $rcp['usr_id'], 'integer') . ', ' .
                $this->db->quote($rcp['email'], 'text') .
                ')';
            $this->db->manipulate($query);
        }
        return true;
    }

References $query, deleteRecipients(), getEntryId(), and getRecipients().

Here is the call graph for this function:

◆ setEntryId()

ilCalendarUserNotification::setEntryId ( int $a_id )

Definition at line 53 of file class.ilCalendarUserNotification.php.

                                         : void
    {
        $this->cal_id = $a_id;
    }

◆ setRecipients()

ilCalendarUserNotification::setRecipients ( array $a_rcps )

Definition at line 111 of file class.ilCalendarUserNotification.php.

                                                : void
    {
        $this->rcps = array();
    }

Referenced by ilCalendarAppointmentGUI\distributeUserNotifications().

Here is the caller graph for this function:

◆ validate()

ilCalendarUserNotification::validate ( )

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

                              : bool
    {
        if (!count($this->getRecipients())) {
            return true;
        }
        foreach ($this->getRecipients() as $rcp_data) {
            if ($rcp_data['type'] == self::TYPE_USER) {
                continue;
            } elseif (!ilUtil::is_email($rcp_data['email'])) {
                $this->error->appendMessage($this->lng->txt('cal_err_invalid_notification_rcps'));
                return false;
            }
        }
        return true;
    }