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 (string $a_component, string $a_event, array $a_parameter)
	Handle events like create, update, delete public. More...
static	createCategory (ilObject $a_obj, bool $a_check_existing=false)
	Create a category for a new object (crs,grp, ...) More...
static	updateCategory (ilObject $a_obj)
	Update category for a object (crs,grp, ...) More...
static	createAppointments (ilObject $a_obj, array $a_appointments)
	Create appointments. More...
static	deleteAppointments (int $a_obj_id, ?array $a_context_ids=null)
	Delete automatic generated appointments. More...
static	deleteCategory (int $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

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

Member Function Documentation

createAppointments()

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

static

Create appointments.

Parameters

ilObject
ilCalendarAppointmentTemplate[]

Returns

void

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

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

                                                                                     : void
    {
        global $DIC;

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

        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 ( ilObject  $a_obj, bool  $a_check_existing = false  )

static

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

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

References $DIC, $lng, ilCalendarCategory\_getInstanceByObjId(), ilCalendarAppointmentColors\_getRandomColorByType(), ilObject\getId(), ilObject\getTitle(), ilObject\getType(), and ilCalendarCategory\TYPE_OBJ.

                                                                                          : int
    {
        global $DIC;

        $lng = $DIC->language();

        // 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 ( int  $a_obj_id, ?array  $a_context_ids = null  )

static

Delete automatic generated appointments.

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

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

    {
        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 ( int  $a_obj_id )

static

delete category

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

References $DIC, and ilCalendarCategories\_lookupCategoryIdByObjId().

                                                        : void
    {
        global $DIC;

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

        if (!$cat_id = ilCalendarCategories::_lookupCategoryIdByObjId($a_obj_id)) {
            $logger->warning('Cannot find calendar category for obj_id ' . $a_obj_id);
            return;
        }

        $category = new ilCalendarCategory($cat_id);
        $category->delete();
    }

Here is the call graph for this function:

handleEvent()

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

static

Handle events like create, update, delete public.

Parameters

string	$a_component	component, e.g. "components/ILIAS/Forum" or "components/ILIAS/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 37 of file class.ilCalendarAppEventListener.php.

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

                                                                                                : void
    {
        global $DIC;

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

        $delete_cache = false;
        switch ($a_component) {
            case 'components/ILIAS/Session':
            case 'components/ILIAS/Group':
            case 'components/ILIAS/Course':
            case 'components/ILIAS/EmployeeTalk':
                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 'components/ILIAS/Booking':
                switch ($a_event) {
                    case 'create':
                    case 'delete':
                    case 'update':
                        break;
                }
                break;

            case 'components/ILIAS/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) {
            ilCalendarCategories::deletePDItemsCache($ilUser->getId());
            ilCalendarCategories::deleteRepositoryCache($ilUser->getId());
        }
    }

Here is the call graph for this function:

updateCategory()

static ilCalendarAppEventListener::updateCategory ( ilObject  $a_obj )

static

Update category for a object (crs,grp, ...)

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

References ilCalendarCategory\_getInstanceByObjId(), ilObject\getId(), and ilObject\getTitle().

                                                          : int
    {
        if ($cat = ilCalendarCategory::_getInstanceByObjId($a_obj->getId())) {
            $cat->setTitle($a_obj->getTitle());
            $cat->update();
            return $cat->getCategoryID();
        }
        return 0;
    }

Here is the call graph for this function:

---

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

• components/ILIAS/Calendar/classes/class.ilCalendarAppEventListener.php