class.ilWorkspaceTree.php

Go to the documentation of this file.

<?php

class ilWorkspaceTree extends ilTree
{
    public function __construct(
        int $a_tree_id,
        int $a_root_id = 0
    ) {
        global $DIC;

        parent::__construct($a_tree_id, $a_root_id);
        $this->setTableNames('tree_workspace', 'object_data', 'object_reference_ws');
        $this->setTreeTablePK('tree');
        $this->setObjectTablePK('obj_id');
        $this->setReferenceTablePK('wsp_id');

        if (!$this->exists()) {
            $this->createTreeForUser($a_tree_id);
        }

        // ilTree sets it to ROOT_FOLDER_ID if not given...
        if (!$a_root_id) {
            $this->readRootId();
        }
    }

    protected function exists(): bool
    {
        $db = $this->db;
        $set = $db->queryF(
            "SELECT * FROM tree_workspace " .
            " WHERE tree = %s ",
            ["integer"],
            [$this->getTreeId()]
        );
        if ($rec = $db->fetchAssoc($set)) {
            return true;
        }
        return false;
    }

    public function createReference(int $a_object_id): int
    {
        $ilDB = $this->db;

        $next_id = $ilDB->nextId($this->table_obj_reference);

        $fields = array($this->ref_pk => array("integer", $next_id),
            $this->obj_pk => array("integer", $a_object_id));

        $ilDB->insert($this->table_obj_reference, $fields);

        return $next_id;
    }

    public function lookupObjectId(int $a_node_id): int
    {
        $ilDB = $this->db;

        $set = $ilDB->query("SELECT " . $this->obj_pk .
            " FROM " . $this->table_obj_reference .
            " WHERE " . $this->ref_pk . " = " . $ilDB->quote($a_node_id, "integer"));
        $res = $ilDB->fetchAssoc($set);

        return (int) ($res[$this->obj_pk] ?? 0);
    }


    public function lookupNodeId(int $a_obj_id): int
    {
        $ilDB = $this->db;

        $set = $ilDB->query("SELECT " . $this->ref_pk .
            " FROM " . $this->table_obj_reference .
            " WHERE " . $this->obj_pk . " = " . $ilDB->quote($a_obj_id, "integer"));
        $res = $ilDB->fetchAssoc($set);

        return (int) ($res[$this->ref_pk] ?? 0);
    }

    public function lookupOwner(int $a_node_id): int
    {
        $ilDB = $this->db;

        $set = $ilDB->query("SELECT tree" .
            " FROM " . $this->table_obj_reference .
            " JOIN " . $this->table_tree . " ON (" . $this->table_obj_reference . "." . $this->ref_pk . " = " . $this->table_tree . ".child)" .
            " WHERE " . $this->ref_pk . " = " . $ilDB->quote($a_node_id, "integer"));
        $res = $ilDB->fetchAssoc($set);

        return (int) ($res["tree"] ?? 0);
    }

    public function insertObject(
        int $a_parent_node_id,
        int $a_object_id
    ): int {
        $node_id = $this->createReference($a_object_id);
        $this->insertNode($node_id, $a_parent_node_id);
        return $node_id;
    }

    public function deleteReference(int $a_node_id): int
    {
        $ilDB = $this->db;

        $query = "DELETE FROM " . $this->table_obj_reference .
            " WHERE " . $this->ref_pk . " = " . $ilDB->quote($a_node_id, "integer");
        return $ilDB->manipulate($query);
    }

    public function cascadingDelete(): void
    {
        $root_id = $this->readRootId();
        if (!$root_id) {
            return;
        }

        $root = $this->getNodeData($root_id);

        $access_handler = new ilWorkspaceAccessHandler($this);

        // delete node data
        $nodes = $this->getSubTree($root);
        foreach ($nodes as $node) {
            $access_handler->removePermission($node["wsp_id"]);

            $object = ilObjectFactory::getInstanceByObjId($node["obj_id"], false);
            if ($object) {
                $object->delete();
            }

            $this->deleteReference($node["wsp_id"]);
        }

        $this->deleteTree($root);
    }

    public function getObjectsFromType(
        string $a_type,
        bool $a_with_data = false
    ): array {
        return $this->getSubTree(
            $this->getNodeData($this->getRootId()),
            $a_with_data,
            [$a_type]
        );
    }

    public function createTreeForUser(int $a_user_id): void
    {
        $root = ilObjectFactory::getClassByType("wsrt");
        $root = new $root(0);
        $root->create();

        $root_id = $this->createReference($root->getId());
        $this->addTree($a_user_id, $root_id);
        $this->setRootId($root_id);
    }
}