ilCalendarRegistration Class Reference

registration for calendar appointments More...

Collaboration diagram for ilCalendarRegistration:

Public Member Functions
	__construct (int $a_appointment_id)
	getAppointmentId ()
	getRegisteredUsers (\ilDateTime $start, \ilDateTime $end)
	isRegistered ($a_usr_id, ilDateTime $start, ilDateTime $end)
	register (int $a_usr_id, ilDateTime $start, ilDateTime $end)
	unregister (int $a_usr_id, ilDateTime $start, ilDateTime $end)
	unregister one user More...

Static Public Member Functions
static	deleteByUser (int $a_usr_id)
static	deleteByAppointment (int $a_cal_id)

Protected Member Functions
	read ()
	Read registration. More...

Protected Attributes
ilDBInterface	$db

Private Attributes
int	$appointment_id = 0
array	$registered = array()

Detailed Description

registration for calendar appointments

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

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

Constructor & Destructor Documentation

__construct()

ilCalendarRegistration::__construct

(

int

$a_appointment_id

)

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

References $DIC, and read().

    {
        global $DIC;

        $this->appointment_id = $a_appointment_id;

        $this->db = $DIC->database();
        $this->read();
    }

Here is the call graph for this function:

Member Function Documentation

deleteByAppointment()

static ilCalendarRegistration::deleteByAppointment ( int  $a_cal_id )

static

Definition at line 52 of file class.ilCalendarRegistration.php.

References $DIC, and $ilDB.

                                                             : void
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        $query = "DELETE FROM cal_registrations " .
            "WHERE cal_id = " . $ilDB->quote($a_cal_id, 'integer');
        $ilDB->manipulate($query);
    }

deleteByUser()

static ilCalendarRegistration::deleteByUser ( int  $a_usr_id )

static

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

References $DIC, and $ilDB.

                                                      : void
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        $query = "DELETE FROM cal_registrations " .
            "WHERE usr_id = " . $ilDB->quote($a_usr_id, 'integer');
        $ilDB->manipulate($query);
    }

getAppointmentId()

ilCalendarRegistration::getAppointmentId

(

)

Definition at line 62 of file class.ilCalendarRegistration.php.

References $appointment_id.

Referenced by read(), register(), and unregister().

                                      : int
    {
        return $this->appointment_id;
    }

Here is the caller graph for this function:

getRegisteredUsers()

ilCalendarRegistration::getRegisteredUsers	(	\ilDateTime	$start,
		\ilDateTime	$end
	)

Definition at line 67 of file class.ilCalendarRegistration.php.

References ilDateTime\get(), IL_CAL_UNIX, and ILIAS\Repository\int().

                                                                            : array
    {
        $users = [];
        foreach ($this->registered as $reg_data) {
            if (
                $reg_data['dstart'] == $start->get(IL_CAL_UNIX) &&
                $reg_data['dend'] == $end->get(IL_CAL_UNIX)
            ) {
                $users[] = (int) $reg_data['usr_id'];
            }
        }
        return $users;
    }

Here is the call graph for this function:

isRegistered()

ilCalendarRegistration::isRegistered	(		$a_usr_id,
		ilDateTime	$start,
		ilDateTime	$end
	)

Definition at line 81 of file class.ilCalendarRegistration.php.

References ilDateTime\get(), and IL_CAL_UNIX.

                                                                               : bool
    {
        foreach ($this->registered as $reg_data) {
            if ($reg_data['usr_id'] == $a_usr_id) {
                if ($reg_data['dstart'] == $start->get(IL_CAL_UNIX) and $reg_data['dend'] == $end->get(IL_CAL_UNIX)) {
                    return true;
                }
            }
        }
        return false;
    }

Here is the call graph for this function:

read()

ilCalendarRegistration::read ( )

protected

Read registration.

Definition at line 128 of file class.ilCalendarRegistration.php.

References $res, ilDBConstants\FETCHMODE_OBJECT, and getAppointmentId().

Referenced by __construct().

                             : void
    {
        if (!$this->getAppointmentId()) {
            return;
        }

        $query = "SELECT * FROM cal_registrations WHERE cal_id = " . $this->db->quote(
            $this->getAppointmentId(),
            'integer'
        );
        $res = $this->db->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->registered[] = array(
                'usr_id' => (int) $row->usr_id,
                'dstart' => (int) $row->dstart,
                'dend' => (int) $row->dend
            );
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

register()

ilCalendarRegistration::register	(	int	$a_usr_id,
		ilDateTime	$start,
		ilDateTime	$end
	)

Definition at line 93 of file class.ilCalendarRegistration.php.

References getAppointmentId(), IL_CAL_UNIX, and unregister().

                                                                               : void
    {
        $this->unregister($a_usr_id, $start, $end);

        $query = "INSERT INTO cal_registrations (cal_id,usr_id,dstart,dend) " .
            "VALUES ( " .
            $this->db->quote($this->getAppointmentId(), 'integer') . ", " .
            $this->db->quote($a_usr_id, 'integer') . ", " .
            $this->db->quote($start->get(IL_CAL_UNIX), 'integer') . ", " .
            $this->db->quote($end->get(IL_CAL_UNIX), 'integer') .
            ")";
        $this->db->manipulate($query);
        $this->registered[] = [
            'usr_id' => $a_usr_id,
            'dstart' => $start->get(IL_CAL_UNIX),
            'dend' => $end->get(IL_CAL_UNIX)
        ];
    }

Here is the call graph for this function:

unregister()

ilCalendarRegistration::unregister	(	int	$a_usr_id,
		ilDateTime	$start,
		ilDateTime	$end
	)

unregister one user

Definition at line 115 of file class.ilCalendarRegistration.php.

References $res, ilDateTime\get(), getAppointmentId(), and IL_CAL_UNIX.

Referenced by register().

                                                                                 : void
    {
        $query = "DELETE FROM cal_registrations " .
            "WHERE cal_id = " . $this->db->quote($this->getAppointmentId(), 'integer') . ' ' .
            "AND usr_id = " . $this->db->quote($a_usr_id, 'integer') . ' ' .
            "AND dstart = " . $this->db->quote($start->get(IL_CAL_UNIX), 'integer') . ' ' .
            "AND dend = " . $this->db->quote($end->get(IL_CAL_UNIX), 'integer');
        $res = $this->db->manipulate($query);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$appointment_id

int ilCalendarRegistration::$appointment_id = 0

private

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

Referenced by getAppointmentId().

$db

ilDBInterface ilCalendarRegistration::$db

protected

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

$registered

array ilCalendarRegistration::$registered = array()

private

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

---

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

• components/ILIAS/Calendar/classes/class.ilCalendarRegistration.php