ilCalendarAppEventListener Class Reference

Handles events (create,update,delete) for autmatic generated calendar events from course, groups, ... More...

Inheritance diagram for ilCalendarAppEventListener:

Collaboration diagram for ilCalendarAppEventListener:

Static Public Member Functions
static	handleEvent ($a_component, $a_event, $a_parameter)
	Handle events like create, update, delete. More...
static	createCategory ($a_obj, $a_check_existing=false)
	Create a category for a new object (crs,grp, ...) More...
static	updateCategory ($a_obj)
	Create a category for a new object (crs,grp, ...) More...
static	createAppointments ($a_obj, $a_appointments)
	Create appointments. More...
static	deleteAppointments ($a_obj_id, array $a_context_ids=null)
	Delete automatic generated appointments. More...
static	deleteCategory ($a_obj_id)
	delete category More...

Detailed Description

Handles events (create,update,delete) for autmatic generated calendar events from course, groups, ...

Author

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

Version

$Id$

Definition at line 35 of file class.ilCalendarAppEventListener.php.

Member Function Documentation

createAppointments()

static ilCalendarAppEventListener::createAppointments (   $a_obj,   $a_appointments  )

static

Create appointments.

public

Parameters

Definition at line 190 of file class.ilCalendarAppEventListener.php.

References $DIC, ilCalendarCategories\_lookupCategoryIdByObjId(), and ilCalendarCategoryAssignments\addAssignment().

    {
        global $DIC;

        $logger = $DIC->logger()->cal();

        include_once('./Services/Calendar/classes/class.ilCalendarEntry.php');
        include_once('./Services/Calendar/classes/class.ilCalendarCategoryAssignments.php');
        include_once('./Services/Calendar/classes/class.ilCalendarCategories.php');
        
        if (!$cat_id = ilCalendarCategories::_lookupCategoryIdByObjId($a_obj->getId())) {
            $logger->warning('Cannot find calendar category for obj_id ' . $a_obj->getId());
            $cat_id = self::createCategory($a_obj);
        }
        
        foreach ($a_appointments as $app_templ) {
            $app = new ilCalendarEntry();
            $app->setContextId($app_templ->getContextId());
            $app->setContextInfo($app_templ->getContextInfo());
            $app->setTitle($app_templ->getTitle());
            $app->setSubtitle($app_templ->getSubtitle());
            $app->setDescription($app_templ->getDescription());
            $app->setFurtherInformations($app_templ->getInformation());
            $app->setLocation($app_templ->getLocation());
            $app->setStart($app_templ->getStart());
            $app->setEnd($app_templ->getEnd());
            $app->setFullday($app_templ->isFullday());
            $app->setAutoGenerated(true);
            $app->setTranslationType($app_templ->getTranslationType());
            $app->save();
            
            $ass = new ilCalendarCategoryAssignments($app->getEntryId());
            $ass->addAssignment($cat_id);
        }
    }

Here is the call graph for this function:

createCategory()

static ilCalendarAppEventListener::createCategory (   $a_obj,   $a_check_existing = false  )

static

Create a category for a new object (crs,grp, ...)

public

Parameters

object

ilias object ('crs','grp',...)

Definition at line 140 of file class.ilCalendarAppEventListener.php.

References $DIC, $lng, ilCalendarCategory\_getInstanceByObjId(), ilCalendarAppointmentColors\_getRandomColorByType(), and ilCalendarCategory\TYPE_OBJ.

    {
        global $DIC;

        $lng = $DIC['lng'];
        
        include_once('./Services/Calendar/classes/class.ilCalendarCategory.php');
        include_once('./Services/Calendar/classes/class.ilCalendarAppointmentColors.php');
        
        // already existing?  do update instead
        if ($a_check_existing &&
            ilCalendarCategory::_getInstanceByObjId($a_obj->getId())) {
            return self::updateCategory($a_obj);
        }
        
        $cat = new ilCalendarCategory();
        $cat->setTitle($a_obj->getTitle() ? $a_obj->getTitle() : $lng->txt('obj_' . $a_obj->getType()));
        $cat->setType(ilCalendarCategory::TYPE_OBJ);
        $cat->setColor(ilCalendarAppointmentColors::_getRandomColorByType($a_obj->getType()));
        $cat->setObjId($a_obj->getId());
        return $cat->add();
    }

Here is the call graph for this function:

deleteAppointments()

static ilCalendarAppEventListener::deleteAppointments (   $a_obj_id, array  $a_context_ids = null  )

static

Delete automatic generated appointments.

public

Parameters

int	obj_id
array	context ids

Definition at line 234 of file class.ilCalendarAppEventListener.php.

References ilCalendarEntry\_delete(), ilCalendarCategoryAssignments\_deleteByAppointmentId(), and ilCalendarCategoryAssignments\_getAutoGeneratedAppointmentsByObjId().

    {
        include_once('./Services/Calendar/classes/class.ilCalendarCategoryAssignments.php');
        include_once('./Services/Calendar/classes/class.ilCalendarEntry.php');
        
        foreach (ilCalendarCategoryAssignments::_getAutoGeneratedAppointmentsByObjId($a_obj_id) as $app_id) {
            // delete only selected entries
            if (is_array($a_context_ids)) {
                $entry = new ilCalendarEntry($app_id);
                if (!in_array($entry->getContextId(), $a_context_ids)) {
                    continue;
                }
            }
            
            ilCalendarCategoryAssignments::_deleteByAppointmentId($app_id);
            ilCalendarEntry::_delete($app_id);
        }
    }

Here is the call graph for this function:

deleteCategory()

static ilCalendarAppEventListener::deleteCategory (   $a_obj_id )

static

delete category

public

Parameters

Definition at line 261 of file class.ilCalendarAppEventListener.php.

References $DIC, and ilCalendarCategories\_lookupCategoryIdByObjId().

    {
        global $DIC;

        $logger = $DIC->logger()->cal();
        
        include_once('./Services/Calendar/classes/class.ilCalendarCategories.php');
        
        if (!$cat_id = ilCalendarCategories::_lookupCategoryIdByObjId($a_obj_id)) {
            $logger->warning('Cannot find calendar category for obj_id ' . $a_obj_id);
            return false;
        }
        
        $category = new ilCalendarCategory($cat_id);
        $category->delete();
    }

Here is the call graph for this function:

handleEvent()

static ilCalendarAppEventListener::handleEvent (   $a_component,   $a_event,   $a_parameter  )

static

Handle events like create, update, delete.

public

Parameters

string	$a_component	component, e.g. "Modules/Forum" or "Services/User"
string	$a_event	event e.g. "createUser", "updateUser", "deleteUser", ...
array	$a_parameter	parameter array (assoc), array("name" => ..., "phone_office" => ...) *

Implements ilAppEventListener.

Definition at line 46 of file class.ilCalendarAppEventListener.php.

References $DIC, $ilUser, ilCalendarCategories\deletePDItemsCache(), and ilCalendarCategories\deleteRepositoryCache().

    {
        global $DIC;

        $logger = $DIC->logger()->cal();
        $ilUser = $DIC['ilUser'];
        
        $delete_cache = false;
        
        switch ($a_component) {
            case 'Modules/Session':
            case 'Modules/Group':
            case 'Modules/Course':
                switch ($a_event) {
                    case 'create':
                        $logger->debug('Handling create event');
                        self::createCategory($a_parameter['object']);
                        self::createAppointments($a_parameter['object'], $a_parameter['appointments']);
                        $delete_cache = true;
                        break;
                    
                    case 'update':
                        $logger->debug('Handling update event');
                        self::updateCategory($a_parameter['object']);
                        self::deleteAppointments($a_parameter['obj_id']);
                        self::createAppointments($a_parameter['object'], $a_parameter['appointments']);
                        $delete_cache = true;
                        break;
                    
                    case 'delete':
                        $logger->debug('Handling delete event');
                        self::deleteCategory($a_parameter['obj_id']);
                        $delete_cache = true;
                        break;
                }
                break;
                
            case 'Services/Booking':
                switch ($a_event) {
                    case 'create':
                        break;
                    case 'update':
                        break;
                    case 'delete':
                        break;
                }
                break;
                
            case 'Modules/Exercise':
                switch ($a_event) {
                    case 'createAssignment':
                        $logger->debug('Handling create event (exercise assignment)');
                        self::createCategory($a_parameter['object'], true); // exercise category could already exist
                        self::createAppointments($a_parameter['object'], $a_parameter['appointments']);
                        $delete_cache = true;
                        break;
                    
                    case 'updateAssignment':
                        $logger->debug('Handling update event (exercise assignment)');
                        self::createCategory($a_parameter['object'], true); // different life-cycle than ilObject
                        self::deleteAppointments($a_parameter['obj_id'], $a_parameter['context_ids']);
                        self::createAppointments($a_parameter['object'], $a_parameter['appointments']);
                        $delete_cache = true;
                        break;
                    
                    case 'deleteAssignment':
                        $logger->debug('Handling delete event (exercise assignment)');
                        self::deleteAppointments($a_parameter['obj_id'], $a_parameter['context_ids']);
                        $delete_cache = true;
                        break;
                    
                    case 'delete':
                        $logger->debug(':Handling delete event');
                        self::deleteCategory($a_parameter['obj_id']);
                        $delete_cache = true;
                        break;
                }
                break;
        }
        
        if ($delete_cache) {
            include_once './Services/Calendar/classes/class.ilCalendarCategories.php';
            ilCalendarCategories::deletePDItemsCache($ilUser->getId());
            ilCalendarCategories::deleteRepositoryCache($ilUser->getId());
        }
    }

Here is the call graph for this function:

updateCategory()

static ilCalendarAppEventListener::updateCategory (   $a_obj )

static

Create a category for a new object (crs,grp, ...)

public

Parameters

object

ilias object ('crs','grp',...)

Definition at line 170 of file class.ilCalendarAppEventListener.php.

References ilCalendarCategory\_getInstanceByObjId().

    {
        include_once('./Services/Calendar/classes/class.ilCalendarCategory.php');
        include_once('./Services/Calendar/classes/class.ilCalendarAppointmentColors.php');
        
        if ($cat = ilCalendarCategory::_getInstanceByObjId($a_obj->getId())) {
            $cat->setTitle($a_obj->getTitle());
            $cat->update();
        }
        return true;
    }

Here is the call graph for this function:

---

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

• Services/Calendar/classes/class.ilCalendarAppEventListener.php