ilLSEventHandler Class Reference

Handle events. More...

Collaboration diagram for ilLSEventHandler:

Public Member Functions
	__construct (ilTree $tree)
	handleObjectDeletion (array $parameter)
	Find out, if a sub object is about to be deleted. More...
	handleObjectToTrash (array $parameter)
	handleParticipantDeletion (int $obj_id, int $usr_id)
	handleClonedObject (ilObject $new_obj, ilObject $origin_obj)

Protected Member Functions
	isExistingObject (int $ref_id)
	deleteLSOItem (int $obj_ref_id, int $parent_lso_ref_id)
	getParentLSOInfo (int $child_ref_id)
	get the LSO up from $child_ref_id More...
	getRefIdsOfObjId (int $triggerer_obj_id)

Protected Attributes
ilTree	$tree

Detailed Description

Handle events.

Definition at line 24 of file class.ilLSEventHandler.php.

Constructor & Destructor Documentation

__construct()

ilLSEventHandler::__construct

(

ilTree

$tree

)

Definition at line 28 of file class.ilLSEventHandler.php.

References $tree.

    {
        $this->tree = $tree;
    }

Member Function Documentation

deleteLSOItem()

ilLSEventHandler::deleteLSOItem ( int  $obj_ref_id, int  $parent_lso_ref_id  )

protected

Definition at line 78 of file class.ilLSEventHandler.php.

Referenced by handleObjectDeletion(), and handleObjectToTrash().

                                                                             : void
    {
        $lso = $this->getInstanceByRefId($parent_lso_ref_id);
        $lso->getStateDB()->deleteForItem(
            $parent_lso_ref_id,
            $obj_ref_id
        );
    }

Here is the caller graph for this function:

getParentLSOInfo()

ilLSEventHandler::getParentLSOInfo ( int  $child_ref_id )

protected

get the LSO up from $child_ref_id

Definition at line 112 of file class.ilLSEventHandler.php.

Referenced by handleClonedObject(), handleObjectDeletion(), and handleObjectToTrash().

                                                          : ?array
    {
        if ($child_ref_id === 0) {
            return null;
        }

        foreach ($this->tree->getPathFull($child_ref_id) as $hop) {
            if ($hop['type'] === 'lso') {
                return $hop;
            }
        }
        return null;
    }

Here is the caller graph for this function:

getRefIdsOfObjId()

ilLSEventHandler::getRefIdsOfObjId ( int  $triggerer_obj_id )

protected

Returns

array<int|string, int|string>

Definition at line 129 of file class.ilLSEventHandler.php.

References $ref_id, ilObject\_getAllReferences(), and ilObjectFactory\getInstanceByRefId().

                                                              : array
    {
        return ilObject::_getAllReferences($triggerer_obj_id);
    }

Here is the call graph for this function:

handleClonedObject()

ilLSEventHandler::handleClonedObject	(	ilObject	$new_obj,
		ilObject	$origin_obj
	)

Definition at line 94 of file class.ilLSEventHandler.php.

References getParentLSOInfo(), and ilObject\getRefId().

                                                                               : void
    {
        if ($this->getParentLSOInfo($new_obj->getRefId())
            && $this->getParentLSOInfo($origin_obj->getRefId())
        ) {
            $new_lso = $this->getInstanceByRefId(
                (int) $this->getParentLSOInfo($new_obj->getRefId())['ref_id']
            );
            $post_condition_db = $new_lso->getDI()['db.postconditions'];
            $post_condition = current($post_condition_db->select([$origin_obj->getRefId()]))
                ->withRefId($new_obj->getRefId());
            $post_condition_db->upsert([$post_condition]);
        }
    }

Here is the call graph for this function:

handleObjectDeletion()

ilLSEventHandler::handleObjectDeletion

(

array

$parameter

)

Find out, if a sub object is about to be deleted.

cleanup states.

Definition at line 37 of file class.ilLSEventHandler.php.

References deleteLSOItem(), getParentLSOInfo(), ILIAS\Repository\int(), and isExistingObject().

                                                          : void
    {
        $obj_deleted = $parameter['object'];
        $obj_ref_id = (int) $obj_deleted->getRefId();

        if (!$this->isExistingObject($obj_ref_id)) {
            return;
        }

        $parent_lso = $this->getParentLSOInfo($obj_ref_id);
        if (!is_null($parent_lso)) {
            $this->deleteLSOItem($obj_ref_id, (int) $parent_lso['ref_id']);
        }
    }

Here is the call graph for this function:

handleObjectToTrash()

ilLSEventHandler::handleObjectToTrash

(

array

$parameter

)

Parameters

array

$parameter

[obj_id, ref_id, old_parent_ref_id]

Definition at line 55 of file class.ilLSEventHandler.php.

References deleteLSOItem(), getParentLSOInfo(), ILIAS\Repository\int(), and isExistingObject().

                                                         : void
    {
        $obj_ref_id = (int) $parameter['ref_id'];
        $old_parent_ref_id = (int) $parameter['old_parent_ref_id'];
        $parent_lso = $this->getParentLSOInfo($obj_ref_id);

        if (!$this->isExistingObject($obj_ref_id) || is_null($parent_lso)) {
            return;
        }

        if ($old_parent_ref_id) {
            $this->deleteLSOItem($obj_ref_id, $old_parent_ref_id);
        }
    }

Here is the call graph for this function:

handleParticipantDeletion()

ilLSEventHandler::handleParticipantDeletion	(	int	$obj_id,
		int	$usr_id
	)

Definition at line 87 of file class.ilLSEventHandler.php.

                                                                       : void
    {
        $lso = $this->getInstanceByObjId($obj_id);
        $db = $lso->getStateDB();
        $db->deleteFor($lso->getRefId(), [$usr_id]);
    }

isExistingObject()

ilLSEventHandler::isExistingObject ( int  $ref_id )

protected

Definition at line 70 of file class.ilLSEventHandler.php.

Referenced by handleObjectDeletion(), and handleObjectToTrash().

                                                    : bool
    {
        if (empty($ref_id) || !$this->tree->isInTree($ref_id)) {
            return false;
        }
        return true;
    }

Here is the caller graph for this function:

Field Documentation

$tree

ilTree ilLSEventHandler::$tree

protected

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

Referenced by __construct().

---

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

• Modules/LearningSequence/classes/class.ilLSEventHandler.php