Represents a list of calendar appointments (including recurring events) for a specific user in a given time range. More...

Collaboration diagram for ilCalendarSchedule:

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

	$logger

Detailed Description

Represents a list of calendar appointments (including recurring events) for a specific user in a given time range.

Author: Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

Definition at line 36 of file class.ilCalendarSchedule.php.

Constructor & Destructor Documentation

◆ __construct()

ilCalendarSchedule::__construct	(	ilDate	$seed,
			$a_type,
			$a_user_id = `0`,
			$a_strict_period = `false`
	)

Constructor.

public

Parameters

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 82 of file class.ilCalendarSchedule.php.

References $DIC, $ilDB, $ilUser, ilCalendarCategories\_getInstance(), ilCalendarUserSettings\_getInstanceByUserId(), addFilter(), initPeriod(), ilCalendarCategories\MODE_CONSULTATION, ilCalendarCategories\MODE_PERSONAL_DESKTOP_MEMBERSHIP, ilCalendarCategories\MODE_PORTFOLIO_CONSULTATION, ilCalendarCategories\MODE_REPOSITORY, and user().

     {
         global $DIC;
 
         $ilUser = $DIC['ilUser'];
         $ilDB = $DIC['ilDB'];
 
         $this->logger = $DIC->logger()->cal();
         
         $this->db = $ilDB;
 
         $this->type = $a_type;
 
         //this strict period is just to avoid possible side effects.
         //I there are none, we can get rid of this strict period control and remove it from the constructor
         //and from the calls in ilCalendarView getEvents.
         $this->strict_period = $a_strict_period;
 
         if (!$a_user_id || $a_user_id == $ilUser->getId()) {
             $this->user = $ilUser;
         } else {
             $this->user = new ilObjUser($a_user_id);
         }
         $this->user_settings = ilCalendarUserSettings::_getInstanceByUserId($this->user->getId());
         $this->weekstart = $this->user_settings->getWeekStart();
         $this->timezone = $this->user->getTimeZone();
 
         $this->initPeriod($seed);
                         
         
         // category / event filters
 
         // portfolio does custom filter handling (booking group ids)
         if (ilCalendarCategories::_getInstance()->getMode() != ilCalendarCategories::MODE_PORTFOLIO_CONSULTATION) {
             // consultation hour calendar views do not mind calendar category visibility
             if (ilCalendarCategories::_getInstance()->getMode() != ilCalendarCategories::MODE_CONSULTATION) {
                 // this is the "default" filter which handles currently hidden categories for the user
                 $this->addFilter(new ilCalendarScheduleFilterHidden($this->user->getId()));
             } else {
                 // handle booking visibility (target object, booked out)
                 //this filter deals with consultation hours
                 $this->addFilter(new ilCalendarScheduleFilterBookings($this->user->getId()));
             }
 
             if (ilCalendarCategories::_getInstance()->getMode() === ilCalendarCategories::MODE_PERSONAL_DESKTOP_MEMBERSHIP) {
                 //this filter deals with booking pool reservations
                 $this->addFilter(new ilCalendarScheduleFilterBookingPool($this->user->getId()));
             }
 
             if (ilCalendarCategories::_getInstance()->getMode() === ilCalendarCategories::MODE_REPOSITORY) {
                 $this->addFilter(new ilCalendarScheduleFilterConsultationHourInRepository());
             }
 
             $this->addFilter(new ilCalendarScheduleFilterExercise($this->user->getId()));
             $this->addFilter(new ilCalendarScheduleFilterTimings($this->user->getId()));
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ addCustomEvents()

ilCalendarSchedule::addCustomEvents	(	ilDate	$start,
		ilDate	$end,
		array	$categories
	)

protected

Definition at line 387 of file class.ilCalendarSchedule.php.

Referenced by getChangedEvents(), and getEvents().

     {
         $new_events = array();
         foreach ($this->filters as $filter) {
             $events_by_filter = $filter->addCustomEvents($start, $end, $categories);
             if ($events_by_filter) {
                 $new_events = array_merge($new_events, $events_by_filter);
             }
         }
         return $new_events;
     }

Here is the caller graph for this function:

◆ addFilter()

ilCalendarSchedule::addFilter ( ilCalendarScheduleFilter $a_filter )

Add filter.

Parameters

ilCalendarScheduleFilter $a_filter

Definition at line 191 of file class.ilCalendarSchedule.php.

Referenced by __construct().

     {
         $this->filters[] = $a_filter;
     }

Here is the caller graph for this function:

◆ addSubitemCalendars()

ilCalendarSchedule::addSubitemCalendars ( $a_status )

Enable subitem calendars (session calendars for courses)

Parameters

Definition at line 172 of file class.ilCalendarSchedule.php.

     {
         $this->subitems_enabled = $a_status;
     }

◆ areEventsLimited()

ilCalendarSchedule::areEventsLimited ( )

protected

Check if events are limited.

Returns: type

Definition at line 144 of file class.ilCalendarSchedule.php.

Referenced by calculate().

     {
         return $this->limit_events != -1;
     }

Here is the caller graph for this function:

◆ calculate()

ilCalendarSchedule::calculate ( )

calculate

protected

Definition at line 253 of file class.ilCalendarSchedule.php.

References ilCalendarCategoryAssignments\_getAppointmentCalendars(), ilCalendarRecurrences\_getRecurrences(), areEventsLimited(), getEvents(), getEventsLimit(), IL_CAL_FKT_GETDATE, IL_CAL_UNIX, and ilUtil\sortArray().

     {
         $events = $this->getEvents();
 
         // we need category type for booking handling
         $ids = array();
         foreach ($events as $event) {
             $ids[] = $event->getEntryId();
         }
         
         include_once('Services/Calendar/classes/class.ilCalendarCategoryAssignments.php');
         $cat_map = ilCalendarCategoryAssignments::_getAppointmentCalendars($ids);
         include_once('Services/Calendar/classes/class.ilCalendarCategory.php');
         $cat_types = array();
         foreach (array_unique($cat_map) as $cat_id) {
             $cat = new ilCalendarCategory($cat_id);
             $cat_types[$cat_id] = $cat->getType();
         }
         
         $counter = 0;
         foreach ($events as $event) {
             // Calculdate recurring events
             include_once('Services/Calendar/classes/class.ilCalendarRecurrences.php');
             if ($recs = ilCalendarRecurrences::_getRecurrences($event->getEntryId())) {
                 $duration = $event->getEnd()->get(IL_CAL_UNIX) - $event->getStart()->get(IL_CAL_UNIX);
                 foreach ($recs as $rec) {
                     $calc = new ilCalendarRecurrenceCalculator($event, $rec);
                     foreach ($calc->calculateDateList($this->start, $this->end)->get() as $rec_date) {
                         if ($this->type == self::TYPE_PD_UPCOMING &&
                             $rec_date->get(IL_CAL_UNIX) < time()) {
                             continue;
                         }
                         
                         $this->schedule[$counter]['event'] = $event;
                         $this->schedule[$counter]['dstart'] = $rec_date->get(IL_CAL_UNIX);
                         $this->schedule[$counter]['dend'] = $this->schedule[$counter]['dstart'] + $duration;
                         $this->schedule[$counter]['fullday'] = $event->isFullday();
                         $this->schedule[$counter]['category_id'] = $cat_map[$event->getEntryId()];
                         $this->schedule[$counter]['category_type'] = $cat_types[$cat_map[$event->getEntryId()]];
                         
                         switch ($this->type) {
                             case self::TYPE_DAY:
                             case self::TYPE_WEEK:
                                 // store date info (used for calculation of overlapping events)
                                 $tmp_date = new ilDateTime($this->schedule[$counter]['dstart'], IL_CAL_UNIX, $this->timezone);
                                 $this->schedule[$counter]['start_info'] = $tmp_date->get(IL_CAL_FKT_GETDATE, '', $this->timezone);
                                 
                                 $tmp_date = new ilDateTime($this->schedule[$counter]['dend'], IL_CAL_UNIX, $this->timezone);
                                 $this->schedule[$counter]['end_info'] = $tmp_date->get(IL_CAL_FKT_GETDATE, '', $this->timezone);
                                 break;
 
                             default:
                                 break;
                         }
                         $counter++;
                         if ($this->type != self::TYPE_PD_UPCOMING &&
                             $this->areEventsLimited() && $counter >= $this->getEventsLimit()) {
                             break;
                         }
                     }
                 }
             } else {
                 $this->schedule[$counter]['event'] = $event;
                 $this->schedule[$counter]['dstart'] = $event->getStart()->get(IL_CAL_UNIX);
                 $this->schedule[$counter]['dend'] = $event->getEnd()->get(IL_CAL_UNIX);
                 $this->schedule[$counter]['fullday'] = $event->isFullday();
                 $this->schedule[$counter]['category_id'] = $cat_map[$event->getEntryId()];
                 $this->schedule[$counter]['category_type'] = $cat_types[$cat_map[$event->getEntryId()]];
                 
                 if (!$event->isFullday()) {
                     switch ($this->type) {
                         case self::TYPE_DAY:
                         case self::TYPE_WEEK:
                             // store date info (used for calculation of overlapping events)
                             $tmp_date = new ilDateTime($this->schedule[$counter]['dstart'], IL_CAL_UNIX, $this->timezone);
                             $this->schedule[$counter]['start_info'] = $tmp_date->get(IL_CAL_FKT_GETDATE, '', $this->timezone);
 
                             $tmp_date = new ilDateTime($this->schedule[$counter]['dend'], IL_CAL_UNIX, $this->timezone);
                             $this->schedule[$counter]['end_info'] = $tmp_date->get(IL_CAL_FKT_GETDATE, '', $this->timezone);
                             break;
     
                         default:
                             break;
                     }
                 }
                 $counter++;
                 if ($this->type != self::TYPE_PD_UPCOMING &&
                     $this->areEventsLimited() && $counter >= $this->getEventsLimit()) {
                     break;
                 }
             }
         }
         
         if ($this->type == self::TYPE_PD_UPCOMING) {
             $this->schedule = ilUtil::sortArray($this->schedule, "dstart", "asc", true);
             if ($this->areEventsLimited() && sizeof($this->schedule) >= $this->getEventsLimit()) {
                 $this->schedule = array_slice($this->schedule, 0, $this->getEventsLimit());
             }
         }
     }

Here is the call graph for this function:

◆ enabledSubitemCalendars()

ilCalendarSchedule::enabledSubitemCalendars ( )

Are subitem calendars enabled.

Returns

Definition at line 181 of file class.ilCalendarSchedule.php.

References $subitems_enabled.

Referenced by getEvents().

     {
         return (bool) $this->subitems_enabled;
     }

Here is the caller graph for this function:

◆ filterCategories()

ilCalendarSchedule::filterCategories ( array $a_cats )

protected

Definition at line 359 of file class.ilCalendarSchedule.php.

Referenced by getChangedEvents(), and getEvents().

     {
         if (!sizeof($a_cats)) {
             return $a_cats;
         }
         
         foreach ($this->filters as $filter) {
             if (sizeof($a_cats)) {
                 $a_cats = $filter->filterCategories($a_cats);
             }
         }
         
         return $a_cats;
     }

Here is the caller graph for this function:

◆ getByDay()

ilCalendarSchedule::getByDay	(	ilDate	$a_start,
			$a_timezone
	)

get byday

public

Parameters

ilDate start

Definition at line 203 of file class.ilCalendarSchedule.php.

References Vendor\Package\$a, Vendor\Package\$b, $schedule, $start, $timezone, ilDateTime\DAY, ilDate\get(), ilDateTime\get(), IL_CAL_DATETIME, IL_CAL_UNIX, and ilDateTime\increment().

     {
         $start = new ilDateTime($a_start->get(IL_CAL_DATETIME), IL_CAL_DATETIME, $this->timezone);
         $fstart = new ilDate($a_start->get(IL_CAL_UNIX), IL_CAL_UNIX);
         $fend = clone $fstart;
         
         $f_unix_start = $fstart->get(IL_CAL_UNIX);
         $fend->increment(ilDateTime::DAY, 1);
         $f_unix_end = $fend->get(IL_CAL_UNIX);
         
         $unix_start = $start->get(IL_CAL_UNIX);
         $start->increment(ilDateTime::DAY, 1);
         $unix_end = $start->get(IL_CAL_UNIX);
         
         $counter = 0;
         
         $tmp_date = new ilDateTime($unix_start, IL_CAL_UNIX, $this->timezone);
         $tmp_schedule = array();
         $tmp_schedule_fullday = array();
         foreach ($this->schedule as $schedule) {
             if ($schedule['fullday']) {
                 if (($f_unix_start == $schedule['dstart']) or
                     $f_unix_start == $schedule['dend'] or
                     ($f_unix_start > $schedule['dstart'] and $f_unix_end <= $schedule['dend'])) {
                     $tmp_schedule_fullday[] = $schedule;
                 }
             } elseif (($schedule['dstart'] == $unix_start) or
                 (($schedule['dstart'] <= $unix_start) and ($schedule['dend'] > $unix_start)) or
                 (($schedule['dstart'] >= $unix_start) and ($schedule['dstart'] < $unix_end))) {
                 $tmp_schedule[] = $schedule;
             }
         }
 
         //order non full day events by starting date;
         usort($tmp_schedule, function ($a, $b) {
             return $a['dstart'] <=> $b['dstart'];
         });
 
         //merge both arrays keeping the full day events first and then rest ordered by starting date.
         $schedules = array_merge($tmp_schedule_fullday, $tmp_schedule);
 
         return $schedules;
     }

Here is the call graph for this function:

◆ getChangedEvents()

ilCalendarSchedule::getChangedEvents ( $a_include_subitem_calendars = false )

get new/changed events

Parameters

bool $a_include_subitem_calendars E.g include session calendars of courses.

Returns: object $events[] Array of changed events protected

Definition at line 407 of file class.ilCalendarSchedule.php.

References $DIC, $ilDB, $query, $res, $start, ilCalendarCategories\_getInstance(), addCustomEvents(), ilDBConstants\FETCHMODE_OBJECT, filterCategories(), IL_CAL_DATE, IL_CAL_DATETIME, IL_CAL_MONTH, modifyEventByFilters(), and user().

     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
         
         include_once('./Services/Calendar/classes/class.ilCalendarCategories.php');
         $cats = ilCalendarCategories::_getInstance($this->user->getId())->getCategories($a_include_subitem_calendars);
         $cats = $this->filterCategories($cats);
                 
         if (!count($cats)) {
             return array();
         }
         
         $start = new ilDate(date('Y-m-d', time()), IL_CAL_DATE);
         $start->increment(IL_CAL_MONTH, -1);
         
         $query = "SELECT ce.cal_id cal_id FROM cal_entries ce  " .
             "JOIN cal_cat_assignments ca ON ca.cal_id = ce.cal_id " .
             "WHERE last_update > " . $ilDB->quote($start->get(IL_CAL_DATETIME), 'timestamp') . " " .
             "AND " . $ilDB->in('ca.cat_id', $cats, false, 'integer') . ' ' .
             "ORDER BY last_update";
         $res = $this->db->query($query);
         
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $event = new ilCalendarEntry($row->cal_id);
             $valid_event = $this->modifyEventByFilters($event);
             if ($valid_event) {
                 $events[] = $valid_event;
             }
         }
         
         foreach ($this->addCustomEvents($this->start, $this->end, $cats) as $event) {
             $events[] = $event;
         }
         
         return $events ? $events : array();
     }

Here is the call graph for this function:

◆ getEvents()

ilCalendarSchedule::getEvents ( )

Read events (will be moved to another class, since only active and/or visible calendars are shown)

protected

Definition at line 452 of file class.ilCalendarSchedule.php.

References $DIC, $ilDB, $query, $res, ilCalendarCategories\_getInstance(), addCustomEvents(), enabledSubitemCalendars(), ilDBConstants\FETCHMODE_OBJECT, filterCategories(), IL_CAL_DATETIME, IL_CAL_UNIX, modifyEventByFilters(), and user().

Referenced by calculate().

     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
         
         include_once('./Services/Calendar/classes/class.ilCalendarCategories.php');
         $cats = ilCalendarCategories::_getInstance($this->user->getId())->getCategories($this->enabledSubitemCalendars());
         $cats = $this->filterCategories($cats);
         
         if (!count($cats)) {
             return array();
         }
 
         // TODO: optimize
         $query = "SELECT ce.cal_id cal_id" .
             " FROM cal_entries ce" .
             " LEFT JOIN cal_recurrence_rules crr ON (ce.cal_id = crr.cal_id)" .
             " JOIN cal_cat_assignments ca ON (ca.cal_id = ce.cal_id)";
 
         if ($this->type != self::TYPE_INBOX) {
             $query .= " WHERE ((starta <= " . $this->db->quote($this->end->get(IL_CAL_DATETIME, '', 'UTC'), 'timestamp') .
                 " AND enda >= " . $this->db->quote($this->start->get(IL_CAL_DATETIME, '', 'UTC'), 'timestamp') . ")" .
                 " OR (starta <= " . $this->db->quote($this->end->get(IL_CAL_DATETIME, '', 'UTC'), 'timestamp') .
                 " AND NOT rule_id IS NULL))";
         } else {
             $date = new ilDateTime(mktime(0, 0, 0), IL_CAL_UNIX);
             $query .= " WHERE starta >= " . $this->db->quote($date->get(IL_CAL_DATETIME, '', 'UTC'), 'timestamp');
         }
 
         $query .= " AND " . $ilDB->in('ca.cat_id', $cats, false, 'integer') .
             " ORDER BY starta";
 
         $res = $this->db->query($query);
 
         $events = array();
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $event = new ilCalendarEntry($row->cal_id);
             $valid_event = $this->modifyEventByFilters($event);
             if ($valid_event) {
                 $events[] = $valid_event;
             }
         }
         
         foreach ($this->addCustomEvents($this->start, $this->end, $cats) as $event) {
             $events[] = $event;
         }
             
         return $events;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getEventsLimit()

ilCalendarSchedule::getEventsLimit ( )

get current limit of events

Returns: type

Definition at line 153 of file class.ilCalendarSchedule.php.

References $limit_events.

Referenced by calculate().

     {
         return $this->limit_events;
     }

Here is the caller graph for this function:

◆ getScheduledEvents()

ilCalendarSchedule::getScheduledEvents ( )

Definition at line 354 of file class.ilCalendarSchedule.php.

References $schedule.

     {
         return (array) $this->schedule;
     }

◆ initPeriod()

ilCalendarSchedule::initPeriod ( ilDate $seed )

protected

init period of events

protected

Parameters

ilDate seed

Returns

Definition at line 510 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_SECOND, IL_CAL_WEEK, ilDateTime\increment(), ilCalendarSettings\WEEK_START_MONDAY, and ilCalendarSettings\WEEK_START_SUNDAY.

Referenced by __construct().

     {
         switch ($this->type) {
             case self::TYPE_DAY:
                 $this->start = clone $seed;
                 $this->end = clone $seed;
                 //this strict period is just to avoid possible side effects.
                 if (!$this->strict_period) {
                     $this->start->increment(IL_CAL_DAY, -2);
                     $this->end->increment(IL_CAL_DAY, 2);
                 } else {
                     $this->end->increment(IL_CAL_DAY, 1);
                     $this->end->increment(IL_CAL_SECOND, -1);
                 }
                 break;
             
             case self::TYPE_WEEK:
                 $this->start = clone $seed;
                 $start_info = $this->start->get(IL_CAL_FKT_GETDATE, '', 'UTC');
                 $day_diff = $this->weekstart - $start_info['isoday'];
 
                 if ($day_diff == 7) {
                     $day_diff = 0;
                 }
 
                 //this strict period is just to avoid possible side effects.
                 if ($this->strict_period) {
                     $this->start->increment(IL_CAL_DAY, $day_diff);
                     $this->end = clone $this->start;
                     $this->end->increment(IL_CAL_WEEK); #22173
                 } else {
                     $this->start->increment(IL_CAL_DAY, $day_diff);
                     $this->start->increment(IL_CAL_DAY, -1);
                     $this->end = clone $this->start;
                     $this->end->increment(IL_CAL_DAY, 9);
                 }
                 break;
             
             case self::TYPE_MONTH:
                 if ($this->strict_period) {
                     $this->start = clone $seed;
                     $this->end = clone $seed;
                     $this->end->increment(IL_CAL_MONTH, 1);
                 } else {
                     $year_month = $seed->get(IL_CAL_FKT_DATE, 'Y-m', 'UTC');
                     list($year, $month) = explode('-', $year_month);
 
                     #21716
                     $this->start = new ilDate($year_month . '-01', IL_CAL_DATE);
 
                     $start_unix_time = $this->start->getUnixTime();
 
                     $start_day_of_week = (int) date('w', $start_unix_time);
 
                     $number_days_previous_month = 0;
 
                     if ($start_day_of_week === 0 && $this->weekstart === ilCalendarSettings::WEEK_START_MONDAY) {
                         $number_days_previous_month = 6;
                     } elseif ($start_day_of_week > 0) {
                         $number_days_previous_month = $start_day_of_week;
 
                         if ($this->weekstart === ilCalendarSettings::WEEK_START_MONDAY) {
                             $number_days_previous_month = $start_day_of_week - 1;
                         }
                     }
 
                     $this->start->increment(IL_CAL_DAY, -$number_days_previous_month);
 
                     #21716
                     $this->end = new ilDate($year_month . '-' . ilCalendarUtil::_getMaxDayOfMonth($year, $month), IL_CAL_DATE);
 
                     $end_unix_time = $this->end->getUnixTime();
 
                     $end_day_of_week = (int) date('w', $end_unix_time);
 
                     if ($end_day_of_week > 0) {
                         $number_days_next_month = 7 - $end_day_of_week;
 
                         if ($this->weekstart == ilCalendarSettings::WEEK_START_SUNDAY) {
                             $number_days_next_month = $number_days_next_month - 1;
                         }
 
                         $this->end->increment(IL_CAL_DAY, $number_days_next_month);
                     }
                 }
 
                 break;
             
             case self::TYPE_HALF_YEAR:
                 $this->start = clone $seed;
                 $this->end = clone $this->start;
                 $this->end->increment(IL_CAL_MONTH, 6);
                 break;
             
             case self::TYPE_PD_UPCOMING:
             case self::TYPE_INBOX:
                 $this->start = $seed;
                 $this->end = clone $this->start;
                 $this->end->increment(IL_CAL_MONTH, 12);
                 break;
         }
         
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ modifyEventByFilters()

ilCalendarSchedule::modifyEventByFilters ( ilCalendarEntry $event )

protected

Definition at line 374 of file class.ilCalendarSchedule.php.

References $res.

Referenced by getChangedEvents(), and getEvents().

     {
         foreach ($this->filters as $filter) {
             $res = $filter->modifyEvent($event);
             if (!$res) {
                 $this->logger->info('filtering failed for ' . get_class($filter));
                 return false;
             }
             $event = $res;
         }
         return $event;
     }

Here is the caller graph for this function:

◆ setEventsLimit()

ilCalendarSchedule::setEventsLimit ( $a_limit )

Set events limit.

Parameters

type $a_limit

Definition at line 162 of file class.ilCalendarSchedule.php.

     {
         $this->limit_events = $a_limit;
     }

◆ setPeriod()

ilCalendarSchedule::setPeriod	(	ilDate	$a_start,
		ilDate	$a_end
	)

Set period.

Parameters

ilDate	start
ilDate	end

Returns

Definition at line 621 of file class.ilCalendarSchedule.php.

     {
         $this->start = $a_start;
         $this->end = $a_end;
     }

Field Documentation

◆ $db

ilCalendarSchedule::$db = null

protected

Definition at line 59 of file class.ilCalendarSchedule.php.

◆ $end

ilCalendarSchedule::$end = null

protected

Definition at line 56 of file class.ilCalendarSchedule.php.

◆ $filters

ilCalendarSchedule::$filters = array()

protected

Definition at line 60 of file class.ilCalendarSchedule.php.

◆ $limit_events

ilCalendarSchedule::$limit_events = -1

protected

Definition at line 47 of file class.ilCalendarSchedule.php.

Referenced by getEventsLimit().

◆ $logger

ilCalendarSchedule::$logger

protected

Definition at line 70 of file class.ilCalendarSchedule.php.

◆ $schedule

ilCalendarSchedule::$schedule = array()

protected

Definition at line 48 of file class.ilCalendarSchedule.php.

Referenced by getByDay(), and getScheduledEvents().

◆ $start

ilCalendarSchedule::$start = null

protected

Definition at line 55 of file class.ilCalendarSchedule.php.

Referenced by getByDay(), getChangedEvents(), and initPeriod().

◆ $strict_period

ilCalendarSchedule::$strict_period

protected

Definition at line 65 of file class.ilCalendarSchedule.php.

◆ $subitems_enabled

ilCalendarSchedule::$subitems_enabled = false

protected

Definition at line 53 of file class.ilCalendarSchedule.php.

Referenced by enabledSubitemCalendars().

◆ $timezone

ilCalendarSchedule::$timezone

protected

Definition at line 49 of file class.ilCalendarSchedule.php.

Referenced by getByDay().

◆ $type

ilCalendarSchedule::$type = 0

protected

Definition at line 51 of file class.ilCalendarSchedule.php.

◆ $user

ilCalendarSchedule::$user = null

protected

Definition at line 57 of file class.ilCalendarSchedule.php.

◆ $user_settings

ilCalendarSchedule::$user_settings = null

protected

Definition at line 58 of file class.ilCalendarSchedule.php.

◆ $weekstart

ilCalendarSchedule::$weekstart

protected

Definition at line 50 of file class.ilCalendarSchedule.php.

◆ TYPE_DAY

const ilCalendarSchedule::TYPE_DAY = 1

Definition at line 38 of file class.ilCalendarSchedule.php.

Referenced by ilCalendarDayGUI\executeCommand(), and ilCalendarViewGUI\getEvents().

◆ TYPE_HALF_YEAR

const ilCalendarSchedule::TYPE_HALF_YEAR = 6

Definition at line 42 of file class.ilCalendarSchedule.php.

Referenced by ilCalendarViewGUI\getEvents().

◆ TYPE_INBOX

const ilCalendarSchedule::TYPE_INBOX = 4

Definition at line 41 of file class.ilCalendarSchedule.php.

Referenced by ilCalendarBlockGUI\getOverview().

◆ TYPE_MONTH

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().

◆ TYPE_PD_UPCOMING

const ilCalendarSchedule::TYPE_PD_UPCOMING = 5

Definition at line 45 of file class.ilCalendarSchedule.php.

Referenced by ilCalendarBlockGUI\getEvents().

◆ TYPE_WEEK

const ilCalendarSchedule::TYPE_WEEK = 2

Definition at line 39 of file class.ilCalendarSchedule.php.

Referenced by ilCalendarViewGUI\getEvents(), and ilCalendarWeekGUI\show().

The documentation for this class was generated from the following file:

Services/Calendar/classes/class.ilCalendarSchedule.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addCustomEvents()

◆ addFilter()

◆ addSubitemCalendars()

◆ areEventsLimited()

◆ calculate()

◆ enabledSubitemCalendars()

◆ filterCategories()

◆ getByDay()

◆ getChangedEvents()

◆ getEvents()

◆ getEventsLimit()

◆ getScheduledEvents()

◆ initPeriod()

◆ modifyEventByFilters()

◆ setEventsLimit()

◆ setPeriod()

Field Documentation

◆ $db

◆ $end

◆ $filters

◆ $limit_events

◆ $logger

◆ $schedule

◆ $start

◆ $strict_period

◆ $subitems_enabled

◆ $timezone

◆ $type

◆ $user

◆ $user_settings

◆ $weekstart

◆ TYPE_DAY

◆ TYPE_HALF_YEAR

◆ TYPE_INBOX

◆ TYPE_MONTH

◆ TYPE_PD_UPCOMING

◆ TYPE_WEEK