Calendar schedule filter for individual timings. More...

Inheritance diagram for ilCalendarScheduleFilterTimings:

Collaboration diagram for ilCalendarScheduleFilterTimings:

Public Member Functions
	__construct ($a_usr_id)
	ilCalendarScheduleFilterTimings constructor. More...

	getLogger ()
	Get logger. More...

	filterCategories (array $a_cats)
	Filter categories All categories are show no filtering (support for individual folder appointments) More...

	modifyEvent (ilCalendarEntry $a_event)
	modify event => return false for not presenting event More...

	addCustomEvents (ilDate $start, ilDate $end, array $a_categories)
	Add custom events: relative timings, modified timings. More...

Data Fields
const	CAL_TIMING_START = 1

const	CAL_TIMING_END = 2

Protected Member Functions
	findCalendarEntriesForItem ($category_id, $item_ref_id)

	isCourseCategory ($a_category_id)

	enabledCourseTimings ($a_course_ref)
	Check if timings enabled for ref_id. More...

Private Attributes
	$user_id = 0

	$logger

Detailed Description

Calendar schedule filter for individual timings.

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

Definition at line 11 of file class.ilCalendarScheduleFilterTimings.php.

Constructor & Destructor Documentation

◆ __construct()

ilCalendarScheduleFilterTimings::__construct ( $a_usr_id )

ilCalendarScheduleFilterTimings constructor.

Parameters

int a_usr_id

Definition at line 31 of file class.ilCalendarScheduleFilterTimings.php.

References ilLoggerFactory\getLogger().

     {
         $this->user_id = $a_usr_id;
         $this->logger = ilLoggerFactory::getLogger('crs');
     }

Here is the call graph for this function:

Member Function Documentation

◆ addCustomEvents()

ilCalendarScheduleFilterTimings::addCustomEvents	(	ilDate	$start,
		ilDate	$end,
		array	$a_categories
	)

Add custom events: relative timings, modified timings.

Parameters

ilDate	$start
ilDate	$end
array	$a_categories

Implements ilCalendarScheduleFilter.

Definition at line 139 of file class.ilCalendarScheduleFilterTimings.php.

References $end, $start, ilObject\_getAllReferences(), ilDateTime\_within(), ilObjCourse\CAL_COURSE_TIMING_END, ilObjCourse\CAL_COURSE_TIMING_START, enabledCourseTimings(), findCalendarEntriesForItem(), getLogger(), ilLoggerFactory\getLogger(), ilObjectActivation\getTimingsItems(), IL_CAL_DATE, ilCourseConstants\IL_CRS_VIEW_TIMING_ABSOLUTE, isCourseCategory(), ilObjCourse\lookupTimingMode(), and ilObjectActivation\TIMINGS_PRESETTING.

     {
         // @fixme
         // @todo categories can appear more than once
         $a_categories = array_unique($a_categories);
 
 
         $all_events = [];
         foreach ($a_categories as $cat_id) {
             $category = $this->isCourseCategory($cat_id);
             if (!$category) {
                 continue;
             }
             $course_obj_id = $category->getObjId();
             $ref_ids = ilObject::_getAllReferences($course_obj_id);
             $course_ref_id = end($ref_ids);
             $course_timing_mode = ilObjCourse::lookupTimingMode($course_obj_id);
             if (!$this->enabledCourseTimings($course_ref_id)) {
                 ilLoggerFactory::getLogger('cal')->debug('Timings disabled for course: ');
                 continue;
             }
             $active = ilObjectActivation::getTimingsItems($course_ref_id);
             foreach ($active as $null => $item) {
                 if ($item['timing_type'] != ilObjectActivation::TIMINGS_PRESETTING) {
                     $this->getLogger()->debug('timings not active for: ' . $item['ref_id']);
                     continue;
                 }
                 if (
                     !$item['changeable'] &&
                     $course_timing_mode == ilCourseConstants::IL_CRS_VIEW_TIMING_ABSOLUTE
                 ) {
                     $this->getLogger('cal')->debug('Not creating new event since item is unchangeable and absolute');
                     continue;
                 }
 
                 $user_data = new ilTimingUser($item['ref_id'], $this->user_id);
                 if (!$user_data->isScheduled()) {
                     $this->getLogger()->debug('No scheduled timings for user');
                     continue;
                 }
                 if (
                     ilDateTime::_within($user_data->getStart(), $start, $end) or
                     ilDateTime::_within($user_data->getEnd(), $start, $end)
                 ) {
                     $entries = $this->findCalendarEntriesForItem($category->getCategoryID(), $item['ref_id']);
 
                     $this->logger->dump($item);
                     $this->logger->debug('Number of found entries is: ' . count($entries));
 
                     foreach ($entries as $entry) {
                         if ($entry->getContextId() == ilObjCourse::CAL_COURSE_TIMING_START) {
                             $entry->setStart(new ilDate($user_data->getStart()->get(IL_CAL_DATE), IL_CAL_DATE));
                             $entry->setEnd(new ilDate($user_data->getStart()->get(IL_CAL_DATE), IL_CAL_DATE));
                         }
                         if ($entry->getContextId() == ilObjCourse::CAL_COURSE_TIMING_END) {
                             $entry->setStart(new ilDate($user_data->getEnd()->get(IL_CAL_DATE), IL_CAL_DATE));
                             $entry->setEnd(new ilDate($user_data->getEnd()->get(IL_CAL_DATE), IL_CAL_DATE));
                         }
                         $all_events[] = $entry;
                     }
                 }
             }
         }
         return $all_events;
     }

Here is the call graph for this function:

◆ enabledCourseTimings()

ilCalendarScheduleFilterTimings::enabledCourseTimings ( $a_course_ref )

protected

Check if timings enabled for ref_id.

Parameters

int $a_course_ref

Returns: bool

Definition at line 255 of file class.ilCalendarScheduleFilterTimings.php.

References ilObject\_lookupObjId(), ilObjCourse\_lookupViewMode(), getLogger(), and ilContainer\VIEW_TIMING.

Referenced by addCustomEvents(), and modifyEvent().

     {
         if (ilObjCourse::_lookupViewMode(ilObject::_lookupObjId($a_course_ref)) != ilContainer::VIEW_TIMING) {
             $this->getLogger()->debug('Parent course has other view mode than timings. course ref_id = ' . $a_course_ref);
             return false;
         }
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ filterCategories()

ilCalendarScheduleFilterTimings::filterCategories ( array $a_cats )

Filter categories All categories are show no filtering (support for individual folder appointments)

Parameters

int[] $a_cats

Implements ilCalendarScheduleFilter.

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

     {
         return $a_cats;
     }

◆ findCalendarEntriesForItem()

ilCalendarScheduleFilterTimings::findCalendarEntriesForItem	(	$category_id,
		$item_ref_id
	)

protected

Parameters

$category_id
$item_ref_id

Returns: ilCalendarEntry[]

Definition at line 210 of file class.ilCalendarScheduleFilterTimings.php.

References ilCalendarCategoryAssignments\_getAssignedAppointments(), ilObjCourse\CAL_COURSE_TIMING_END, and ilObjCourse\CAL_COURSE_TIMING_START.

Referenced by addCustomEvents().

     {
         $app_ids = ilCalendarCategoryAssignments::_getAssignedAppointments([$category_id]);
         $entries = [];
         foreach ($app_ids as $app_id) {
             $entry = new ilCalendarEntry($app_id);
 
             if (
                 (
                     $entry->getContextId() == ilObjCourse::CAL_COURSE_TIMING_START ||
                     $entry->getContextId() == ilObjCourse::CAL_COURSE_TIMING_END
                 ) &&
                 $entry->getContextInfo() == $item_ref_id
             ) {
                 $entries[] = $entry;
             }
         }
         return $entries;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLogger()

ilCalendarScheduleFilterTimings::getLogger ( )

Get logger.

Returns

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

References $logger.

Referenced by addCustomEvents(), enabledCourseTimings(), isCourseCategory(), and modifyEvent().

     {
         return $this->logger;
     }

Here is the caller graph for this function:

◆ isCourseCategory()

ilCalendarScheduleFilterTimings::isCourseCategory ( $a_category_id )

protected

Parameters

int $a_category_id

Returns: bool|ilCalendarCategory

Definition at line 235 of file class.ilCalendarScheduleFilterTimings.php.

References ilCalendarCategory\getInstanceByCategoryId(), getLogger(), and ilCalendarCategory\TYPE_OBJ.

Referenced by addCustomEvents(), and modifyEvent().

     {
         $category = ilCalendarCategory::getInstanceByCategoryId($a_category_id);
 
         if ($category->getType() != ilCalendarCategory::TYPE_OBJ) {
             $this->getLogger()->debug('No object calendar => not modifying event.');
             return false;
         }
         if ($category->getObjType() != 'crs') {
             $this->getLogger()->debug('Category object type is != crs => not modifying event');
             return false;
         }
         return $category;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ modifyEvent()

ilCalendarScheduleFilterTimings::modifyEvent ( ilCalendarEntry $a_event )

modify event => return false for not presenting event

Parameters

\ilCalendarEntry $a_event

Returns: bool|ilCalendarEntry

Implements ilCalendarScheduleFilter.

Definition at line 61 of file class.ilCalendarScheduleFilterTimings.php.

References ilObject\_getAllReferences(), ilCalendarCategoryAssignments\_lookupCategory(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), ilObjCourse\CAL_COURSE_TIMING_END, ilObjCourse\CAL_COURSE_TIMING_START, enabledCourseTimings(), ilCalendarEntry\getContextId(), ilCalendarEntry\getContextInfo(), ilCalendarEntry\getEntryId(), ilObjectActivation\getItem(), getLogger(), ilCalendarEntry\getPresentationTitle(), ilCalendarEntry\getTitle(), ilCourseConstants\IL_CRS_VIEW_TIMING_RELATIVE, ilCalendarEntry\isAutoGenerated(), isCourseCategory(), ilObjCourse\lookupTimingMode(), ilCalendarEntry\setTitle(), and ilObjectActivation\TIMINGS_PRESETTING.

     {
         $this->getLogger()->debug('Modifying events for timings');
         if (!$a_event->isAutoGenerated()) {
             $this->getLogger()->debug($a_event->getTitle() . ' is not autogenerated => no modification');
             return $a_event;
         }
 
         if (
             $a_event->getContextId() != ilObjCourse::CAL_COURSE_TIMING_START &&
             $a_event->getContextId() != ilObjCourse::CAL_COURSE_TIMING_END
         ) {
             $this->getLogger()->debug('Non Timing event: unmodified');
             return $a_event;
         }
 
         // check course calendar
         $cat_id = ilCalendarCategoryAssignments::_lookupCategory($a_event->getEntryId());
         $category = $this->isCourseCategory($cat_id);
         if (!$category) {
             // no course category
             return $a_event;
         }
 
         // check absolute timings
         // category object type is folder
         $obj_id = $category->getObjId();
         $ref_ids = ilObject::_getAllReferences($obj_id);
         $ref_id = end($ref_ids);
         if (ilObjCourse::lookupTimingMode($obj_id) == ilCourseConstants::IL_CRS_VIEW_TIMING_RELATIVE) {
             // relative timings => always modify event
             $this->getLogger()->debug('Filtering event since mode is relative timing: ' . $a_event->getPresentationTitle(true));
             return false;
         }
 
         // timings enabled?
         if (!$this->enabledCourseTimings($ref_id)) {
             return false;
         }
 
         // check context info
         if (!$a_event->getContextInfo()) {
             $this->getLogger()->warning('Missing context info');
             return false;
         }
 
         $item_ref_id = (int) $a_event->getContextInfo();
         $timing_item = ilObjectActivation::getItem($item_ref_id);
         if ($timing_item['timing_type'] != ilObjectActivation::TIMINGS_PRESETTING) {
             $this->getLogger()->debug('Delete event with disabled timing settings');
             return false;
         }
 
         if ($timing_item['changeable']) {
             // check if scheduled
             $user_data = new ilTimingUser($item_ref_id, $this->user_id);
             if ($user_data->isScheduled()) {
                 $this->getLogger()->debug('Filtering event since item is scheduled by user: ' . $a_event->getPresentationTitle(true));
                 return false;
             }
         }
 
         // valid event => refresh title
         $this->getLogger()->debug('Valid timings event. Update title');
         $a_event->setTitle(
             ilObject::_lookupTitle(ilObject::_lookupObjId($item_ref_id))
         );
         return $a_event;
     }