Stores calendar categories. More...

Collaboration diagram for ilCalendarCategory:

Public Member Functions
	__construct ($a_cat_id=0)
	Constructor. More...

	getCategoryID ()
	get category id More...

	setTitle ($a_title)
	set title More...

	getTitle ()
	get title More...

	setColor ($a_color)
	set color More...

	getColor ()
	get color More...

	setType ($a_type)
	set type More...

	getType ()
	get type More...

	setObjId ($a_obj_id)
	set obj id More...

	getObjId ()
	get obj_id More...

	getObjType ()
	get type More...

	getLocationType ()

	setLocationType ($a_type)

	setRemoteUrl ($a_url)

	getRemoteUrl ()

	setRemoteUser ($a_user)

	getRemoteUser ()

	setRemotePass ($a_pass)

	getRemotePass ()

	setRemoteSyncLastExecution (ilDateTime $dt=null)
	Set remote sync last execution. More...

	getRemoteSyncLastExecution ()
	Get last execution date of remote sync. More...

	add ()
	add new category More...

	update ()
	update More...

	delete ()
	delete More...

	validate ()
	validate More...

Static Public Member Functions
static	_getInstanceByObjId ($a_obj_id)
	get instance by obj_id More...

static	getInstanceByCategoryId ($a_cat_id)
	Get instance by category id. More...

static	lookupCategorySortIndex ($a_type_id)
	Lookup sort index of calendar type. More...

static	lookupAppointments ($a_category_id)
	get all assigned appointment ids More...

Data Fields
const	LTYPE_LOCAL = 1

const	LTYPE_REMOTE = 2

const	DEFAULT_COLOR = '#04427e'

const	TYPE_USR = 1

const	TYPE_OBJ = 2

const	TYPE_GLOBAL = 3

const	TYPE_CH = 4

const	TYPE_BOOK = 5

Protected Attributes
	$cat_id

	$color

	$type = self::TYPE_USR

	$obj_id

	$obj_type = null

	$title

	$location = self::LTYPE_LOCAL

	$remote_url

	$remote_user

	$remote_pass

	$remote_sync = null

	$db

Static Protected Attributes
static	$SORTED_TYPES

Private Member Functions
	read ()
	read More...

Static Private Attributes
static	$instances = null

Detailed Description

Stores calendar categories.

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

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilCalendarCategory::__construct ( $a_cat_id = 0 )

Constructor.

public

Definition at line 78 of file class.ilCalendarCategory.php.

References $DIC, $ilDB, and read().

     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
         
         $this->db = $ilDB;
         $this->cat_id = $a_cat_id;
         
         $this->read();
     }

Here is the call graph for this function:

Member Function Documentation

◆ _getInstanceByObjId()

static ilCalendarCategory::_getInstanceByObjId ( $a_obj_id )

static

get instance by obj_id

Parameters

int obj_id

Returns

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

References $DIC, $ilDB, $query, $res, $row, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilCalendarPresentationGUI\addStandardTabs(), ilCalendarAppEventListener\createCategory(), ilCalendarSubscriptionGUI\getModalForSubscription(), ilCalendarSubscriptionGUI\show(), and ilCalendarAppEventListener\updateCategory().

     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
         
         $query = "SELECT cat_id FROM cal_categories " .
             "WHERE obj_id = " . $ilDB->quote($a_obj_id, 'integer') . " " .
             "AND type = " . $ilDB->quote(self::TYPE_OBJ, 'integer');
         $res = $ilDB->query($query);
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             return new ilCalendarCategory($row->cat_id);
         }
         return null;
     }

Here is the caller graph for this function:

◆ add()

ilCalendarCategory::add ( )

add new category

public

Returns

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

References $cat_id, $DIC, $ilDB, $query, getColor(), getLocationType(), getObjId(), getRemotePass(), getRemoteSyncLastExecution(), getRemoteUrl(), getRemoteUser(), getTitle(), getType(), IL_CAL_DATETIME, and ilTimeZone\UTC.

     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         $next_id = $ilDB->nextId('cal_categories');
         
         $query = "INSERT INTO cal_categories (cat_id,obj_id,color,type,title,loc_type,remote_url,remote_user,remote_pass,remote_sync) " .
             "VALUES ( " .
             $ilDB->quote($next_id, 'integer') . ", " .
             $this->db->quote($this->getObjId(), 'integer') . ", " .
             $this->db->quote($this->getColor(), 'text') . ", " .
             $this->db->quote($this->getType(), 'integer') . ", " .
             $this->db->quote($this->getTitle(), 'text') . ", " .
             $this->db->quote($this->getLocationType(), 'integer') . ', ' .
             $this->db->quote($this->getRemoteUrl(), 'text') . ', ' .
             $this->db->quote($this->getRemoteUser(), 'text') . ', ' .
             $this->db->quote($this->getRemotePass(), 'text') . ', ' .
             $this->db->quote($this->getRemoteSyncLastExecution()->get(IL_CAL_DATETIME, '', ilTimeZone::UTC), 'timestamp') . ' ' .
             ")";
         
         $ilDB->manipulate($query);
 
         $this->cat_id = $next_id;
         return $this->cat_id;
     }

Here is the call graph for this function:

◆ delete()

ilCalendarCategory::delete ( )

delete

public

Returns

Definition at line 394 of file class.ilCalendarCategory.php.

References $DIC, $ilDB, $query, $res, ilCalendarEntry\_delete(), ilCalendarCategoryAssignments\_deleteByCategoryId(), ilCalendarVisibility\_deleteCategories(), and ilCalendarCategoryAssignments\_getAssignedAppointments().

     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
         
         $query = "DELETE FROM cal_categories " .
             "WHERE cat_id = " . $this->db->quote($this->cat_id, 'integer') . " ";
         $res = $ilDB->manipulate($query);
 
         include_once('./Services/Calendar/classes/class.ilCalendarVisibility.php');
         ilCalendarVisibility::_deleteCategories($this->cat_id);
         
         include_once('./Services/Calendar/classes/class.ilCalendarCategoryAssignments.php');
         foreach (ilCalendarCategoryAssignments::_getAssignedAppointments(array($this->cat_id)) as $app_id) {
             include_once('./Services/Calendar/classes/class.ilCalendarEntry.php');
             ilCalendarEntry::_delete($app_id);
         }
         ilCalendarCategoryAssignments::_deleteByCategoryId($this->cat_id);
     }

Here is the call graph for this function:

◆ getCategoryID()

ilCalendarCategory::getCategoryID ( )

get category id

public

Returns: int category id

Definition at line 160 of file class.ilCalendarCategory.php.

References $cat_id.

Referenced by ilCalendarRemoteReader\importIcal(), and read().

     {
         return $this->cat_id;
     }

Here is the caller graph for this function:

◆ getColor()

ilCalendarCategory::getColor ( )

get color

public

Returns

Definition at line 206 of file class.ilCalendarCategory.php.

References $color.

Referenced by add(), update(), and validate().

     {
         return $this->color;
     }

Here is the caller graph for this function:

◆ getInstanceByCategoryId()

static ilCalendarCategory::getInstanceByCategoryId ( $a_cat_id )

static

Get instance by category id.

Parameters

int $a_cat_id

Returns: ilCalendarCategory

Definition at line 118 of file class.ilCalendarCategory.php.

Referenced by ilCalendarExport\buildAppointmentUrl(), ilDownloadFilesBackgroundTask\collectFiles(), ilAppointmentBaseFileHandler\getCatInfo(), ilCalendarAppointmentBaseFactory\getClassBaseName(), ilDownloadFilesBackgroundTask\getEventFileNameFromId(), ilAppointmentFileHandlerFactory\getInstance(), ilAppointmentPresentationFactory\getInstance(), ilCalendarScheduleFilterBookingPool\isBookingPoolCategory(), ilCalendarScheduleFilterTimings\isCourseCategory(), ilCalendarScheduleFilterExercise\isExerciseCategory(), and ilAppointmentPresentationGUI\readObjIdForAppointment().

     {
         if (!self::$instances[$a_cat_id]) {
             return self::$instances[$a_cat_id] = new ilCalendarCategory($a_cat_id);
         }
         return self::$instances[$a_cat_id];
     }

Here is the caller graph for this function:

◆ getLocationType()

ilCalendarCategory::getLocationType ( )

Definition at line 265 of file class.ilCalendarCategory.php.

References $location.

Referenced by add(), update(), and validate().

     {
         return $this->location;
     }

Here is the caller graph for this function:

◆ getObjId()

ilCalendarCategory::getObjId ( )

get obj_id

public

Returns

Definition at line 250 of file class.ilCalendarCategory.php.

References $obj_id.

Referenced by add(), read(), and update().

     {
         return $this->obj_id;
     }

Here is the caller graph for this function:

◆ getObjType()

ilCalendarCategory::getObjType ( )

get type

public

Definition at line 260 of file class.ilCalendarCategory.php.

References $obj_type.

     {
         return $this->obj_type;
     }

◆ getRemotePass()

ilCalendarCategory::getRemotePass ( )

Definition at line 300 of file class.ilCalendarCategory.php.

References $remote_pass.

Referenced by add(), ilCalendarCategoryGUI\doSynchronisation(), and update().

     {
         return $this->remote_pass;
     }

Here is the caller graph for this function:

◆ getRemoteSyncLastExecution()

ilCalendarCategory::getRemoteSyncLastExecution ( )

Get last execution date of remote sync.

Returns

Definition at line 318 of file class.ilCalendarCategory.php.

References $remote_sync.

Referenced by add(), and update().

     {
         if ($this->remote_sync instanceof ilDateTime) {
             return $this->remote_sync;
         }
         return new ilDateTime();
     }

Here is the caller graph for this function:

◆ getRemoteUrl()

ilCalendarCategory::getRemoteUrl ( )

Definition at line 280 of file class.ilCalendarCategory.php.

References $remote_url.

Referenced by add(), ilCalendarCategoryGUI\doSynchronisation(), update(), and validate().

     {
         return $this->remote_url;
     }

Here is the caller graph for this function:

◆ getRemoteUser()

ilCalendarCategory::getRemoteUser ( )

Definition at line 290 of file class.ilCalendarCategory.php.

References $remote_user.

Referenced by add(), ilCalendarCategoryGUI\doSynchronisation(), and update().

     {
         return $this->remote_user;
     }

Here is the caller graph for this function:

◆ getTitle()

ilCalendarCategory::getTitle ( )

get title

public

Returns: string title

Definition at line 183 of file class.ilCalendarCategory.php.

References $title.

Referenced by add(), update(), and validate().

     {
         return $this->title;
     }

Here is the caller graph for this function:

◆ getType()

ilCalendarCategory::getType ( )

get type

public

Returns

Definition at line 228 of file class.ilCalendarCategory.php.

References $type.

Referenced by add(), read(), update(), and validate().

     {
         return $this->type;
     }

Here is the caller graph for this function:

◆ lookupAppointments()

static ilCalendarCategory::lookupAppointments ( $a_category_id )

static

get all assigned appointment ids

Returns

Parameters

object $a_category_id

Definition at line 138 of file class.ilCalendarCategory.php.

References $DIC, $ilDB, $query, $res, $row, and ilDBConstants\FETCHMODE_OBJECT.

     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
     
         $query = "SELECT * FROM cal_cat_assignments " .
             'WHERE cat_id = ' . $ilDB->quote($a_category_id, 'integer');
         $res = $ilDB->query($query);
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $apps[] = $row->cal_id;
         }
         return $apps ? $apps : array();
     }

◆ lookupCategorySortIndex()

static ilCalendarCategory::lookupCategorySortIndex ( $a_type_id )

static

Lookup sort index of calendar type.

Definition at line 129 of file class.ilCalendarCategory.php.

Referenced by ilCalendarSelectionBlockGUI\getCalendars(), ilCalendarCategoryTableGUI\parse(), and ilCalendarManageTableGUI\parse().

     {
         return array_search($a_type_id, self::$SORTED_TYPES);
     }

Here is the caller graph for this function:

◆ read()

ilCalendarCategory::read ( )

private

read

protected

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

References $DIC, $ilDB, $query, $res, $row, ilObject\_lookupTitle(), ilObject\_lookupType(), color, ilDBConstants\FETCHMODE_OBJECT, getCategoryID(), getObjId(), getType(), and IL_CAL_DATETIME.

Referenced by __construct().

     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
         
         if (!$this->cat_id) {
             return true;
         }
         
         $query = "SELECT * FROM cal_categories " .
             "WHERE cat_id = " . $this->db->quote($this->getCategoryID(), 'integer') . " ";
         $res = $this->db->query($query);
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $this->cat_id = $row->cat_id;
             $this->obj_id = $row->obj_id;
             $this->type = $row->type;
             $this->color = $row->color;
             $this->title = $row->title;
             $this->location = $row->loc_type;
             $this->remote_url = $row->remote_url;
             $this->remote_user = $row->remote_user;
             $this->remote_pass = $row->remote_pass;
             
             if ($row->remote_sync) {
                 $this->remote_sync = new ilDateTime($row->remote_sync, IL_CAL_DATETIME, 'UTC');
             } else {
                 $this->remote_sync = new ilDateTime();
             }
         }
         if ($this->getType() == self::TYPE_OBJ) {
             $this->title = ilObject::_lookupTitle($this->getObjId());
             $this->obj_type = ilObject::_lookupType($this->getObjId());
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setColor()

ilCalendarCategory::setColor ( $a_color )

set color

public

Parameters

string color

Definition at line 195 of file class.ilCalendarCategory.php.

References color.

     {
         $this->color = $a_color;
     }

◆ setLocationType()

ilCalendarCategory::setLocationType ( $a_type )

Definition at line 270 of file class.ilCalendarCategory.php.

References $a_type.

     {
         $this->location = $a_type;
     }

◆ setObjId()

ilCalendarCategory::setObjId ( $a_obj_id )

set obj id

public

Parameters

int obj_id

Definition at line 239 of file class.ilCalendarCategory.php.

     {
         $this->obj_id = $a_obj_id;
     }

◆ setRemotePass()

ilCalendarCategory::setRemotePass ( $a_pass )

Definition at line 295 of file class.ilCalendarCategory.php.

     {
         $this->remote_pass = $a_pass;
     }

◆ setRemoteSyncLastExecution()

ilCalendarCategory::setRemoteSyncLastExecution ( ilDateTime $dt = null )

Set remote sync last execution.

Parameters

ilDateTime $dt

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

     {
         $this->remote_sync = $dt;
     }

◆ setRemoteUrl()

ilCalendarCategory::setRemoteUrl ( $a_url )

Definition at line 275 of file class.ilCalendarCategory.php.

     {
         $this->remote_url = $a_url;
     }

◆ setRemoteUser()

ilCalendarCategory::setRemoteUser ( $a_user )

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

     {
         $this->remote_user = $a_user;
     }

◆ setTitle()

ilCalendarCategory::setTitle ( $a_title )

set title

public

Parameters

string title

Returns

Definition at line 172 of file class.ilCalendarCategory.php.

     {
         $this->title = $a_title;
     }

◆ setType()

ilCalendarCategory::setType ( $a_type )

set type

public

Parameters

int type

Definition at line 217 of file class.ilCalendarCategory.php.

References $a_type.

     {
         $this->type = $a_type;
     }

◆ update()

ilCalendarCategory::update ( )

update

public

Returns

Definition at line 367 of file class.ilCalendarCategory.php.

References $DIC, $ilDB, $query, $res, getColor(), getLocationType(), getObjId(), getRemotePass(), getRemoteSyncLastExecution(), getRemoteUrl(), getRemoteUser(), getTitle(), getType(), IL_CAL_DATETIME, and ilTimeZone\UTC.

     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
         
         $query = "UPDATE cal_categories " .
             "SET obj_id = " . $this->db->quote($this->getObjId(), 'integer') . ", " .
             "color = " . $this->db->quote($this->getColor(), 'text') . ", " .
             "type = " . $this->db->quote($this->getType(), 'integer') . ", " .
             "title = " . $this->db->quote($this->getTitle(), 'text') . ", " .
             "loc_type = " . $this->db->quote($this->getLocationType(), 'integer') . ', ' .
             "remote_url = " . $this->db->quote($this->getRemoteUrl(), 'text') . ', ' .
             "remote_user = " . $this->db->quote($this->getRemoteUser(), 'text') . ', ' .
             "remote_pass = " . $this->db->quote($this->getRemotePass(), 'text') . ', ' .
             'remote_sync = ' . $this->db->quote($this->getRemoteSyncLastExecution()->get(IL_CAL_DATETIME, '', ilTimeZone::UTC), 'timestamp') . ' ' .
             "WHERE cat_id = " . $this->db->quote($this->cat_id, 'integer') . " ";
         $res = $ilDB->manipulate($query);
         return true;
     }

Here is the call graph for this function:

◆ validate()

ilCalendarCategory::validate ( )

validate

public

Returns: bool

Definition at line 421 of file class.ilCalendarCategory.php.

References getColor(), getLocationType(), getRemoteUrl(), getTitle(), getType(), and LTYPE_REMOTE.

     {
         if ($this->getLocationType() == ilCalendarCategory::LTYPE_REMOTE and !$this->getRemoteUrl()) {
             return false;
         }
         if (strlen($this->getTitle()) and strlen($this->getColor()) and $this->getType()) {
             return true;
         }
         return false;
     }

Here is the call graph for this function:

Field Documentation

◆ $cat_id

ilCalendarCategory::$cat_id

protected

Definition at line 57 of file class.ilCalendarCategory.php.

Referenced by add(), and getCategoryID().

◆ $color

ilCalendarCategory::$color

protected

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

Referenced by getColor().

◆ $db

ilCalendarCategory::$db

protected

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

◆ $instances

ilCalendarCategory::$instances = null

staticprivate

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

◆ $location

ilCalendarCategory::$location = self::LTYPE_LOCAL

protected

Definition at line 64 of file class.ilCalendarCategory.php.

Referenced by getLocationType().

◆ $obj_id

ilCalendarCategory::$obj_id

protected

Definition at line 60 of file class.ilCalendarCategory.php.

Referenced by getObjId().

◆ $obj_type

ilCalendarCategory::$obj_type = null

protected

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

Referenced by getObjType().

◆ $remote_pass

ilCalendarCategory::$remote_pass

protected

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

Referenced by getRemotePass().

◆ $remote_sync

ilCalendarCategory::$remote_sync = null

protected

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

Referenced by getRemoteSyncLastExecution().

◆ $remote_url

ilCalendarCategory::$remote_url

protected

Definition at line 65 of file class.ilCalendarCategory.php.

Referenced by getRemoteUrl().

◆ $remote_user

ilCalendarCategory::$remote_user

protected

Definition at line 66 of file class.ilCalendarCategory.php.

Referenced by getRemoteUser().

◆ $SORTED_TYPES

ilCalendarCategory::$SORTED_TYPES

staticprotected

Initial value:

= array(
        0 => self::TYPE_GLOBAL,
        1 => self::TYPE_USR,
        2 => self::TYPE_CH,
        3 => self::TYPE_BOOK,
        4 => self::TYPE_OBJ
    )

Definition at line 48 of file class.ilCalendarCategory.php.