ILIAS
release_5-4 Revision v5.4.26-12-gabc799a52e6
|
class for calendar categories More...
Public Member Functions | |
__construct ($a_usr_id=0) | |
Singleton instance. More... | |
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) | |
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 | |
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.
ilCalendarCategories::__construct | ( | $a_usr_id = 0 | ) |
Singleton instance.
protected
int | $a_usr_id | user id |
Definition at line 78 of file class.ilCalendarCategories.php.
References $DIC, $GLOBALS, $ilDB, and $ilUser.
|
static |
get singleton instance
public
int | $a_usr_id | user id |
Definition at line 102 of file class.ilCalendarCategories.php.
Referenced by ilCalendarScheduleFilterHidden\__construct(), ilCalendarScheduleFilterBookings\__construct(), ilCalendarScheduleFilterBookingPool\__construct(), ilCalendarActions\__construct(), ilCalendarAppointmentsTableGUI\__construct(), ilCalendarChangedAppointmentsTableGUI\__construct(), ilCalendarPresentationGUI\__construct(), ilCalendarSchedule\__construct(), ilCalendarAppointmentColors\__construct(), ilCalendarMonthGUI\addScheduleFilter(), ilAppointmentPresentationConsultationHoursGUI\collectPropertiesAndActions(), ilCalendarAppointmentGUI\distributeNotifications(), ilCalendarAppointmentGUI\edit(), ilCalendarAppointmentGUI\editResponsibleUsers(), ilPortfolioPageGUI\executeCommand(), ilCalendarScheduleFilterHidden\filterCategories(), ilAppointmentPresentationGUI\getCatInfo(), ilCalendarSchedule\getChangedEvents(), ilCalendarSchedule\getEvents(), ilCalendarAppointmentPanelGUI\getHTML(), ilCalendarAgendaListGUI\getHTML(), ilCalendarRemoteAccessHandler\handleRequest(), ilPDCalendarBlockGUI\initCategories(), ilCalendarBlockGUI\initCategories(), ilCalendarAppointmentGUI\initForm(), ilCalendarCategoryGUI\initFormCategory(), ilCalendarCategoryTableGUI\parse(), ilCalendarManageTableGUI\parse(), ilPortfolioPageGUI\renderConsultationHours(), ilCalendarAppointmentGUI\save(), ilCalendarCategoryGUI\saveSelection(), ilCalendarCategoryGUI\showAssignedAppointments(), ilCalendarAppointmentGUI\showInfoScreen(), and ilCalendarPresentationGUI\synchroniseExternalCalendars().
|
static |
check if user is owner of a category
public
int | usr_id |
int | cal_id |
Definition at line 145 of file class.ilCalendarCategories.php.
References $DIC, $ilDB, $query, $res, and ilCalendarCategory\TYPE_USR.
Referenced by ilCalendarShared\getSharedCalendarsForUser().
|
static |
lookup category by obj_id
public
int | obj_id |
Definition at line 118 of file class.ilCalendarCategories.php.
References $DIC, $ilDB, $query, $res, $row, ilDBConstants\FETCHMODE_OBJECT, and ilCalendarCategory\TYPE_OBJ.
Referenced by ilCalendarAppEventListener\createAppointments(), ilCalendarAppEventListener\deleteCategory(), and ilCalendarAppointmentGUI\initForm().
|
protected |
Add subitem calendars E.g.
session calendars in courses, groups
Definition at line 1043 of file class.ilCalendarCategories.php.
References $DIC, $ilDB, $query, $res, $row, and ilDBConstants\FETCHMODE_OBJECT.
Referenced by readPDCalendars(), readReposCalendars(), readSelectedCalendar(), and readSelectedItemCalendars().
|
static |
Delete cache (add remove desktop item)
object | $a_usr_id |
Definition at line 164 of file class.ilCalendarCategories.php.
References ilCalendarCache\getInstance().
Referenced by ilObjUser\_addDesktopItem(), ilObjUser\_dropDesktopItem(), and ilCalendarAppEventListener\handleEvent().
|
static |
Delete cache.
object | $a_usr_id |
Definition at line 178 of file class.ilCalendarCategories.php.
References ilCalendarCache\getInstance().
Referenced by ilCalendarAppEventListener\handleEvent().
ilCalendarCategories::getCategories | ( | $a_include_subitem_calendars = false | ) |
get categories
$a_include_subitems | include subitem calendars public |
Definition at line 413 of file class.ilCalendarCategories.php.
ilCalendarCategories::getCategoriesInfo | ( | ) |
ilCalendarCategories::getCategoryInfo | ( | $a_cat_id | ) |
ilCalendarCategories::getCHUserId | ( | ) |
Get ch user id.
Definition at line 231 of file class.ilCalendarCategories.php.
References $ch_user_id.
Referenced by readAllConsultationHoursCalendarOfContainer(), and readConsultationHoursCalendar().
ilCalendarCategories::getMode | ( | ) |
Definition at line 241 of file class.ilCalendarCategories.php.
References $mode.
Referenced by initialize().
ilCalendarCategories::getNotificationCalendars | ( | ) |
Get all calendars that allow send of notifications (Editable and course group calendars)
Definition at line 475 of file class.ilCalendarCategories.php.
References $info, ilObject\_lookupType(), and ilCalendarCategory\TYPE_OBJ.
ilCalendarCategories::getSourceRefId | ( | ) |
Get source ref id.
Definition at line 271 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 428 of file class.ilCalendarCategories.php.
ilCalendarCategories::getTargetRefId | ( | ) |
ilCalendarCategories::initialize | ( | $a_mode, | |
$a_source_ref_id = 0 , |
|||
$a_use_cache = false , |
|||
$a_cat_id = 0 |
|||
) |
initialize visible categories
public
int | mode |
int | ref_id of root node |
Definition at line 284 of file class.ilCalendarCategories.php.
References ilCalendarUserSettings\_getInstance(), ilObject\_lookupObjId(), ilCalendarUserSettings\CAL_SELECTION_MEMBERSHIP, ilCalendarCache\getInstance(), getMode(), readConsultationHoursCalendar(), readPDCalendars(), readReposCalendars(), readSelectedCalendar(), readSelectedItemCalendars(), readSingleCalendar(), setMode(), setTargetRefId(), sleep(), and wakeup().
Referenced by ilCalendarSelectionBlockGUI\getCalendars().
ilCalendarCategories::isEditable | ( | $a_cat_id | ) |
check if category is editable
public
int | $a_cat_id | category id |
Definition at line 495 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 507 of file class.ilCalendarCategories.php.
|
static |
Lookup private categories of user.
Definition at line 1107 of file class.ilCalendarCategories.php.
References $DIC, $ilDB, and ilCalendarCategory\TYPE_USR.
Referenced by ilUserExporter\getXmlExportTailDependencies().
ilCalendarCategories::prepareCategoriesOfUserForSelection | ( | ) |
prepare categories of users for selection
public
int | user id |
Definition at line 444 of file class.ilCalendarCategories.php.
References $DIC, $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 838 of file class.ilCalendarCategories.php.
References $user, $users, ilCourseParticipants\_getInstanceByObjId(), ilObject\_lookupObjId(), getCHUserId(), ilBookingEntry\lookupBookableUsersForObject(), readConsultationHoursCalendar(), and setCHUserId().
Referenced by readReposCalendars().
ilCalendarCategories::readBookingCalendar | ( | $user_id = null | ) |
Read booking manager calendar.
int | $user_id |
Definition at line 940 of file class.ilCalendarCategories.php.
References $DIC, $ilDB, $query, $res, $row, $user_id, ilDBConstants\FETCHMODE_OBJECT, and ilCalendarCategory\TYPE_BOOK.
Referenced by readPDCalendars(), readReposCalendars(), readSelectedItemCalendars(), and readSingleCalendar().
ilCalendarCategories::readConsultationHoursCalendar | ( | $a_target_ref_id = null , |
|
$a_cat_id = 0 |
|||
) |
Read personal consultation hours calendar.
int | $user_id |
Definition at line 859 of file class.ilCalendarCategories.php.
References $categories, $DIC, $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().
|
protected |
Read categories of user.
protected
Definition at line 523 of file class.ilCalendarCategories.php.
References $DIC, ilParticipants\_getMembershipByType(), addSubitemCalendars(), readBookingCalendar(), readConsultationHoursCalendar(), readPrivateCalendars(), readPublicCalendars(), and readSelectedCategories().
Referenced by initialize().
|
protected |
Read private calendars.
protected
Definition at line 761 of file class.ilCalendarCategories.php.
References $DIC, $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().
|
protected |
Read public calendars.
protected
Definition at line 721 of file class.ilCalendarCategories.php.
References $DIC, $in, $query, $res, $row, ilCalendarSettings\_getInstance(), ilDBConstants\FETCHMODE_OBJECT, ilCalendarCategory\LTYPE_REMOTE, and ilCalendarCategory\TYPE_GLOBAL.
Referenced by readPDCalendars(), readReposCalendars(), readSelectedItemCalendars(), and readSingleCalendar().
|
protected |
Read available repository calendars.
protected
Definition at line 618 of file class.ilCalendarCategories.php.
References $DIC, $GLOBALS, $ilDB, $res, $row, $tree, ilCalendarSettings\_getInstance(), ilParticipants\_getMembershipByType(), ilObject\_lookupType(), addSubitemCalendars(), ilDBConstants\FETCHMODE_OBJECT, readAllConsultationHoursCalendarOfContainer(), readBookingCalendar(), readPrivateCalendars(), readPublicCalendars(), and readSelectedCategories().
Referenced by initialize().
|
protected |
Read info about selected calendar.
type | $a_cal_id |
Definition at line 546 of file class.ilCalendarCategories.php.
References addSubitemCalendars(), readSelectedCategories(), and ilCalendarCategory\TYPE_OBJ.
Referenced by initialize(), and readSingleCalendar().
|
protected |
read selected categories
protected
Definition at line 974 of file class.ilCalendarCategories.php.
References $DIC, $ilDB, $query, $res, $row, $tree, ilObject\_getAllReferences(), ilCalendarSettings\_getInstance(), ilObject\_lookupType(), ilDBConstants\FETCHMODE_OBJECT, and ilCalendarCategory\TYPE_OBJ.
Referenced by readPDCalendars(), readReposCalendars(), readSelectedCalendar(), and readSelectedItemCalendars().
|
protected |
Read categories of selected items.
Definition at line 564 of file class.ilCalendarCategories.php.
References $DIC, $ilUser, ilObjUser\_lookupDesktopItems(), addSubitemCalendars(), readBookingCalendar(), readConsultationHoursCalendar(), readPrivateCalendars(), readPublicCalendars(), and readSelectedCategories().
Referenced by initialize().
ilCalendarCategories::readSingleCalendar | ( | $a_cat_id | ) |
Definition at line 688 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().
ilCalendarCategories::setCHUserId | ( | $a_user_id | ) |
Set ch user id.
int | $a_user_id |
Definition at line 221 of file class.ilCalendarCategories.php.
Referenced by readAllConsultationHoursCalendarOfContainer(), and readConsultationHoursCalendar().
|
protected |
Definition at line 236 of file class.ilCalendarCategories.php.
Referenced by initialize().
ilCalendarCategories::setSourceRefId | ( | $a_val | ) |
Set source ref id.
int | $a_val | ref id of current context/source |
Definition at line 261 of file class.ilCalendarCategories.php.
|
protected |
Definition at line 246 of file class.ilCalendarCategories.php.
Referenced by initialize().
|
protected |
Serialize categories.
Definition at line 192 of file class.ilCalendarCategories.php.
Referenced by initialize().
|
protected |
Load from serialize string.
string | serialize categories |
Definition at line 208 of file class.ilCalendarCategories.php.
References $info.
Referenced by initialize().
|
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.
|
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().
const ilCalendarCategories::MODE_MANAGE = 6 |
Definition at line 40 of file class.ilCalendarCategories.php.
const ilCalendarCategories::MODE_PERSONAL_DESKTOP_ITEMS = 5 |
Definition at line 39 of file class.ilCalendarCategories.php.
Referenced by ilCalendarPresentationGUI\__construct(), ilCalendarSelectionBlockGUI\getCalendars(), ilPDCalendarBlockGUI\initCategories(), 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(), ilCalendarSelectionBlockGUI\getCalendars(), ilPDCalendarBlockGUI\initCategories(), and ilCalendarBlockGUI\showCalendarSubscription().
const ilCalendarCategories::MODE_PORTFOLIO_CONSULTATION = 8 |
Definition at line 42 of file class.ilCalendarCategories.php.
Referenced by ilCalendarSchedule\__construct(), ilCalendarMonthGUI\addScheduleFilter(), ilAppointmentPresentationConsultationHoursGUI\collectPropertiesAndActions(), ilPortfolioPageGUI\executeCommand(), ilCalendarAppointmentPanelGUI\getHTML(), ilCalendarScheduleFilterBookings\modifyEvent(), and ilPortfolioPageGUI\renderConsultationHours().
const ilCalendarCategories::MODE_REMOTE_ACCESS = 3 |
Definition at line 37 of file class.ilCalendarCategories.php.
Referenced by ilCalendarRemoteAccessHandler\handleRequest().
const ilCalendarCategories::MODE_REMOTE_SELECTED = 9 |
Definition at line 43 of file class.ilCalendarCategories.php.
Referenced by ilCalendarRemoteAccessHandler\handleRequest().
const ilCalendarCategories::MODE_REPOSITORY = 2 |
Definition at line 36 of file class.ilCalendarCategories.php.
Referenced by ilCalendarPresentationGUI\__construct(), ilCalendarSelectionBlockGUI\getCalendars(), ilCalendarBlockGUI\getHTML(), and ilCalendarBlockGUI\initCategories().
const ilCalendarCategories::MODE_REPOSITORY_CONTAINER_ONLY = 10 |
Definition at line 44 of file class.ilCalendarCategories.php.
Referenced by ilCalendarBlockGUI\initCategories().
const ilCalendarCategories::MODE_SINGLE_CALENDAR = 11 |
Definition at line 45 of file class.ilCalendarCategories.php.
Referenced by ilCalendarPresentationGUI\__construct().