ilLSEventHandler Class Reference

Handle events. More...

Collaboration diagram for ilLSEventHandler:

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

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_if More...
	getRefIdsOfObjId (int $triggerer_obj_id)
	getInstanceByRefId (int $ref_id)
	getInstanceByObjId (int $obj_id)

Protected Attributes
	$tree

Detailed Description

Handle events.

Author

Nils Haagen nils..nosp@m.haag.nosp@m.en@co.nosp@m.ncep.nosp@m.ts-an.nosp@m.d-tr.nosp@m.ainin.nosp@m.g.de

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

Constructor & Destructor Documentation

__construct()

ilLSEventHandler::__construct

(

ilTree

$tree

)

Definition at line 17 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 67 of file class.ilLSEventHandler.php.

References getInstanceByRefId().

Referenced by handleObjectDeletion(), and handleObjectToTrash().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getInstanceByObjId()

ilLSEventHandler::getInstanceByObjId ( int  $obj_id )

protected

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

References ilObject\_getAllReferences(), and getInstanceByRefId().

Referenced by handleParticipantDeletion().

                                                       : ilObjLearningSequence
    {
        $refs = \ilObject::_getAllReferences($obj_id);
        $ref_id = array_shift(array_keys($refs));
        return $this->getInstanceByRefId($ref_id);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getInstanceByRefId()

ilLSEventHandler::getInstanceByRefId ( int  $ref_id )

protected

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

References ilObjectFactory\getInstanceByRefId().

Referenced by deleteLSOItem(), and getInstanceByObjId().

                                                       : ilObject
    {
        return ilObjectFactory::getInstanceByRefId($ref_id);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getParentLSOInfo()

ilLSEventHandler::getParentLSOInfo ( int  $child_ref_id )

protected

get the LSO up from $child_ref_if

Returns

int | false;

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

Referenced by handleObjectDeletion(), and handleObjectToTrash().

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

Here is the caller graph for this function:

getRefIdsOfObjId()

ilLSEventHandler::getRefIdsOfObjId ( int  $triggerer_obj_id )

protected

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

References ilObject\_getAllReferences().

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

Here is the call graph for this function:

handleObjectDeletion()

ilLSEventHandler::handleObjectDeletion

(

array

$parameter

)

Find out, if a subobject is about to be deleted.

cleanup states.

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

References deleteLSOItem(), getParentLSOInfo(), and isExistingObject().

    {
        $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 ($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 44 of file class.ilLSEventHandler.php.

References deleteLSOItem(), getParentLSOInfo(), and isExistingObject().

    {
        $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) || !$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 76 of file class.ilLSEventHandler.php.

References getInstanceByObjId().

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

Here is the call graph for this function:

isExistingObject()

ilLSEventHandler::isExistingObject ( int  $ref_id )

protected

Definition at line 59 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

ilLSEventHandler::$tree

protected

Definition at line 15 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