class.ilLSEventHandler.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilLSEventHandler
{
    protected ilTree $tree;

    public function __construct(ilTree $tree)
    {
        $this->tree = $tree;
    }

    public function handleObjectDeletion(array $parameter): 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']);
        }
    }

    public function handleObjectToTrash(array $parameter): 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);
        }
    }

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

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

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

    public function handleClonedObject(ilObject $new_obj, ilObject $origin_obj): 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]);
        }
    }

    protected function getParentLSOInfo(int $child_ref_id): ?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;
    }

    protected function getRefIdsOfObjId(int $triggerer_obj_id): array
    {
        return ilObject::_getAllReferences($triggerer_obj_id);
    }

    protected function getInstanceByRefId(int $ref_id): ilObjLearningSequence
    {
        $obj = ilObjectFactory::getInstanceByRefId($ref_id);

        if (!$obj instanceof ilObjLearningSequence) {
            throw new LogicException("Object type should be ilObjLearningSequence. Actually is " . get_class($obj));
        }

        return $obj;
    }

    protected function getInstanceByObjId(int $obj_id): ilObjLearningSequence
    {
        $refs = array_keys(\ilObject::_getAllReferences($obj_id));
        $ref_id = array_shift($refs);

        $obj = ilObjectFactory::getInstanceByRefId($ref_id);

        if (!$obj instanceof ilObjLearningSequence) {
            throw new LogicException("Object type should be ilObjLearningSequence. Actually is " . get_class($obj));
        }

        return $obj;
    }
}