| ILIAS
    Release_4_3_x_branch Revision 61807
    | 
class for calendar categories More...
 Collaboration diagram for ilCalendarCategories:
 Collaboration diagram for ilCalendarCategories:| Public Member Functions | |
| initialize ($a_mode, $a_source_ref_id=0, $a_use_cache=false) | |
| initialize visible categories | |
| getCategoryInfo ($a_cat_id) | |
| public | |
| getCategoriesInfo () | |
| get categories | |
| getCategories ($a_include_subitem_calendars=false) | |
| get categories | |
| getSubitemCategories ($a_cat_id) | |
| get subitem categories for a specific category | |
| prepareCategoriesOfUserForSelection () | |
| prepare categories of users for selection | |
| getNotificationCalendars () | |
| Get all calendars that allow send of notifications (Editable and course group calendars) | |
| isEditable ($a_cat_id) | |
| check if category is editable | |
| isVisible ($a_cat_id) | |
| check if category is visible | |
| readConsultationHoursCalendar ($user_id=NULL) | |
| Read personal consultation hours calendar. | |
| readBookingCalendar ($user_id=NULL) | |
| Read booking manager calendar. | |
| Static Public Member Functions | |
| static | _getInstance ($a_usr_id=0) | 
| get singleton instance | |
| static | _lookupCategoryIdByObjId ($a_obj_id) | 
| lookup category by obj_id | |
| static | _isOwner ($a_usr_id, $a_cal_id) | 
| check if user is owner of a category | |
| static | deletePDItemsCache ($a_usr_id) | 
| Delete cache (add remove desktop item) | |
| static | deleteRepositoryCache ($a_usr_id) | 
| Delete cache. | |
| static | lookupPrivateCategories ($a_user_id) | 
| Lookup private categories of user. | |
| Data Fields | |
| const | MODE_REPOSITORY = 2 | 
| const | MODE_REMOTE_ACCESS = 3 | 
| const | MODE_PERSONAL_DESKTOP_MEMBERSHIP = 4 | 
| const | MODE_PERSONAL_DESKTOP_ITEMS = 5 | 
| const | MODE_MANAGE = 6 | 
| const | MODE_CONSULTATION = 7 | 
| Protected Member Functions | |
| __construct ($a_usr_id=0) | |
| Singleton instance. | |
| sleep () | |
| Serialize categories. | |
| wakeup ($a_ser) | |
| Load from serialize string. | |
| readPDCalendars () | |
| Read categories of user. | |
| readSelectedItemCalendars () | |
| Read categories of selected items. | |
| readReposCalendars () | |
| Read available repository calendars. | |
| readPublicCalendars () | |
| Read public calendars. | |
| readPrivateCalendars () | |
| Read private calendars. | |
| readSelectedCategories ($a_obj_ids) | |
| read selected categories | |
| addSubitemCalendars () | |
| Add subitem calendars E.g. | |
| Protected Attributes | |
| $db | |
| $user_id | |
| $categories = array() | |
| $categories_info = array() | |
| $subitem_categories = array() | |
| $root_ref_id = 0 | |
| $root_obj_id = 0 | |
| Static Protected Attributes | |
| static | $instance = null | 
class for calendar categories
Definition at line 37 of file class.ilCalendarCategories.php.
| 
 | protected | 
Singleton instance.
protected
| int | $a_usr_id | user id | 
Definition at line 67 of file class.ilCalendarCategories.php.
References $ilUser.
| 
 | static | 
get singleton instance
public
| int | $a_usr_id | user id | 
Definition at line 87 of file class.ilCalendarCategories.php.
References $instance.
Referenced by ilCalendarAppointmentsTableGUI\__construct(), ilCalendarChangedAppointmentsTableGUI\__construct(), ilCalendarPresentationGUI\__construct(), ilCalendarAppointmentColors\__construct(), ilCalendarAppointmentGUI\distributeNotifications(), ilCalendarAppointmentGUI\edit(), ilCalendarAppointmentGUI\editResponsibleUsers(), ilCalendarSelectionBlockGUI\getCalendars(), ilCalendarSchedule\getChangedEvents(), ilCalendarSchedule\getEvents(), ilCalendarRemoteAccessHandler\handleRequest(), ilPDCalendarBlockGUI\initCategories(), ilCalendarBlockGUI\initCategories(), ilCalendarAppointmentGUI\initForm(), ilCalendarCategoryGUI\initFormCategory(), ilCalendarCategoryTableGUI\parse(), ilCalendarManageTableGUI\parse(), ilCalendarAppointmentGUI\save(), ilCalendarCategoryGUI\saveSelection(), ilCalendarCategoryGUI\showAssignedAppointments(), ilCalendarAppointmentGUI\showInfoScreen(), and ilCalendarPresentationGUI\synchroniseExternalCalendars().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| 
 | static | 
check if user is owner of a category
public
| int | usr_id | 
| int | cal_id | 
Definition at line 130 of file class.ilCalendarCategories.php.
References $query, $res, and ilCalendarCategory\TYPE_USR.
Referenced by ilCalendarShared\getSharedCalendarsForUser().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| 
 | static | 
lookup category by obj_id
public
| int | obj_id | 
Definition at line 104 of file class.ilCalendarCategories.php.
References $query, $res, $row, DB_FETCHMODE_OBJECT, and ilCalendarCategory\TYPE_OBJ.
Referenced by ilCalendarAppEventListener\createAppointments(), ilCalendarAppEventListener\deleteCategory(), ilDataLoader\generateCalendarEntries(), and ilCalendarAppointmentGUI\initForm().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| 
 | protected | 
Add subitem calendars E.g.
session calendars in courses, groups
| @return | 
Definition at line 774 of file class.ilCalendarCategories.php.
References $query, $res, $row, and DB_FETCHMODE_OBJECT.
Referenced by readPDCalendars(), and readSelectedItemCalendars().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| 
 | static | 
Delete cache (add remove desktop item)
| object | $a_usr_id | 
Definition at line 147 of file class.ilCalendarCategories.php.
References ilCalendarCache\getInstance().
Referenced by ilObjUser\_addDesktopItem(), ilObjUser\_dropDesktopItem(), and ilCalendarAppEventListener\handleEvent().
 Here is the call graph for this function:
 Here is the call graph for this function: Here is the caller graph for this function:
 Here is the caller graph for this function:| 
 | static | 
Delete cache.
| object | $a_usr_id | 
Definition at line 161 of file class.ilCalendarCategories.php.
References ilCalendarCache\getInstance().
Referenced by ilCalendarAppEventListener\handleEvent().
 Here is the call graph for this function:
 Here is the call graph for this function: Here is the caller graph for this function:
 Here is the caller graph for this function:| ilCalendarCategories::getCategories | ( | $a_include_subitem_calendars = false | ) | 
get categories
| $a_include_subitems | include subitem calendars public | 
Definition at line 319 of file class.ilCalendarCategories.php.
| ilCalendarCategories::getCategoriesInfo | ( | ) | 
get categories
public
| @return | 
Definition at line 308 of file class.ilCalendarCategories.php.
| ilCalendarCategories::getCategoryInfo | ( | $a_cat_id | ) | 
public
| @return | 
Definition at line 281 of file class.ilCalendarCategories.php.
| ilCalendarCategories::getNotificationCalendars | ( | ) | 
Get all calendars that allow send of notifications (Editable and course group calendars)
Definition at line 386 of file class.ilCalendarCategories.php.
References ilObject\_lookupType(), and ilCalendarCategory\TYPE_OBJ.
 Here is the call graph for this function:
 Here is the call graph for this function:| ilCalendarCategories::getSubitemCategories | ( | $a_cat_id | ) | 
get subitem categories for a specific category
| int | $a_category_id | Id of category in question | 
Definition at line 335 of file class.ilCalendarCategories.php.
| ilCalendarCategories::initialize | ( | $a_mode, | |
| $a_source_ref_id = 0, | |||
| $a_use_cache = false | |||
| ) | 
initialize visible categories
public
| int | mode | 
| int | ref_id of root node | 
Definition at line 209 of file class.ilCalendarCategories.php.
References $user_id, ilCalendarUserSettings\_getInstance(), ilObject\_lookupObjId(), ilCalendarUserSettings\CAL_SELECTION_MEMBERSHIP, ilCalendarCache\getInstance(), readConsultationHoursCalendar(), readPDCalendars(), readPrivateCalendars(), readReposCalendars(), readSelectedItemCalendars(), and wakeup().
 Here is the call graph for this function:
 Here is the call graph for this function:| ilCalendarCategories::isEditable | ( | $a_cat_id | ) | 
check if category is editable
public
| int | $a_cat_id | category id | 
Definition at line 409 of file class.ilCalendarCategories.php.
| ilCalendarCategories::isVisible | ( | $a_cat_id | ) | 
check if category is visible
public
| int | $a_cat_id | category id | 
Definition at line 421 of file class.ilCalendarCategories.php.
| 
 | static | 
Lookup private categories of user.
| @return | 
Definition at line 837 of file class.ilCalendarCategories.php.
References ilCalendarCategory\TYPE_USR.
Referenced by ilUserExporter\getXmlExportTailDependencies().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| ilCalendarCategories::prepareCategoriesOfUserForSelection | ( | ) | 
prepare categories of users for selection
public
| int | user id | 
Definition at line 352 of file class.ilCalendarCategories.php.
References $lng, and ilCalendarCategory\TYPE_USR.
| ilCalendarCategories::readBookingCalendar | ( | $user_id = NULL | ) | 
Read booking manager calendar.
| int | $user_id | 
Definition at line 673 of file class.ilCalendarCategories.php.
References $query, $res, $row, $user_id, DB_FETCHMODE_OBJECT, and ilCalendarCategory\TYPE_BOOK.
Referenced by readPDCalendars(), and readSelectedItemCalendars().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| ilCalendarCategories::readConsultationHoursCalendar | ( | $user_id = NULL | ) | 
Read personal consultation hours calendar.
| int | $user_id | 
Definition at line 641 of file class.ilCalendarCategories.php.
References $query, $res, $row, $user_id, DB_FETCHMODE_OBJECT, and ilCalendarCategory\TYPE_CH.
Referenced by initialize(), readPDCalendars(), readReposCalendars(), and readSelectedItemCalendars().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| 
 | protected | 
Read categories of user.
protected
| @return | void | 
Definition at line 437 of file class.ilCalendarCategories.php.
References ilParticipants\_getMembershipByType(), addSubitemCalendars(), readBookingCalendar(), readConsultationHoursCalendar(), readPrivateCalendars(), readPublicCalendars(), and readSelectedCategories().
Referenced by initialize().
 Here is the call graph for this function:
 Here is the call graph for this function: Here is the caller graph for this function:
 Here is the caller graph for this function:| 
 | protected | 
Read private calendars.
protected
Definition at line 591 of file class.ilCalendarCategories.php.
References $ilUser, $query, $res, $row, DB_FETCHMODE_OBJECT, ilCalendarSharedStatus\getAcceptedCalendars(), ilCalendarCategory\LTYPE_REMOTE, and ilCalendarCategory\TYPE_USR.
Referenced by initialize(), readPDCalendars(), readReposCalendars(), and readSelectedItemCalendars().
 Here is the call graph for this function:
 Here is the call graph for this function: Here is the caller graph for this function:
 Here is the caller graph for this function:| 
 | protected | 
Read public calendars.
protected
Definition at line 559 of file class.ilCalendarCategories.php.
References $query, $res, $row, ilCalendarSettings\_getInstance(), DB_FETCHMODE_OBJECT, ilCalendarCategory\LTYPE_REMOTE, and ilCalendarCategory\TYPE_GLOBAL.
Referenced by readPDCalendars(), readReposCalendars(), and readSelectedItemCalendars().
 Here is the call graph for this function:
 Here is the call graph for this function: Here is the caller graph for this function:
 Here is the caller graph for this function:| 
 | protected | 
Read available repository calendars.
protected
| @return | 
Definition at line 510 of file class.ilCalendarCategories.php.
References $query, $res, $row, ilCalendarSettings\_getInstance(), ilObject\_lookupType(), DB_FETCHMODE_OBJECT, readConsultationHoursCalendar(), readPrivateCalendars(), readPublicCalendars(), and readSelectedCategories().
Referenced by initialize().
 Here is the call graph for this function:
 Here is the call graph for this function: Here is the caller graph for this function:
 Here is the caller graph for this function:| 
 | protected | 
read selected categories
protected
Definition at line 706 of file class.ilCalendarCategories.php.
References $query, $ref_id, $res, $row, ilObject\_getAllReferences(), ilCalendarSettings\_getInstance(), ilObject\_lookupType(), DB_FETCHMODE_OBJECT, and ilCalendarCategory\TYPE_OBJ.
Referenced by readPDCalendars(), readReposCalendars(), and readSelectedItemCalendars().
 Here is the call graph for this function:
 Here is the call graph for this function: Here is the caller graph for this function:
 Here is the caller graph for this function:| 
 | protected | 
Read categories of selected items.
| @return | 
Definition at line 460 of file class.ilCalendarCategories.php.
References $ilUser, ilObjUser\_lookupDesktopItems(), addSubitemCalendars(), readBookingCalendar(), readConsultationHoursCalendar(), readPrivateCalendars(), readPublicCalendars(), and readSelectedCategories().
Referenced by initialize().
 Here is the call graph for this function:
 Here is the call graph for this function: Here is the caller graph for this function:
 Here is the caller graph for this function:| 
 | protected | 
Serialize categories.
Definition at line 176 of file class.ilCalendarCategories.php.
| 
 | protected | 
Load from serialize string.
| string | serialize categories | 
Definition at line 192 of file class.ilCalendarCategories.php.
Referenced by initialize().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| 
 | protected | 
Definition at line 52 of file class.ilCalendarCategories.php.
| 
 | protected | 
Definition at line 53 of file class.ilCalendarCategories.php.
| 
 | protected | 
Definition at line 48 of file class.ilCalendarCategories.php.
| 
 | staticprotected | 
Definition at line 46 of file class.ilCalendarCategories.php.
Referenced by _getInstance().
| 
 | protected | 
Definition at line 57 of file class.ilCalendarCategories.php.
| 
 | protected | 
Definition at line 56 of file class.ilCalendarCategories.php.
| 
 | protected | 
Definition at line 54 of file class.ilCalendarCategories.php.
| 
 | protected | 
Definition at line 50 of file class.ilCalendarCategories.php.
Referenced by initialize(), readBookingCalendar(), and readConsultationHoursCalendar().
| const ilCalendarCategories::MODE_CONSULTATION = 7 | 
Definition at line 44 of file class.ilCalendarCategories.php.
Referenced by ilCalendarBlockGUI\initCategories().
| const ilCalendarCategories::MODE_MANAGE = 6 | 
Definition at line 43 of file class.ilCalendarCategories.php.
Referenced by ilCalendarManageTableGUI\parse().
| const ilCalendarCategories::MODE_PERSONAL_DESKTOP_ITEMS = 5 | 
Definition at line 42 of file class.ilCalendarCategories.php.
Referenced by ilCalendarPresentationGUI\__construct(), ilCalendarBlockGUI\getHTML(), ilPDCalendarBlockGUI\initCategories(), and ilCalendarBlockGUI\showCalendarSubscription().
| const ilCalendarCategories::MODE_PERSONAL_DESKTOP_MEMBERSHIP = 4 | 
Definition at line 41 of file class.ilCalendarCategories.php.
Referenced by ilCalendarPresentationGUI\__construct(), ilCalendarBlockGUI\getHTML(), ilPDCalendarBlockGUI\initCategories(), and ilCalendarBlockGUI\showCalendarSubscription().
| const ilCalendarCategories::MODE_REMOTE_ACCESS = 3 | 
Definition at line 40 of file class.ilCalendarCategories.php.
Referenced by ilCalendarRemoteAccessHandler\handleRequest().
| const ilCalendarCategories::MODE_REPOSITORY = 2 | 
Definition at line 39 of file class.ilCalendarCategories.php.
Referenced by ilCalendarBlockGUI\getHTML(), and ilCalendarBlockGUI\initCategories().