|
ILIAS
release_5-3 Revision v5.3.23-19-g915713cf615
|
class for calendar categories More...
Collaboration diagram for ilCalendarCategories:Public Member Functions | |
| setCHUserId ($a_user_id) | |
| Set ch user id. More... | |
| getCHUserId () | |
| Get ch user id. More... | |
| getMode () | |
| getTargetRefId () | |
| setSourceRefId ($a_val) | |
| Set source ref id. More... | |
| getSourceRefId () | |
| Get source ref id. More... | |
| initialize ($a_mode, $a_source_ref_id=0, $a_use_cache=false, $a_cat_id=0) | |
| initialize visible categories More... | |
| getCategoryInfo ($a_cat_id) | |
| @access public More... | |
| getCategoriesInfo () | |
| get categories More... | |
| getCategories ($a_include_subitem_calendars=false) | |
| get categories More... | |
| getSubitemCategories ($a_cat_id) | |
| get subitem categories for a specific category More... | |
| prepareCategoriesOfUserForSelection () | |
| prepare categories of users for selection More... | |
| getNotificationCalendars () | |
| Get all calendars that allow send of notifications (Editable and course group calendars) More... | |
| isEditable ($a_cat_id) | |
| check if category is editable More... | |
| isVisible ($a_cat_id) | |
| check if category is visible More... | |
| readSingleCalendar ($a_cat_id) | |
| readAllConsultationHoursCalendarOfContainer ($a_container_ref_id) | |
| Read personal consultation hours calendar of all tutors for a container. More... | |
| readConsultationHoursCalendar ($a_target_ref_id=null, $a_cat_id=0) | |
| Read personal consultation hours calendar. More... | |
| readBookingCalendar ($user_id=null) | |
| Read booking manager calendar. More... | |
Static Public Member Functions | |
| static | _getInstance ($a_usr_id=0) |
| get singleton instance More... | |
| static | _lookupCategoryIdByObjId ($a_obj_id) |
| lookup category by obj_id More... | |
| static | _isOwner ($a_usr_id, $a_cal_id) |
| check if user is owner of a category More... | |
| static | deletePDItemsCache ($a_usr_id) |
| Delete cache (add remove desktop item) More... | |
| static | deleteRepositoryCache ($a_usr_id) |
| Delete cache. More... | |
| static | lookupPrivateCategories ($a_user_id) |
| Lookup private categories of user. More... | |
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 |
| const | MODE_PORTFOLIO_CONSULTATION = 8 |
| const | MODE_REMOTE_SELECTED = 9 |
| const | MODE_REPOSITORY_CONTAINER_ONLY = 10 |
| const | MODE_SINGLE_CALENDAR = 11 |
Protected Member Functions | |
| __construct ($a_usr_id=0) | |
| Singleton instance. More... | |
| sleep () | |
| Serialize categories. More... | |
| wakeup ($a_ser) | |
| Load from serialize string. More... | |
| setMode ($a_mode) | |
| setTargetRefId ($a_ref_id) | |
| readPDCalendars () | |
| Read categories of user. More... | |
| readSelectedCalendar ($a_cal_id) | |
| Read info about selected calendar. More... | |
| readSelectedItemCalendars () | |
| Read categories of selected items. More... | |
| readReposCalendars ($a_container_only=false) | |
| Read available repository calendars. More... | |
| readPublicCalendars ($cat_ids=null) | |
| Read public calendars. More... | |
| readPrivateCalendars ($only_cat_ids=null) | |
| Read private calendars. More... | |
| readSelectedCategories ($a_obj_ids, $a_source_ref_id=0) | |
| read selected categories More... | |
| addSubitemCalendars () | |
| Add subitem calendars E.g. More... | |
Protected Attributes | |
| $db | |
| $user_id | |
| $mode = 0 | |
| $categories = array() | |
| $categories_info = array() | |
| $subitem_categories = array() | |
| $root_ref_id = 0 | |
| $root_obj_id = 0 | |
| $ch_user_id = 0 | |
| $target_ref_id = 0 | |
| $logger = null | |
| ilLogger More... | |
Static Protected Attributes | |
| static | $instance = null |
class for calendar categories
Definition at line 34 of file class.ilCalendarCategories.php.
|
protected |
Singleton instance.
@access protected
| int | $a_usr_id | user id |
Definition at line 78 of file class.ilCalendarCategories.php.
|
static |
get singleton instance
@access public
| int | $a_usr_id | user id |
Definition at line 99 of file class.ilCalendarCategories.php.
References $instance.
Referenced by ilCalendarChangedAppointmentsTableGUI\__construct(), ilCalendarAppointmentsTableGUI\__construct(), ilCalendarPresentationGUI\__construct(), ilCalendarAppointmentColors\__construct(), ilCalendarScheduleFilterBookingPool\__construct(), ilCalendarScheduleFilterHidden\__construct(), ilCalendarScheduleFilterBookings\__construct(), ilCalendarActions\__construct(), ilCalendarSchedule\__construct(), ilAppointmentPresentationConsultationHoursGUI\collectPropertiesAndActions(), ilCalendarAppointmentGUI\distributeNotifications(), ilCalendarAppointmentGUI\edit(), ilCalendarAppointmentGUI\editResponsibleUsers(), ilPortfolioPageGUI\executeCommand(), ilCalendarScheduleFilterHidden\filterCategories(), ilCalendarSelectionBlockGUI\getCalendars(), ilAppointmentPresentationGUI\getCatInfo(), ilCalendarSchedule\getChangedEvents(), ilCalendarSchedule\getEvents(), ilCalendarAppointmentPanelGUI\getHTML(), ilCalendarAgendaListGUI\getHTML(), ilCalendarRemoteAccessHandler\handleRequest(), ilCalendarBlockGUI\initCategories(), ilPDCalendarBlockGUI\initCategories(), ilCalendarAppointmentGUI\initForm(), ilCalendarCategoryGUI\initFormCategory(), ilCalendarCategoryTableGUI\parse(), ilCalendarManageTableGUI\parse(), ilPortfolioPageGUI\renderConsultationHours(), ilCalendarAppointmentGUI\save(), ilCalendarCategoryGUI\saveSelection(), ilCalendarCategoryGUI\showAssignedAppointments(), ilCalendarAppointmentGUI\showInfoScreen(), and ilCalendarPresentationGUI\synchroniseExternalCalendars().
Here is the caller graph for this function:
|
static |
check if user is owner of a category
@access public
| int | usr_id |
| int | cal_id |
Definition at line 140 of file class.ilCalendarCategories.php.
References $ilDB, $query, $res, and ilCalendarCategory\TYPE_USR.
Referenced by ilCalendarShared\getSharedCalendarsForUser().
Here is the caller graph for this function:
|
static |
lookup category by obj_id
@access public
| int | obj_id |
Definition at line 115 of file class.ilCalendarCategories.php.
References $ilDB, $query, $res, $row, ilDBConstants\FETCHMODE_OBJECT, and ilCalendarCategory\TYPE_OBJ.
Referenced by ilCalendarAppEventListener\createAppointments(), ilCalendarAppEventListener\deleteCategory(), and ilCalendarAppointmentGUI\initForm().
Here is the caller graph for this function:
|
protected |
Add subitem calendars E.g.
session calendars in courses, groups
return
Definition at line 1007 of file class.ilCalendarCategories.php.
References $ilDB, $query, $res, $row, and ilDBConstants\FETCHMODE_OBJECT.
Referenced by readPDCalendars(), readReposCalendars(), readSelectedCalendar(), and readSelectedItemCalendars().
Here is the caller graph for this function:
|
static |
Delete cache (add remove desktop item)
| object | $a_usr_id |
Definition at line 157 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 caller graph for this function:
|
static |
Delete cache.
| object | $a_usr_id |
Definition at line 171 of file class.ilCalendarCategories.php.
References ilCalendarCache\getInstance().
Referenced by ilCalendarAppEventListener\handleEvent().
Here is the call 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 @access public |
Definition at line 406 of file class.ilCalendarCategories.php.
| ilCalendarCategories::getCategoriesInfo | ( | ) |
get categories
@access public
return
Definition at line 395 of file class.ilCalendarCategories.php.
| ilCalendarCategories::getCategoryInfo | ( | $a_cat_id | ) |
@access public
return
Definition at line 372 of file class.ilCalendarCategories.php.
| ilCalendarCategories::getCHUserId | ( | ) |
Get ch user id.
Definition at line 224 of file class.ilCalendarCategories.php.
References $ch_user_id.
Referenced by readAllConsultationHoursCalendarOfContainer(), and readConsultationHoursCalendar().
Here is the caller graph for this function:| ilCalendarCategories::getMode | ( | ) |
Definition at line 234 of file class.ilCalendarCategories.php.
References $mode.
Referenced by initialize().
Here is the caller graph for this function:| ilCalendarCategories::getNotificationCalendars | ( | ) |
Get all calendars that allow send of notifications (Editable and course group calendars)
Definition at line 466 of file class.ilCalendarCategories.php.
References $info, ilObject\_lookupType(), and ilCalendarCategory\TYPE_OBJ.
Here is the call graph for this function:| ilCalendarCategories::getSourceRefId | ( | ) |
Get source ref id.
Definition at line 264 of file class.ilCalendarCategories.php.
References $root_ref_id.
| ilCalendarCategories::getSubitemCategories | ( | $a_cat_id | ) |
get subitem categories for a specific category
| int | $a_category_id | Id of category in question |
Definition at line 421 of file class.ilCalendarCategories.php.
| ilCalendarCategories::getTargetRefId | ( | ) |
Definition at line 244 of file class.ilCalendarCategories.php.
References $target_ref_id.
| ilCalendarCategories::initialize | ( | $a_mode, | |
$a_source_ref_id = 0, |
|||
$a_use_cache = false, |
|||
$a_cat_id = 0 |
|||
| ) |
initialize visible categories
@access public
| int | mode |
| int | ref_id of root node |
Definition at line 277 of file class.ilCalendarCategories.php.
References ilCalendarUserSettings\_getInstance(), ilObject\_lookupObjId(), ilCalendarUserSettings\CAL_SELECTION_MEMBERSHIP, ilCalendarCache\getInstance(), getMode(), MODE_CONSULTATION, MODE_MANAGE, MODE_PERSONAL_DESKTOP_ITEMS, MODE_PERSONAL_DESKTOP_MEMBERSHIP, MODE_PORTFOLIO_CONSULTATION, MODE_REMOTE_ACCESS, MODE_REMOTE_SELECTED, MODE_REPOSITORY, MODE_REPOSITORY_CONTAINER_ONLY, MODE_SINGLE_CALENDAR, readConsultationHoursCalendar(), readPDCalendars(), readReposCalendars(), readSelectedCalendar(), readSelectedItemCalendars(), readSingleCalendar(), setMode(), setTargetRefId(), sleep(), and wakeup().
Here is the call graph for this function:| ilCalendarCategories::isEditable | ( | $a_cat_id | ) |
check if category is editable
@access public
| int | $a_cat_id | category id |
Definition at line 486 of file class.ilCalendarCategories.php.
| ilCalendarCategories::isVisible | ( | $a_cat_id | ) |
check if category is visible
@access public
| int | $a_cat_id | category id |
Definition at line 498 of file class.ilCalendarCategories.php.
|
static |
Lookup private categories of user.
return
Definition at line 1062 of file class.ilCalendarCategories.php.
References $ilDB, and ilCalendarCategory\TYPE_USR.
Referenced by ilUserExporter\getXmlExportTailDependencies().
Here is the caller graph for this function:| ilCalendarCategories::prepareCategoriesOfUserForSelection | ( | ) |
prepare categories of users for selection
@access public
| int | user id |
Definition at line 437 of file class.ilCalendarCategories.php.
References $info, $lng, and ilCalendarCategory\TYPE_USR.
| ilCalendarCategories::readAllConsultationHoursCalendarOfContainer | ( | $a_container_ref_id | ) |
Read personal consultation hours calendar of all tutors for a container.
| int | $a_container_ref_id | container ref id |
Definition at line 812 of file class.ilCalendarCategories.php.
References $users, ilCourseParticipants\_getInstanceByObjId(), ilObject\_lookupObjId(), getCHUserId(), ilBookingEntry\lookupBookableUsersForObject(), readConsultationHoursCalendar(), and setCHUserId().
Referenced by readReposCalendars().
Here is the call graph for this function:
Here is the caller graph for this function:| ilCalendarCategories::readBookingCalendar | ( | $user_id = null | ) |
Read booking manager calendar.
| int | $user_id |
Definition at line 911 of file class.ilCalendarCategories.php.
References $ilDB, $query, $res, $row, $user_id, ilDBConstants\FETCHMODE_OBJECT, and ilCalendarCategory\TYPE_BOOK.
Referenced by readPDCalendars(), readReposCalendars(), readSelectedItemCalendars(), and readSingleCalendar().
Here is the caller graph for this function:| ilCalendarCategories::readConsultationHoursCalendar | ( | $a_target_ref_id = null, |
|
$a_cat_id = 0 |
|||
| ) |
Read personal consultation hours calendar.
| int | $user_id |
Definition at line 833 of file class.ilCalendarCategories.php.
References $categories, $ilDB, $lng, $query, $res, $row, ilObjUser\_lookupFullname(), ilObject\_lookupObjId(), ilDBConstants\FETCHMODE_OBJECT, getCHUserId(), setCHUserId(), and ilCalendarCategory\TYPE_CH.
Referenced by initialize(), readAllConsultationHoursCalendarOfContainer(), readPDCalendars(), readSelectedItemCalendars(), and readSingleCalendar().
Here is the call graph for this function:
Here is the caller graph for this function:
|
protected |
Read categories of user.
@access protected
return void
Definition at line 514 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 caller graph for this function:
|
protected |
Read private calendars.
@access protected
Definition at line 739 of file class.ilCalendarCategories.php.
References $id, $ilDB, $ilUser, $in, $query, $res, $row, ilDBConstants\FETCHMODE_OBJECT, ilCalendarSharedStatus\getAcceptedCalendars(), ilCalendarCategory\LTYPE_REMOTE, and ilCalendarCategory\TYPE_USR.
Referenced by readPDCalendars(), readReposCalendars(), readSelectedItemCalendars(), and readSingleCalendar().
Here is the call graph for this function:
Here is the caller graph for this function:
|
protected |
Read public calendars.
@access protected
Definition at line 702 of file class.ilCalendarCategories.php.
References $in, $query, $res, $row, ilCalendarSettings\_getInstance(), ilDBConstants\FETCHMODE_OBJECT, ilCalendarCategory\LTYPE_REMOTE, and ilCalendarCategory\TYPE_GLOBAL.
Referenced by readPDCalendars(), readReposCalendars(), readSelectedItemCalendars(), and readSingleCalendar().
Here is the call graph for this function:
Here is the caller graph for this function:
|
protected |
Read available repository calendars.
@access protected
return
Definition at line 604 of file class.ilCalendarCategories.php.
References $GLOBALS, $ilDB, $res, $row, ilCalendarSettings\_getInstance(), ilParticipants\_getMembershipByType(), ilObject\_lookupType(), addSubitemCalendars(), ilDBConstants\FETCHMODE_OBJECT, readAllConsultationHoursCalendarOfContainer(), readBookingCalendar(), readPrivateCalendars(), readPublicCalendars(), and readSelectedCategories().
Referenced by initialize().
Here is the call graph for this function:
Here is the caller graph for this function:
|
protected |
Read info about selected calendar.
| type | $a_cal_id |
Definition at line 535 of file class.ilCalendarCategories.php.
References addSubitemCalendars(), readSelectedCategories(), and ilCalendarCategory\TYPE_OBJ.
Referenced by initialize(), and readSingleCalendar().
Here is the call graph for this function:
Here is the caller graph for this function:
|
protected |
read selected categories
@access protected
Definition at line 943 of file class.ilCalendarCategories.php.
References $ilDB, $query, $res, $row, ilObject\_getAllReferences(), ilCalendarSettings\_getInstance(), ilObject\_lookupType(), ilDBConstants\FETCHMODE_OBJECT, and ilCalendarCategory\TYPE_OBJ.
Referenced by readPDCalendars(), readReposCalendars(), readSelectedCalendar(), and readSelectedItemCalendars().
Here is the call graph for this function:
Here is the caller graph for this function:
|
protected |
Read categories of selected items.
return
Definition at line 553 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 caller graph for this function:| ilCalendarCategories::readSingleCalendar | ( | $a_cat_id | ) |
Definition at line 669 of file class.ilCalendarCategories.php.
References readBookingCalendar(), readConsultationHoursCalendar(), readPrivateCalendars(), readPublicCalendars(), readSelectedCalendar(), ilCalendarCategory\TYPE_BOOK, ilCalendarCategory\TYPE_CH, ilCalendarCategory\TYPE_GLOBAL, ilCalendarCategory\TYPE_OBJ, and ilCalendarCategory\TYPE_USR.
Referenced by initialize().
Here is the call graph for this function:
Here is the caller graph for this function:| ilCalendarCategories::setCHUserId | ( | $a_user_id | ) |
Set ch user id.
| int | $a_user_id |
Definition at line 214 of file class.ilCalendarCategories.php.
Referenced by readAllConsultationHoursCalendarOfContainer(), and readConsultationHoursCalendar().
Here is the caller graph for this function:
|
protected |
Definition at line 229 of file class.ilCalendarCategories.php.
Referenced by initialize().
Here is the caller graph for this function:| ilCalendarCategories::setSourceRefId | ( | $a_val | ) |
Set source ref id.
| int | $a_val | ref id of current context/source |
Definition at line 254 of file class.ilCalendarCategories.php.
|
protected |
Definition at line 239 of file class.ilCalendarCategories.php.
Referenced by initialize().
Here is the caller graph for this function:
|
protected |
Serialize categories.
Definition at line 185 of file class.ilCalendarCategories.php.
Referenced by initialize().
Here is the caller graph for this function:
|
protected |
Load from serialize string.
| string | serialize categories |
Definition at line 201 of file class.ilCalendarCategories.php.
References $info.
Referenced by initialize().
Here is the caller graph for this function:
|
protected |
Definition at line 55 of file class.ilCalendarCategories.php.
Referenced by readConsultationHoursCalendar().
|
protected |
Definition at line 56 of file class.ilCalendarCategories.php.
|
protected |
Definition at line 63 of file class.ilCalendarCategories.php.
Referenced by getCHUserId().
|
protected |
Definition at line 49 of file class.ilCalendarCategories.php.
|
staticprotected |
Definition at line 47 of file class.ilCalendarCategories.php.
Referenced by _getInstance().
|
protected |
Definition at line 69 of file class.ilCalendarCategories.php.
|
protected |
Definition at line 53 of file class.ilCalendarCategories.php.
Referenced by getMode().
|
protected |
Definition at line 60 of file class.ilCalendarCategories.php.
|
protected |
Definition at line 59 of file class.ilCalendarCategories.php.
Referenced by getSourceRefId().
|
protected |
Definition at line 57 of file class.ilCalendarCategories.php.
|
protected |
Definition at line 64 of file class.ilCalendarCategories.php.
Referenced by getTargetRefId().
|
protected |
Definition at line 51 of file class.ilCalendarCategories.php.
Referenced by readBookingCalendar().
| const ilCalendarCategories::MODE_CONSULTATION = 7 |
Definition at line 41 of file class.ilCalendarCategories.php.
Referenced by ilCalendarSchedule\__construct(), and initialize().
| const ilCalendarCategories::MODE_MANAGE = 6 |
Definition at line 40 of file class.ilCalendarCategories.php.
Referenced by initialize().
| const ilCalendarCategories::MODE_PERSONAL_DESKTOP_ITEMS = 5 |
Definition at line 39 of file class.ilCalendarCategories.php.
Referenced by ilCalendarPresentationGUI\__construct(), ilPDCalendarBlockGUI\initCategories(), initialize(), and ilCalendarBlockGUI\showCalendarSubscription().
| const ilCalendarCategories::MODE_PERSONAL_DESKTOP_MEMBERSHIP = 4 |
Definition at line 38 of file class.ilCalendarCategories.php.
Referenced by ilCalendarPresentationGUI\__construct(), ilCalendarSchedule\__construct(), ilPDCalendarBlockGUI\initCategories(), initialize(), and ilCalendarBlockGUI\showCalendarSubscription().
| const ilCalendarCategories::MODE_PORTFOLIO_CONSULTATION = 8 |
Definition at line 42 of file class.ilCalendarCategories.php.
Referenced by ilCalendarSchedule\__construct(), ilAppointmentPresentationConsultationHoursGUI\collectPropertiesAndActions(), ilPortfolioPageGUI\executeCommand(), ilCalendarAppointmentPanelGUI\getHTML(), initialize(), ilCalendarScheduleFilterBookings\modifyEvent(), and ilPortfolioPageGUI\renderConsultationHours().
| const ilCalendarCategories::MODE_REMOTE_ACCESS = 3 |
Definition at line 37 of file class.ilCalendarCategories.php.
Referenced by ilCalendarRemoteAccessHandler\handleRequest(), and initialize().
| const ilCalendarCategories::MODE_REMOTE_SELECTED = 9 |
Definition at line 43 of file class.ilCalendarCategories.php.
Referenced by ilCalendarRemoteAccessHandler\handleRequest(), and initialize().
| const ilCalendarCategories::MODE_REPOSITORY = 2 |
Definition at line 36 of file class.ilCalendarCategories.php.
Referenced by ilCalendarPresentationGUI\__construct(), ilCalendarBlockGUI\getHTML(), ilCalendarBlockGUI\initCategories(), and initialize().
| const ilCalendarCategories::MODE_REPOSITORY_CONTAINER_ONLY = 10 |
Definition at line 44 of file class.ilCalendarCategories.php.
Referenced by ilCalendarBlockGUI\initCategories(), and initialize().
| const ilCalendarCategories::MODE_SINGLE_CALENDAR = 11 |
Definition at line 45 of file class.ilCalendarCategories.php.
Referenced by ilCalendarPresentationGUI\__construct(), and initialize().