Calendar schedule filter for exercises. More...

Inheritance diagram for ilCalendarScheduleFilterExercise:

Collaboration diagram for ilCalendarScheduleFilterExercise:

Public Member Functions
	__construct ($a_user_id)

	getLogger ()

	filterCategories (array $a_cats)

	modifyEvent (ilCalendarEntry $a_event)

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

	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
	$user_id

Static Protected Attributes
static	$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

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilCalendarScheduleFilterExercise::__construct ( $a_user_id )

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

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

References ilLoggerFactory\getLogger().

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 70 of file class.ilCalendarScheduleFilterExercise.php.

        {
                $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();
                        
                        include_once './Services/Calendar/classes/class.ilCalendarCategoryAssignments.php';
                        include_once './Modules/Exercise/classes/class.ilExAssignment.php';
                        foreach(ilExAssignment::getInstancesByExercise($exc_obj_id) as $ass)
                        {
                                $idl = $ass->getPersonalDeadline($this->user_id);
                                if($idl &&
                                        $idl != $ass->getDeadline())
                                {
                                        $idl = new ilDateTime($idl, IL_CAL_UNIX);                                       
                                        if(ilDateTime::_within($idl, $start, $end))
                                        {
                                                include_once './Services/Calendar/classes/class.ilCalendarEntry.php';
                                                $app_ids = ilCalendarCategoryAssignments::_getAssignedAppointments(array($cal_cat->getCategoryID()));
                                                foreach($app_ids as $app_id)
                                                {
                                                        include_once './Services/Calendar/classes/class.ilCalendarEntry.php';
                                                        $entry = new ilCalendarEntry($app_id);
                                                        if(!$entry->isAutoGenerated())
                                                        {
                                                                continue;
                                                        }
 
                                                        if($entry->getContextId() == $ass->getId()."0")
                                                        {
                                                                $entry->setStart($idl);
                                                                $entry->setEnd($idl);
                                                                $all_events[] = $entry;                         
                                                        }                                                                                                                                                                                       
                                                }                                               
                                        }
                                }
                        }
                }
                
                return $all_events;
        }

References $start, ilCalendarCategoryAssignments\_getAssignedAppointments(), ilDateTime\_within(), ilExAssignment\getInstancesByExercise(), IL_CAL_UNIX, and isExerciseCategory().

Here is the call graph for this function:

◆ filterCategories()

ilCalendarScheduleFilterExercise::filterCategories ( array $a_cats )

Implements ilCalendarScheduleFilter.

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

        {                       
                return $a_cats;
        }

◆ getLogger()

ilCalendarScheduleFilterExercise::getLogger ( )

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

        {
                return $this->logger;
        }       

References $logger.

Referenced by isExerciseCategory().

Here is the caller graph for this function:

◆ isExerciseCategory()

ilCalendarScheduleFilterExercise::isExerciseCategory ( $a_cat_id )

protected

Check valid exercise calendar category.

Parameters

int $a_cat_id

Returns: ilCalendarCategory

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

        {
                include_once './Services/Calendar/classes/class.ilCalendarCategory.php';
                $category = ilCalendarCategory::getInstanceByCategoryId($a_cat_id);
                
                if($category->getType() != ilCalendarCategory::TYPE_OBJ)
                {
                        $this->getLogger()->debug('Not modifying calendar for non object type');
                        return false;
                }
                if($category->getObjType() != 'exc')
                {
                        $this->getLogger()->debug('Category object type is != folder => category event not modified');
                        return false;
                }               
                
                return $category;
        }

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

Referenced by addCustomEvents(), and modifyEvent().

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 36 of file class.ilCalendarScheduleFilterExercise.php.

        {
                include_once './Services/Calendar/classes/class.ilCalendarCategoryAssignments.php';
                $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($context_id, -1);
                        $ass_id = (int)substr($context_id, 0, -1);
                        
                        // 1 is peer review deadline
                        if($subtype != 1)
                        {
                                include_once './Modules/Exercise/classes/class.ilExAssignment.php';
                                $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 false;                           
                                        }                                       
                                }
                        }
                }
                
                return $a_event;
        }