ILIAS
release_5-3 Revision v5.3.23-19-g915713cf615
|
Represents a list of calendar appointments (including recurring events) for a specific user in a given time range. More...
Public Member Functions | |
__construct (ilDate $seed, $a_type, $a_user_id=0, $a_strict_period=false) | |
Constructor. More... | |
getEventsLimit () | |
get current limit of events More... | |
setEventsLimit ($a_limit) | |
Set events limit. More... | |
addSubitemCalendars ($a_status) | |
Enable subitem calendars (session calendars for courses) More... | |
enabledSubitemCalendars () | |
Are subitem calendars enabled. More... | |
addFilter (ilCalendarScheduleFilter $a_filter) | |
Add filter. More... | |
getByDay (ilDate $a_start, $a_timezone) | |
get byday More... | |
calculate () | |
calculate More... | |
getScheduledEvents () | |
getChangedEvents ($a_include_subitem_calendars=false) | |
get new/changed events More... | |
getEvents () | |
Read events (will be moved to another class, since only active and/or visible calendars are shown) More... | |
setPeriod (ilDate $a_start, ilDate $a_end) | |
Set period. More... | |
Data Fields | |
const | TYPE_DAY = 1 |
const | TYPE_WEEK = 2 |
const | TYPE_MONTH = 3 |
const | TYPE_INBOX = 4 |
const | TYPE_HALF_YEAR = 6 |
const | TYPE_PD_UPCOMING = 5 |
Protected Member Functions | |
areEventsLimited () | |
Check if events are limited. More... | |
filterCategories (array $a_cats) | |
modifyEventByFilters (ilCalendarEntry $event) | |
addCustomEvents (ilDate $start, ilDate $end, array $categories) | |
initPeriod (ilDate $seed) | |
init period of events More... | |
Protected Attributes | |
$limit_events = -1 | |
$schedule = array() | |
$timezone | |
$weekstart | |
$type = 0 | |
$subitems_enabled = false | |
$start = null | |
$end = null | |
$user = null | |
$user_settings = null | |
$db = null | |
$filters = array() | |
$strict_period | |
Represents a list of calendar appointments (including recurring events) for a specific user in a given time range.
Definition at line 36 of file class.ilCalendarSchedule.php.
ilCalendarSchedule::__construct | ( | ilDate | $seed, |
$a_type, | |||
$a_user_id = 0 , |
|||
$a_strict_period = false |
|||
) |
Constructor.
public
ilDate | seed date |
int | type of schedule (TYPE_DAY,TYPE_WEEK or TYPE_MONTH) |
int | user_id |
bool | strict_period true if no extra days needed. |
Definition at line 77 of file class.ilCalendarSchedule.php.
References $a_type, $ilDB, $ilUser, ilCalendarCategories\_getInstance(), ilCalendarUserSettings\_getInstanceByUserId(), addFilter(), initPeriod(), ilCalendarCategories\MODE_CONSULTATION, ilCalendarCategories\MODE_PERSONAL_DESKTOP_MEMBERSHIP, ilCalendarCategories\MODE_PORTFOLIO_CONSULTATION, timezone, and user().
Definition at line 371 of file class.ilCalendarSchedule.php.
References array.
Referenced by getChangedEvents(), and getEvents().
ilCalendarSchedule::addFilter | ( | ilCalendarScheduleFilter | $a_filter | ) |
Add filter.
ilCalendarScheduleFilter | $a_filter |
Definition at line 177 of file class.ilCalendarSchedule.php.
Referenced by __construct().
ilCalendarSchedule::addSubitemCalendars | ( | $a_status | ) |
Enable subitem calendars (session calendars for courses)
Definition at line 158 of file class.ilCalendarSchedule.php.
|
protected |
Check if events are limited.
Definition at line 130 of file class.ilCalendarSchedule.php.
Referenced by calculate().
ilCalendarSchedule::calculate | ( | ) |
calculate
protected
Definition at line 237 of file class.ilCalendarSchedule.php.
References $counter, ilCalendarCategoryAssignments\_getAppointmentCalendars(), ilCalendarRecurrences\_getRecurrences(), areEventsLimited(), array, getEvents(), getEventsLimit(), IL_CAL_FKT_GETDATE, IL_CAL_UNIX, ilUtil\sortArray(), time, and timezone.
ilCalendarSchedule::enabledSubitemCalendars | ( | ) |
Are subitem calendars enabled.
Definition at line 167 of file class.ilCalendarSchedule.php.
References $subitems_enabled.
Referenced by getEvents().
|
protected |
Definition at line 343 of file class.ilCalendarSchedule.php.
Referenced by getChangedEvents(), and getEvents().
ilCalendarSchedule::getByDay | ( | ilDate | $a_start, |
$a_timezone | |||
) |
get byday
public
ilDate | start |
Definition at line 189 of file class.ilCalendarSchedule.php.
References $counter, $schedule, $start, $timezone, array, ilDateTime\DAY, ilDate\get(), ilDateTime\get(), IL_CAL_DATETIME, IL_CAL_UNIX, ilDateTime\increment(), and timezone.
ilCalendarSchedule::getChangedEvents | ( | $a_include_subitem_calendars = false | ) |
get new/changed events
bool | $a_include_subitem_calendars | E.g include session calendars of courses. |
Definition at line 391 of file class.ilCalendarSchedule.php.
References $ilDB, $query, $res, $row, $start, ilCalendarCategories\_getInstance(), addCustomEvents(), array, date, ilDBConstants\FETCHMODE_OBJECT, filterCategories(), IL_CAL_DATE, IL_CAL_DATETIME, IL_CAL_MONTH, modifyEventByFilters(), time, and user().
ilCalendarSchedule::getEvents | ( | ) |
Read events (will be moved to another class, since only active and/or visible calendars are shown)
protected
Definition at line 434 of file class.ilCalendarSchedule.php.
References $ilDB, $query, $res, $row, ilCalendarCategories\_getInstance(), addCustomEvents(), array, enabledSubitemCalendars(), ilDBConstants\FETCHMODE_OBJECT, filterCategories(), IL_CAL_DATETIME, IL_CAL_UNIX, modifyEventByFilters(), and user().
Referenced by calculate().
ilCalendarSchedule::getEventsLimit | ( | ) |
get current limit of events
Definition at line 139 of file class.ilCalendarSchedule.php.
References $limit_events.
Referenced by calculate().
ilCalendarSchedule::getScheduledEvents | ( | ) |
|
protected |
init period of events
protected
ilDate | seed |
Definition at line 490 of file class.ilCalendarSchedule.php.
References $start, ilCalendarUtil\_getMaxDayOfMonth(), IL_CAL_DATE, IL_CAL_DAY, IL_CAL_FKT_DATE, IL_CAL_FKT_GETDATE, IL_CAL_MONTH, IL_CAL_WEEK, and ilDateTime\increment().
Referenced by __construct().
|
protected |
Definition at line 358 of file class.ilCalendarSchedule.php.
References $res, and ilLoggerFactory\getLogger().
Referenced by getChangedEvents(), and getEvents().
ilCalendarSchedule::setEventsLimit | ( | $a_limit | ) |
Set events limit.
type | $a_limit |
Definition at line 148 of file class.ilCalendarSchedule.php.
|
protected |
Definition at line 59 of file class.ilCalendarSchedule.php.
|
protected |
Definition at line 56 of file class.ilCalendarSchedule.php.
|
protected |
Definition at line 60 of file class.ilCalendarSchedule.php.
|
protected |
Definition at line 47 of file class.ilCalendarSchedule.php.
Referenced by getEventsLimit().
|
protected |
Definition at line 48 of file class.ilCalendarSchedule.php.
Referenced by getByDay(), and getScheduledEvents().
|
protected |
Definition at line 55 of file class.ilCalendarSchedule.php.
Referenced by getByDay(), getChangedEvents(), and initPeriod().
|
protected |
Definition at line 65 of file class.ilCalendarSchedule.php.
|
protected |
Definition at line 53 of file class.ilCalendarSchedule.php.
Referenced by enabledSubitemCalendars().
|
protected |
Definition at line 49 of file class.ilCalendarSchedule.php.
Referenced by getByDay().
|
protected |
Definition at line 51 of file class.ilCalendarSchedule.php.
|
protected |
Definition at line 57 of file class.ilCalendarSchedule.php.
|
protected |
Definition at line 58 of file class.ilCalendarSchedule.php.
|
protected |
Definition at line 50 of file class.ilCalendarSchedule.php.
const ilCalendarSchedule::TYPE_DAY = 1 |
Definition at line 38 of file class.ilCalendarSchedule.php.
Referenced by ilCalendarDayGUI\executeCommand(), and ilCalendarViewGUI\getEvents().
const ilCalendarSchedule::TYPE_HALF_YEAR = 6 |
Definition at line 42 of file class.ilCalendarSchedule.php.
Referenced by ilCalendarViewGUI\getEvents().
const ilCalendarSchedule::TYPE_INBOX = 4 |
Definition at line 41 of file class.ilCalendarSchedule.php.
Referenced by ilCalendarBlockGUI\getOverview().
const ilCalendarSchedule::TYPE_MONTH = 3 |
Definition at line 40 of file class.ilCalendarSchedule.php.
Referenced by ilMiniCalendarGUI\addMiniMonth(), ilCalendarBlockGUI\addMiniMonth(), ilCalendarMonthGUI\addScheduleFilter(), and ilCalendarViewGUI\getEvents().
const ilCalendarSchedule::TYPE_PD_UPCOMING = 5 |
Definition at line 45 of file class.ilCalendarSchedule.php.
Referenced by ilCalendarBlockGUI\getEvents().
const ilCalendarSchedule::TYPE_WEEK = 2 |
Definition at line 39 of file class.ilCalendarSchedule.php.
Referenced by ilCalendarViewGUI\getEvents(), and ilCalendarWeekGUI\show().