| 
    ILIAS
    release_9 Revision v9.13-25-g2c18ec4c24f
    
   | 
  
Stores calendar categories. More...
 Collaboration diagram for ilCalendarCategory:Public Member Functions | |
| __construct (int $a_cat_id=0) | |
| getCategoryID () | |
| setTitle (string $a_title) | |
| getTitle () | |
| setColor (string $a_color) | |
| getColor () | |
| setType (int $a_type) | |
| getType () | |
| setObjId (int $a_obj_id) | |
| getObjId () | |
| getObjType () | |
| getLocationType () | |
| setLocationType (int $a_type) | |
| setRemoteUrl (string $a_url) | |
| getRemoteUrl () | |
| setRemoteUser (string $a_user) | |
| getRemoteUser () | |
| setRemotePass (string $a_pass) | |
| getRemotePass () | |
| setRemoteSyncLastExecution (ilDateTime $dt) | |
| Set remote sync last execution.  More... | |
| getRemoteSyncLastExecution () | |
| Get last execution date of remote sync.  More... | |
| add () | |
| update () | |
| delete () | |
| validate () | |
Static Public Member Functions | |
| static | _getInstanceByObjId (int $a_obj_id) | 
| get instance by obj_id  More... | |
| static | getInstanceByCategoryId (int $a_cat_id) | 
| static | lookupCategorySortIndex (int $a_type_id) | 
| Lookup sort index of calendar type.  More... | |
| static | lookupAppointments (int $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_UNDEFINED = 0 | 
| const | TYPE_USR = 1 | 
| const | TYPE_OBJ = 2 | 
| const | TYPE_GLOBAL = 3 | 
| const | TYPE_CH = 4 | 
| const | TYPE_BOOK = 5 | 
Protected Attributes | |
| int | $cat_id = 0 | 
| string | $color = '' | 
| int | $type = self::TYPE_USR | 
| int | $obj_id = 0 | 
| string | $obj_type = '' | 
| string | $title = '' | 
| int | $location = self::LTYPE_LOCAL | 
| string | $remote_url = '' | 
| string | $remote_user = '' | 
| string | $remote_pass = '' | 
| ilDateTime | $remote_sync = null | 
| ilDBInterface | $db | 
Static Protected Attributes | |
| static array | $SORTED_TYPES | 
Private Member Functions | |
| read () | |
Static Private Attributes | |
| static array | $instances = [] | 
Stores calendar categories.
Definition at line 26 of file class.ilCalendarCategory.php.
| ilCalendarCategory::__construct | ( | int | $a_cat_id = 0 | ) | 
Definition at line 65 of file class.ilCalendarCategory.php.
 Here is the call graph for this function:
      
  | 
  static | 
get instance by obj_id
Definition at line 78 of file class.ilCalendarCategory.php.
References $DIC, $ilDB, $res, and ilDBConstants\FETCHMODE_OBJECT.
Referenced by ilCalendarPresentationGUI\__construct(), ilCalendarPresentationGUI\addStandardTabs(), ilCalendarAppEventListener\createCategory(), ilCalendarSubscriptionGUI\getModalForSubscription(), ilCalendarSubscriptionGUI\show(), and ilCalendarAppEventListener\updateCategory().
 Here is the caller graph for this function:| ilCalendarCategory::add | ( | ) | 
Definition at line 237 of file class.ilCalendarCategory.php.
References $cat_id, getColor(), getLocationType(), getObjId(), getRemotePass(), getRemoteSyncLastExecution(), getRemoteUrl(), getRemoteUser(), getTitle(), getType(), IL_CAL_DATETIME, and ilTimeZone\UTC.
 Here is the call graph for this function:| ilCalendarCategory::delete | ( | ) | 
Definition at line 291 of file class.ilCalendarCategory.php.
References $res, ilCalendarEntry\_delete(), ilCalendarCategoryAssignments\_deleteByCategoryId(), ilCalendarVisibility\_deleteCategories(), and ilCalendarCategoryAssignments\_getAssignedAppointments().
 Here is the call graph for this function:| ilCalendarCategory::getCategoryID | ( | ) | 
Definition at line 128 of file class.ilCalendarCategory.php.
References $cat_id.
Referenced by ilCalendarRemoteReader\importIcal(), and read().
 Here is the caller graph for this function:| ilCalendarCategory::getColor | ( | ) | 
Definition at line 148 of file class.ilCalendarCategory.php.
References $color.
Referenced by add(), update(), and validate().
 Here is the caller graph for this function:
      
  | 
  static | 
Definition at line 93 of file class.ilCalendarCategory.php.
Referenced by ilCalendarExport\buildAppointmentUrl(), ilDownloadFilesBackgroundTask\collectFiles(), ilAppointmentBaseFileHandler\getCatInfo(), ilCalendarAppointmentBaseFactory\getClassBaseName(), ilAppointmentFileHandlerFactory\getInstance(), ilCalendarScheduleFilterBookingPool\isBookingPoolCategory(), ilCalendarScheduleFilterTimings\isCourseCategory(), ilCalendarScheduleFilterExercise\isExerciseCategory(), and ilAppointmentPresentationGUI\readObjIdForAppointment().
 Here is the caller graph for this function:| ilCalendarCategory::getLocationType | ( | ) | 
Definition at line 178 of file class.ilCalendarCategory.php.
References $location.
Referenced by add(), update(), and validate().
 Here is the caller graph for this function:| ilCalendarCategory::getObjId | ( | ) | 
| ilCalendarCategory::getObjType | ( | ) | 
| ilCalendarCategory::getRemotePass | ( | ) | 
Definition at line 213 of file class.ilCalendarCategory.php.
References $remote_pass.
Referenced by add(), ilCalendarCategoryGUI\doSynchronisation(), and update().
 Here is the caller graph for this function:| ilCalendarCategory::getRemoteSyncLastExecution | ( | ) | 
Get last execution date of remote sync.
Definition at line 229 of file class.ilCalendarCategory.php.
References $remote_sync.
Referenced by add(), and update().
 Here is the caller graph for this function:| ilCalendarCategory::getRemoteUrl | ( | ) | 
Definition at line 193 of file class.ilCalendarCategory.php.
References $remote_url.
Referenced by add(), ilCalendarCategoryGUI\doSynchronisation(), update(), and validate().
 Here is the caller graph for this function:| ilCalendarCategory::getRemoteUser | ( | ) | 
Definition at line 203 of file class.ilCalendarCategory.php.
References $remote_user.
Referenced by add(), ilCalendarCategoryGUI\doSynchronisation(), and update().
 Here is the caller graph for this function:| ilCalendarCategory::getTitle | ( | ) | 
Definition at line 138 of file class.ilCalendarCategory.php.
References $title.
Referenced by add(), update(), and validate().
 Here is the caller graph for this function:| ilCalendarCategory::getType | ( | ) | 
Definition at line 158 of file class.ilCalendarCategory.php.
References $type.
Referenced by add(), read(), update(), and validate().
 Here is the caller graph for this function:
      
  | 
  static | 
get all assigned appointment ids
Definition at line 113 of file class.ilCalendarCategory.php.
References $DIC, $ilDB, $res, ilDBConstants\FETCHMODE_OBJECT, and ILIAS\Repository\int().
 Here is the call graph for this function:
      
  | 
  static | 
Lookup sort index of calendar type.
Definition at line 104 of file class.ilCalendarCategory.php.
Referenced by ilCalendarSelectionBlockGUI\getCalendars(), and ilCalendarManageTableGUI\parse().
 Here is the caller graph for this function:
      
  | 
  private | 
Definition at line 316 of file class.ilCalendarCategory.php.
References $res, ilObject\_lookupTitle(), ilObject\_lookupType(), ilDBConstants\FETCHMODE_OBJECT, getCategoryID(), getObjId(), getType(), if, IL_CAL_DATETIME, and ILIAS\Repository\int().
Referenced by __construct().
 Here is the call graph for this function:
 Here is the caller graph for this function:| ilCalendarCategory::setColor | ( | string | $a_color | ) | 
Definition at line 143 of file class.ilCalendarCategory.php.
| ilCalendarCategory::setLocationType | ( | int | $a_type | ) | 
Definition at line 183 of file class.ilCalendarCategory.php.
| ilCalendarCategory::setObjId | ( | int | $a_obj_id | ) | 
Definition at line 163 of file class.ilCalendarCategory.php.
| ilCalendarCategory::setRemotePass | ( | string | $a_pass | ) | 
Definition at line 208 of file class.ilCalendarCategory.php.
| ilCalendarCategory::setRemoteSyncLastExecution | ( | ilDateTime | $dt | ) | 
Set remote sync last execution.
Definition at line 221 of file class.ilCalendarCategory.php.
| ilCalendarCategory::setRemoteUrl | ( | string | $a_url | ) | 
Definition at line 188 of file class.ilCalendarCategory.php.
| ilCalendarCategory::setRemoteUser | ( | string | $a_user | ) | 
Definition at line 198 of file class.ilCalendarCategory.php.
| ilCalendarCategory::setTitle | ( | string | $a_title | ) | 
Definition at line 133 of file class.ilCalendarCategory.php.
| ilCalendarCategory::setType | ( | int | $a_type | ) | 
Definition at line 153 of file class.ilCalendarCategory.php.
| ilCalendarCategory::update | ( | ) | 
Definition at line 267 of file class.ilCalendarCategory.php.
References $res, getColor(), getLocationType(), getObjId(), getRemotePass(), getRemoteSyncLastExecution(), getRemoteUrl(), getRemoteUser(), getTitle(), getType(), IL_CAL_DATETIME, and ilTimeZone\UTC.
 Here is the call graph for this function:| ilCalendarCategory::validate | ( | ) | 
Definition at line 305 of file class.ilCalendarCategory.php.
References getColor(), getLocationType(), getRemoteUrl(), getTitle(), getType(), and LTYPE_REMOTE.
 Here is the call graph for this function:
      
  | 
  protected | 
Definition at line 50 of file class.ilCalendarCategory.php.
Referenced by add(), and getCategoryID().
      
  | 
  protected | 
Definition at line 51 of file class.ilCalendarCategory.php.
Referenced by getColor().
      
  | 
  protected | 
Definition at line 63 of file class.ilCalendarCategory.php.
      
  | 
  staticprivate | 
Definition at line 31 of file class.ilCalendarCategory.php.
      
  | 
  protected | 
Definition at line 57 of file class.ilCalendarCategory.php.
Referenced by getLocationType().
      
  | 
  protected | 
Definition at line 53 of file class.ilCalendarCategory.php.
Referenced by getObjId().
      
  | 
  protected | 
Definition at line 54 of file class.ilCalendarCategory.php.
Referenced by getObjType().
      
  | 
  protected | 
Definition at line 60 of file class.ilCalendarCategory.php.
Referenced by getRemotePass().
      
  | 
  protected | 
Definition at line 61 of file class.ilCalendarCategory.php.
Referenced by getRemoteSyncLastExecution().
      
  | 
  protected | 
Definition at line 58 of file class.ilCalendarCategory.php.
Referenced by getRemoteUrl().
      
  | 
  protected | 
Definition at line 59 of file class.ilCalendarCategory.php.
Referenced by getRemoteUser().
      
  | 
  staticprotected | 
Definition at line 42 of file class.ilCalendarCategory.php.
      
  | 
  protected | 
Definition at line 55 of file class.ilCalendarCategory.php.
Referenced by getTitle().
      
  | 
  protected | 
Definition at line 52 of file class.ilCalendarCategory.php.
Referenced by getType().
| const ilCalendarCategory::DEFAULT_COLOR = '#04427e' | 
Definition at line 33 of file class.ilCalendarCategory.php.
Referenced by ilCalendarAppointmentGUI\createDefaultCalendar(), and ilCalendarUtil\initDefaultCalendarByType().
| const ilCalendarCategory::LTYPE_LOCAL = 1 | 
Definition at line 28 of file class.ilCalendarCategory.php.
Referenced by ilCalendarCategoryGUI\initFormCategory().
| const ilCalendarCategory::LTYPE_REMOTE = 2 | 
Definition at line 29 of file class.ilCalendarCategory.php.
Referenced by ilCalendarCategoryGUI\initFormCategory(), ilCalendarCategories\lookupRemoteCalendars(), ilCalendarCategories\prepareCategoriesOfUserForSelection(), ilCalendarCategories\readPrivateCalendars(), ilCalendarCategories\readPublicCalendars(), ilCalendarCategoryGUI\save(), validate(), and ilICalParser\writeEvent().
| const ilCalendarCategory::TYPE_BOOK = 5 | 
Definition at line 40 of file class.ilCalendarCategory.php.
Referenced by ILIAS\BookingManager\BookingProcess\BookingProcessManager\bookSingle(), ilCalendarAppointmentGUI\cancelBooking(), ilCalendarAppointmentGUI\cancelConfirmed(), ilCalendarManageTableGUI\fillRow(), ilBookingReservation\getCalendarEntry(), ilCalendarSelectionBlockGUI\getCalendars(), ilCalendarAppointmentBaseFactory\getClassBaseName(), ilCalendarAppointmentPanelGUI\getHTML(), ilCalendarScheduleFilterBookingPool\isBookingPoolCategory(), ilCalendarPresentationGUI\prepareOutput(), ilCalendarCategories\readBookingCalendar(), ilCalendarCategoryGUI\readPermissions(), ilCalendarCategories\readSingleCalendar(), and ilCalendarSelectionBlockGUI\renderItem().
| const ilCalendarCategory::TYPE_CH = 4 | 
Definition at line 39 of file class.ilCalendarCategory.php.
Referenced by ilConsultationHourUtils\bookAppointment(), ilConsultationHourUtils\cancelBooking(), ilCalendarAppointmentGUI\cancelBooking(), ilCalendarAppointmentGUI\cancelConfirmed(), ilConsultationHoursGUI\createAppointments(), ilCalendarManageTableGUI\fillRow(), ilConsultationHourUtils\findCalendarAppointmentsForBooking(), ilConsultationHourAppointments\getAppointmentIds(), ilConsultationHourAppointments\getAppointmentIdsByGroup(), ilCalendarSelectionBlockGUI\getCalendars(), ilCalendarAppointmentBaseFactory\getClassBaseName(), ilCalendarAppointmentPanelGUI\getHTML(), ilCalendarPresentationGUI\initAndRedirectToConsultationHours(), ilBookingEntry\lookupBookableUsersForObject(), ilCalendarScheduleFilterConsultationHourInRepository\modifyEvent(), ilCalendarPresentationGUI\prepareOutput(), ilCalendarCategories\readConsultationHoursCalendar(), ilCalendarCategoryGUI\readPermissions(), ilCalendarCategories\readSingleCalendar(), ilBookingEntry\removeObsoleteEntries(), ilCalendarSelectionBlockGUI\renderItem(), and ilCalendarAppointmentsTableGUI\setAppointments().
| const ilCalendarCategory::TYPE_GLOBAL = 3 | 
Definition at line 38 of file class.ilCalendarCategory.php.
Referenced by ilCalendarActions\checkDeleteCal(), ilCalendarManageTableGUI\fillRow(), ilAppointmentBaseFileHandler\getCatInfo(), ilCalendarAppointmentBaseFactory\getClassBaseName(), ilCalendarAppointmentPanelGUI\getHTML(), ilCalendarCategoryGUI\initFormCategory(), ilCalendarPresentationGUI\prepareOutput(), ilCalendarCategoryGUI\readPermissions(), ilCalendarCategories\readPublicCalendars(), ilCalendarCategories\readSingleCalendar(), ilCalendarSelectionBlockGUI\renderItem(), and ilCalendarCategoryGUI\save().
| const ilCalendarCategory::TYPE_OBJ = 2 | 
Definition at line 37 of file class.ilCalendarCategory.php.
Referenced by ilCalendarCategories\_lookupCategoryIdByObjId(), ilCalendarExport\buildAppointmentUrl(), ilDownloadFilesBackgroundTask\collectFiles(), ilCalendarAppEventListener\createCategory(), ilCalendarAppointmentGUI\distributeNotifications(), ilCalendarManageTableGUI\fillRow(), ilCalendarSelectionBlockGUI\getCalendars(), ilAppointmentBaseFileHandler\getCatInfo(), ilCalendarAppointmentBaseFactory\getClassBaseName(), ilCalendarAppointmentPanelGUI\getHTML(), ilCalendarCategories\getNotificationCalendars(), ilCalendarAppointmentGUI\initForm(), ilCalendarCategoryGUI\initFormCategory(), ilCalendarScheduleFilterTimings\isCourseCategory(), ilCalendarScheduleFilterExercise\isExerciseCategory(), ilCalendarVisibility\isHidden(), ilCalendarManageTableGUI\parse(), ilCalendarPresentationGUI\prepareOutput(), ilCalendarCategoryGUI\readPermissions(), ilCalendarCategories\readSelectedCalendar(), ilCalendarCategories\readSelectedCategories(), ilCalendarCategories\readSingleCalendar(), ilCalendarSelectionBlockGUI\renderItem(), ilCalendarAppointmentGUI\showInfoScreen(), and ilCalendarCategoryGUI\update().
| const ilCalendarCategory::TYPE_UNDEFINED = 0 | 
Definition at line 35 of file class.ilCalendarCategory.php.
| const ilCalendarCategory::TYPE_USR = 1 | 
Definition at line 36 of file class.ilCalendarCategory.php.
Referenced by ilCalendarCategories\_isOwner(), ilCalendarActions\checkDeleteCal(), ilCalendarActions\checkShareCal(), ilCalendarAppointmentGUI\createDefaultCalendar(), ilCalendarManageTableGUI\fillRow(), ilCalendarSelectionBlockGUI\getCalendars(), ilAppointmentBaseFileHandler\getCatInfo(), ilCalendarAppointmentBaseFactory\getClassBaseName(), ilCalendarAppointmentPanelGUI\getHTML(), ilCalendarDataSet\importRecord(), ilCalendarCategoryGUI\initFormCategory(), ilCalendarCategories\lookupPrivateCategories(), ilCalendarCategories\prepareCategoriesOfUserForSelection(), ilCalendarPresentationGUI\prepareOutput(), ilCalendarCategoryGUI\readPermissions(), ilCalendarCategories\readPrivateCalendars(), ilCalendarCategories\readSingleCalendar(), ilCalendarSelectionBlockGUI\renderItem(), and ilCalendarCategoryGUI\save().