Calendar schedule filter for exercises. More...

Inheritance diagram for ilCalendarScheduleFilterExercise:

Collaboration diagram for ilCalendarScheduleFilterExercise:

Public Member Functions
	__construct (int $a_user_id)

	getLogger ()

	filterCategories (array $a_cats)

	modifyEvent (ilCalendarEntry $a_event)

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

Protected Member Functions
	isExerciseCategory ($a_cat_id)
	Check valid exercise calendar category. More...

Protected Attributes
int	$user_id

ilLogger	$logger

Detailed Description

Calendar schedule filter for exercises.

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 12 of file class.ilCalendarScheduleFilterExercise.php.

Constructor & Destructor Documentation

◆ __construct()

ilCalendarScheduleFilterExercise::__construct ( int $a_user_id )

Definition at line 17 of file class.ilCalendarScheduleFilterExercise.php.

References $DIC, and ILIAS\Repository\logger().

     {
         global $DIC;
 
         $this->user_id = $a_user_id;
         $this->logger = $DIC->logger()->exc();
     }

Here is the call graph for this function:

Member Function Documentation

◆ addCustomEvents()

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

Implements ilCalendarScheduleFilter.

Definition at line 74 of file class.ilCalendarScheduleFilterExercise.php.

References $user_id, ilCalendarCategoryAssignments\_getAssignedAppointments(), ilDateTime\_within(), ilExAssignment\DEADLINE_RELATIVE, ilExcAssMemberState\getInstanceByIds(), ilExAssignment\getInstancesByExercise(), IL_CAL_UNIX, and isExerciseCategory().

                                                                                     : array
     {
         $all_events = array();
 
         foreach ($a_categories as $cat_id) {
             $cal_cat = $this->isExerciseCategory($cat_id);
             if (!$cal_cat) {
                 continue;
             }
 
             $exc_obj_id = $cal_cat->getObjId();
 
             $calc_dead = null;
             foreach (ilExAssignment::getInstancesByExercise($exc_obj_id) as $ass) {
                 $idl = $ass->getPersonalDeadline($this->user_id);
 
                 $has_individual_deadline = ($idl && $idl != $ass->getDeadline());
                 if ($has_individual_deadline) {
                     $idl = new ilDateTime($idl, IL_CAL_UNIX);
                     if (!ilDateTime::_within($idl, $start, $end)) {
                         $has_individual_deadline = false;
                     }
                 }
                 $has_relative_deadline = ($ass->getDeadlineMode() == ilExAssignment::DEADLINE_RELATIVE);
                 if ($has_relative_deadline) {
                     $state = ilExcAssMemberState::getInstanceByIds($ass->getId(), $this->user_id);
                     $calculated_deadline = $state->getCalculatedDeadline();
                     if ($calculated_deadline) {
                         $calc_dead = new ilDateTime($calculated_deadline, IL_CAL_UNIX);
                         if (!ilDateTime::_within($calc_dead, $start, $end)) {
                             $has_relative_deadline = false;
                         }
                     } else {
                         $has_relative_deadline = false;
                     }
                 }
 
                 if ($has_individual_deadline || $has_relative_deadline) {
                     $app_ids = ilCalendarCategoryAssignments::_getAssignedAppointments(array($cal_cat->getCategoryID()));
                     foreach ($app_ids as $app_id) {
                         $entry = new ilCalendarEntry($app_id);
                         if (!$entry->isAutoGenerated()) {
                             continue;
                         }
                         if ($entry->getContextId() == $ass->getId() . "0") {
                             if ($has_individual_deadline) {
                                 $entry->setStart($idl);
                                 $entry->setEnd($idl);
                                 $all_events[] = $entry;
                             } elseif ($has_relative_deadline) {
                                 $entry->setStart($calc_dead);
                                 $entry->setEnd($calc_dead);
                                 $all_events[] = $entry;
                             }
                         }
                     }
                 }
             }
         }
         return $all_events;
     }

Here is the call graph for this function:

◆ filterCategories()

ilCalendarScheduleFilterExercise::filterCategories ( array $a_cats )

Implements ilCalendarScheduleFilter.

Definition at line 33 of file class.ilCalendarScheduleFilterExercise.php.

                                                    : array
     {
         return $a_cats;
     }

◆ getLogger()

ilCalendarScheduleFilterExercise::getLogger ( )

Definition at line 25 of file class.ilCalendarScheduleFilterExercise.php.

References $logger.

Referenced by isExerciseCategory().

                                : ilLogger
     {
         return $this->logger;
     }

Here is the caller graph for this function:

◆ isExerciseCategory()

ilCalendarScheduleFilterExercise::isExerciseCategory ( $a_cat_id )

protected

Check valid exercise calendar category.

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

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

Referenced by addCustomEvents(), and modifyEvent().

                                                     : ?ilCalendarCategory
     {
         $category = ilCalendarCategory::getInstanceByCategoryId($a_cat_id);
 
         if ($category->getType() != ilCalendarCategory::TYPE_OBJ) {
             $this->getLogger()->debug('Not modifying calendar for non object type');
             return null;
         }
         if ($category->getObjType() != 'exc') {
             $this->getLogger()->debug('Category object type is != folder => category event not modified');
             return null;
         }
         return $category;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ modifyEvent()

ilCalendarScheduleFilterExercise::modifyEvent ( ilCalendarEntry $a_event )

Implements ilCalendarScheduleFilter.

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

References $ass_id, ilCalendarCategoryAssignments\_lookupCategory(), ilExAssignment\DEADLINE_RELATIVE, ilCalendarEntry\getContextId(), ilCalendarEntry\getEntryId(), ILIAS\Repository\int(), and isExerciseCategory().

                                                          : ?ilCalendarEntry
     {
         $cal_cat = $this->isExerciseCategory(ilCalendarCategoryAssignments::_lookupCategory($a_event->getEntryId()));
         if ($cal_cat) {
             $exc_obj_id = $cal_cat->getObjId();
 
             // see ilExAssignment::handleCalendarEntries()
             $context_id = $a_event->getContextId();
             $subtype = (int) substr((string) $context_id, -1);
             $ass_id = (int) substr((string) $context_id, 0, -1);
             // 1 is peer review deadline
             if ($subtype != 1) {
                 $ass = new ilExAssignment($ass_id);
                 if ($ass->getExerciseId() == $exc_obj_id) {
                     $idl = $ass->getPersonalDeadline($this->user_id);
                     if ($idl &&
                         $idl != $ass->getDeadline()) {
                         // we have individal deadline (see addCustomEvents());
                         return null;
                     }
                     if ($ass->getDeadlineMode() == ilExAssignment::DEADLINE_RELATIVE) {
                         // we have relative deadline (see addCustomEvents());
                         return null;
                     }
                 }
             }
         }
         return $a_event;
     }