class.ilObjOrgUnit.php

Go to the documentation of this file.

<?php

class ilObjOrgUnit extends ilContainer
{
    public const TABLE_NAME = 'orgu_data';
    protected static int $root_ref_id = 0;
    protected static int $root_id = 0;
    private ilDBInterface $ilDb;
    private ilAppEventHandler $ilAppEventHandler;
    private ilRbacReview $rbacreview;
    private ilRbacAdmin $rbacadmin;

    protected static ?array $icons_cache = null;
    protected int $orgu_type_id = 0;
    protected array $amd_data;

    public function __construct(int $a_id = 0, bool $a_call_by_reference = true)
    {
        global $DIC;

        $this->ilDb = $DIC->database();
        $this->type = "orgu";
        $this->ilAppEventHandler = $DIC->event();
        $this->rbacreview = $DIC->rbac()->review();
        $this->rbacadmin = $DIC->rbac()->admin();

        parent::__construct($a_id, $a_call_by_reference);
    }

    public function read(): void
    {
        parent::read();
        $sql = 'SELECT * FROM ' . self::TABLE_NAME . ' WHERE orgu_id = ' . $this->ilDb->quote($this->getId(), 'integer');
        $set = $this->ilDb->query($sql);
        if ($this->ilDb->numRows($set)) {
            $rec = $this->ilDb->fetchObject($set);
            $this->setOrgUnitTypeId($rec->orgu_type_id);
        }
    }

    public function create(): int
    {
        $id = parent::create();
        $this->ilDb->insert(self::TABLE_NAME, array(
            'orgu_type_id' => array('integer', $this->getOrgUnitTypeId()),
            'orgu_id' => array('integer', $this->getId()),
        ));
        return $id;
    }

    public function update(): bool
    {
        parent::update();
        $sql = 'SELECT * FROM ' . self::TABLE_NAME . ' WHERE orgu_id = ' . $this->ilDb->quote(
            $this->getId(),
            'integer'
        );
        $set = $this->ilDb->query($sql);
        if ($this->ilDb->numRows($set)) {
            $this->ilDb->update(self::TABLE_NAME, array(
                'orgu_type_id' => array('integer', $this->getOrgUnitTypeId()),
            ), array(
                'orgu_id' => array('integer', $this->getId()),
            ));
        } else {
            $this->ilDb->insert(self::TABLE_NAME, array(
                'orgu_type_id' => array('integer', $this->getOrgUnitTypeId()),
                'orgu_id' => array('integer', $this->getId()),
            ));
        }
        // Update selection for advanced meta data of the type
        if ($this->getOrgUnitTypeId()) {
            ilAdvancedMDRecord::saveObjRecSelection(
                $this->getId(),
                'orgu_type',
                $this->getOrgUnitType()->getAssignedAdvancedMDRecordIds()
            );
        } else {
            // If no type is assigned, delete relations by passing an empty array
            ilAdvancedMDRecord::saveObjRecSelection($this->getId(), 'orgu_type', array());
        }

        return true;
    }

    public function getOrgUnitTypeId(): int
    {
        return $this->orgu_type_id;
    }

    public function getOrgUnitType(): ?ilOrgUnitType
    {
        return ilOrgUnitType::getInstance($this->getOrgUnitTypeId());
    }

    public function setOrgUnitTypeId(int $a_id): void
    {
        $this->orgu_type_id = $a_id;
    }

    public function getAdvancedMDValues(int $a_record_id = 0): array
    {
        if (!$this->getOrgUnitTypeId()) {
            return array();
        }
        // Serve from cache?
        if (is_array($this->amd_data)) {
            if ($a_record_id) {
                return $this->amd_data[$a_record_id] ?? array();
            } else {
                return $this->amd_data;
            }
        }
        foreach (ilAdvancedMDValues::getInstancesForObjectId($this->getId(), 'orgu') as $record_id => $amd_values) {
            $amd_values = new ilAdvancedMDValues($record_id, $this->getId(), 'orgu_type', $this->getOrgUnitTypeId());
            $amd_values->read();
            $this->amd_data[$record_id] = $amd_values->getADTGroup()->getElements();
        }
        if ($a_record_id) {
            return $this->amd_data[$a_record_id] ?? array();
        } else {
            return $this->amd_data;
        }
    }

    public static function getIconsCache(): array
    {
        if (is_array(self::$icons_cache)) {
            return self::$icons_cache;
        }
        global $DIC;
        $ilDb = $DIC->database();
        $sql = 'SELECT orgu_id, ot.id AS type_id FROM orgu_data
                INNER JOIN orgu_types AS ot ON (ot.id = orgu_data.orgu_type_id)
                WHERE ot.icon IS NOT NULL';
        $set = $ilDb->query($sql);
        $icons_cache = array();
        while ($row = $ilDb->fetchObject($set)) {
            $type = ilOrgUnitType::getInstance($row->type_id);
            if ($type && is_file($type->getIconPath(true))) {
                $icons_cache[$row->orgu_id] = $type->getIconPath(true);
            }
        }
        self::$icons_cache = $icons_cache;

        return $icons_cache;
    }

    public static function getRootOrgRefId(): int
    {
        self::loadRootOrgRefIdAndId();

        return self::$root_ref_id;
    }

    public static function getRootOrgId(): int
    {
        self::loadRootOrgRefIdAndId();

        return self::$root_id;
    }

    private static function loadRootOrgRefIdAndId(): void
    {
        if (self::$root_ref_id === 0 || self::$root_id === 0) {
            global $DIC;
            $ilDb = $DIC['ilDB'];
            $q = "SELECT o.obj_id, r.ref_id FROM object_data o
                        INNER JOIN object_reference r ON r.obj_id = o.obj_id
                        WHERE title = " . $ilDb->quote('__OrgUnitAdministration', 'text') . "";
            $set = $ilDb->query($q);
            $res = $ilDb->fetchAssoc($set);
            self::$root_id = (int) $res["obj_id"];
            self::$root_ref_id = (int) $res["ref_id"];
        }
    }

    public function assignUsersToEmployeeRole(array $user_ids): void
    {
        $position_id = ilOrgUnitPosition::getCorePositionId(ilOrgUnitPosition::CORE_POSITION_EMPLOYEE);

        foreach ($user_ids as $user_id) {
            ilOrgUnitUserAssignment::findOrCreateAssignment($user_id, $position_id, $this->getRefId());

            $this->ilAppEventHandler->raise('Modules/OrgUnit', 'assignUsersToEmployeeRole', array(
                'object' => $this,
                'obj_id' => $this->getId(),
                'ref_id' => $this->getRefId(),
                'position_id' => $position_id,
                'user_id' => $user_id,
            ));
        }
    }

    public function assignUsersToSuperiorRole(array $user_ids): void
    {
        $position_id = ilOrgUnitPosition::getCorePositionId(ilOrgUnitPosition::CORE_POSITION_SUPERIOR);

        foreach ($user_ids as $user_id) {
            ilOrgUnitUserAssignment::findOrCreateAssignment($user_id, $position_id, $this->getRefId());

            $this->ilAppEventHandler->raise('Modules/OrgUnit', 'assignUsersToSuperiorRole', array(
                'object' => $this,
                'obj_id' => $this->getId(),
                'ref_id' => $this->getRefId(),
                'position_id' => $position_id,
                'user_id' => $user_id,
            ));
        }
    }

    public function deassignUserFromEmployeeRole(int $user_id): void
    {
        $position_id = ilOrgUnitPosition::getCorePositionId(ilOrgUnitPosition::CORE_POSITION_EMPLOYEE);
        ilOrgUnitUserAssignment::findOrCreateAssignment($user_id, $position_id, $this->getRefId())->delete();

        $this->ilAppEventHandler->raise('Modules/OrgUnit', 'deassignUserFromEmployeeRole', array(
            'object' => $this,
            'obj_id' => $this->getId(),
            'ref_id' => $this->getRefId(),
            'position_id' => $position_id,
            'user_id' => $user_id,
        ));
    }

    public function deassignUserFromSuperiorRole(int $user_id): void
    {
        $position_id = ilOrgUnitPosition::getCorePositionId(ilOrgUnitPosition::CORE_POSITION_SUPERIOR);
        ilOrgUnitUserAssignment::findOrCreateAssignment($user_id, $position_id, $this->getRefId())->delete();

        $this->ilAppEventHandler->raise('Modules/OrgUnit', 'deassignUserFromSuperiorRole', array(
            'object' => $this,
            'obj_id' => $this->getId(),
            'ref_id' => $this->getRefId(),
            'position_id' => $position_id,
            'user_id' => $user_id,
        ));
    }

    public function assignUserToLocalRole(int $role_id, int $user_id): bool
    {
        $arrLocalRoles = $this->rbacreview->getLocalRoles($this->getRefId());
        if (!in_array($role_id, $arrLocalRoles)) {
            return false;
        }

        $return = $this->rbacadmin->assignUser($role_id, $user_id);

        $this->ilAppEventHandler->raise('Modules/OrgUnit', 'assignUserToLocalRole', array(
            'object' => $this,
            'obj_id' => $this->getId(),
            'ref_id' => $this->getRefId(),
            'role_id' => $role_id,
            'user_id' => $user_id,
        ));

        return $return;
    }

    public function deassignUserFromLocalRole(int $role_id, int $user_id): bool
    {
        $arrLocalRoles = $this->rbacreview->getLocalRoles($this->getRefId());
        if (!in_array($role_id, $arrLocalRoles)) {
            return false;
        }

        $return = $this->rbacadmin->deassignUser($role_id, $user_id);

        $this->ilAppEventHandler->raise('Modules/OrgUnit', 'deassignUserFromLocalRole', array(
            'object' => $this,
            'obj_id' => $this->getId(),
            'ref_id' => $this->getRefId(),
            'role_id' => $role_id,
            'user_id' => $user_id,
        ));

        return $return;
    }

    public static function _exists(int $id, bool $isReference = false, ?string $type = "orgu"): bool
    {
        return parent::_exists($id, $isReference, "orgu");
    }

    public function getTitle(): string
    {
        if (parent::getTitle() !== "__OrgUnitAdministration") {
            return parent::getTitle();
        } else {
            return $this->lng->txt("objs_orgu");
        }
    }

    public function getLongDescription(): string
    {
        if (parent::getTitle() === "__OrgUnitAdministration") {
            return $this->lng->txt("obj_orgu_description");
        } else {
            return parent::getLongDescription();
        }
    }

    public function getTranslations()
    {
        $q = "SELECT * FROM object_translation WHERE obj_id = " . $this->ilDb->quote(
            $this->getId(),
            'integer'
        ) . " ORDER BY lang_default DESC";
        $r = $this->db->query($q);

        $data = [];
        while ($row = $r->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $data[$row->lang_code] = array(
                "title" => $row->title,
                "desc" => $row->description,
                "lang" => $row->lang_code,
                'default' => $row->lang_default,
            );
        }

        $translations = $data;

        if (!count($translations)) {
            $this->addTranslation($this->getTitle(), "", $this->lng->getDefaultLanguage(), true);
            $translations[$this->lng->getDefaultLanguage()] = array(
                "title" => $this->getTitle(),
                "desc" => "",
                "lang" => $this->lng->getDefaultLanguage(),
            );
        }

        return $translations;
    }

    public function delete(): bool
    {
        // always call parent delete function first!!
        if (!parent::delete()) {
            return false;
        }

        // put here category specific stuff
        ilObjUserFolder::_updateUserFolderAssignment($this->ref_id, USER_FOLDER_ID);

        $query = "DELETE FROM object_translation WHERE obj_id = " . $this->ilDb->quote($this->getId(), 'integer');
        $this->ilDb->manipulate($query);

        $this->ilAppEventHandler->raise('Modules/OrgUnit', 'delete', array(
            'object' => $this,
            'obj_id' => $this->getId(),
        ));

        $sql = 'DELETE FROM ' . self::TABLE_NAME . ' WHERE orgu_id = ' . $this->ilDb->quote($this->getId(), 'integer');
        $this->ilDb->manipulate($sql);

        $path = ilOrgUnitPathStorage::find($this->getRefId());
        if ($path instanceof ilOrgUnitPathStorage) {
            $path->delete();
        }

        // Delete all position assignments to this object.
        $assignments = ilOrgUnitUserAssignment::where(array(
            'orgu_id' => $this->getRefId(),
        ))->get();
        foreach ($assignments as $assignment) {
            $assignment->delete();
        }

        return true;
    }

    public function removeTranslations(): void
    {
        $query = "DELETE FROM object_translation WHERE obj_id= " . $this->ilDb->quote($this->getId(), 'integer');
        $res = $this->ilDb->manipulate($query);
    }

    public function deleteTranslation(string $a_lang): void
    {
        $query = "DELETE FROM object_translation WHERE obj_id= " . $this->quote(
            $this->getId(),
            'integer'
        ) . " AND lang_code = "
            . $this->quote($a_lang, 'text');
        $this->ilDb->manipulate($query);
    }

    public function addTranslation(string $a_title, string $a_desc, string $a_lang, string $a_lang_default): void
    {
        if (empty($a_title)) {
            $a_title = "NO TITLE";
        }

        $query = "INSERT INTO object_translation " . "(obj_id,title,description,lang_code,lang_default) " . "VALUES " . "("
            . $this->ilDb->quote($this->getId(), 'integer') . "," . $this->ilDb->quote(
                $a_title,
                'text'
            ) . "," . $this->ilDb->quote($a_desc, 'text') . ","
            . $this->ilDb->quote($a_lang, 'text') . "," . $this->ilDb->quote($a_lang_default, 'integer') . ")";
        $this->ilDb->manipulate($query);
    }

    public function updateTranslation(string $title, string $desc, string $lang, string $lang_default): void
    {
        if (empty($title)) {
            $a_title = "NO TITLE";
        }

        $query = "UPDATE object_translation SET ";

        $query .= " title = " . $this->ilDb->quote($title, 'text');

        if ($desc !== "") {
            $query .= ", description = " . $this->ilDb->quote($desc, 'text') . " ";
        }

        $query .= ", lang_default = " . $this->ilDb->quote($lang_default, 'integer') . " ";

        $query .= " WHERE obj_id = " . $this->ilDb->quote(
            $this->getId(),
            'integer'
        ) . " AND lang_code = " . $this->ilDb->quote($lang, 'text');
        $this->ilDb->manipulate($query);
    }

    public function writePath(): void
    {
        if ($this->getRefId()) {
            ilOrgUnitPathStorage::writePathByRefId($this->getRefId());
        } else {
            throw new \LogicException('No ref_id on OrgU with id ' . $this->getId(), 1);
        }
    }
}