class.ilObjOrgUnit.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2013 ILIAS open source, Extended GPL, see docs/LICENSE */
require_once "./Services/Container/classes/class.ilContainer.php";
require_once("./Modules/OrgUnit/classes/class.ilOrgUnitImporter.php");
require_once('./Modules/OrgUnit/classes/Types/class.ilOrgUnitType.php');
require_once('./Services/AdvancedMetaData/classes/class.ilAdvancedMDValues.php');
require_once('./Services/AdvancedMetaData/classes/class.ilAdvancedMDRecord.php');
require_once('./Modules/OrgUnit/classes/PathStorage/class.ilOrgUnitPathStorage.php');

class ilObjOrgUnit extends ilContainer {

        const TABLE_NAME = 'orgu_data';
        protected static $root_ref_id;
        protected static $root_id;
        protected $employee_role;
        protected $superior_role;
        protected static $icons_cache;
        protected $orgu_type_id = 0;
        protected $amd_data;


        public function __construct($a_id = 0, $a_call_by_reference = true) {
                $this->type = "orgu";
                parent::__construct($a_id, $a_call_by_reference);
        }


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


        public function create() {
                global $DIC;
                $ilDB = $DIC['ilDB'];
                parent::create();
                $ilDB->insert(self::TABLE_NAME, array(
                        'orgu_type_id' => array( 'integer', $this->getOrgUnitTypeId() ),
                        'orgu_id'      => array( 'integer', $this->getId() ),
                ));
        }


        public function update() {
                global $DIC;
                $ilDB = $DIC['ilDB'];
                parent::update();
                $sql = 'SELECT * FROM ' . self::TABLE_NAME . ' WHERE orgu_id = '
                       . $ilDB->quote($this->getId(), 'integer');
                $set = $ilDB->query($sql);
                if ($ilDB->numRows($set)) {
                        $ilDB->update(self::TABLE_NAME, array(
                                'orgu_type_id' => array( 'integer', $this->getOrgUnitTypeId() ),
                        ), array(
                                'orgu_id' => array( 'integer', $this->getId() ),
                        ));
                } else {
                        $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());
                }
        }


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


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


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


        public function getAdvancedMDValues($a_record_id = 0) {
                if (!$this->getOrgUnitTypeId()) {
                        return array();
                }
                // Serve from cache?
                if (is_array($this->amd_data)) {
                        if ($a_record_id) {
                                return (isset($this->amd_data[$a_record_id])) ? $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 (isset($this->amd_data[$a_record_id])) ? $this->amd_data[$a_record_id] : array();
                } else {
                        return $this->amd_data;
                }
        }


        public static function getIconsCache() {
                if (is_array(self::$icons_cache)) {
                        return self::$icons_cache;
                }
                global $DIC;
                $ilDB = $DIC['ilDB'];
                $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() {
                self::loadRootOrgRefIdAndId();

                return self::$root_ref_id;
        }


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

                return self::$root_id;
        }


        private static function loadRootOrgRefIdAndId() {
                if (self::$root_ref_id === null || self::$root_id === null) {
                        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 = $res["obj_id"];
                        self::$root_ref_id = $res["ref_id"];
                }
        }


        private function loadRoles() {
                global $DIC;
                $ilLog = $DIC['ilLog'];
                if (!$this->employee_role || !$this->superior_role) {
                        $this->doLoadRoles();
                }

                if (!$this->employee_role || !$this->superior_role) {
                        $this->initDefaultRoles();
                        $this->doLoadRoles();
                        if (!$this->employee_role || !$this->superior_role) {
                                throw new Exception("The standard roles the orgu object with id: " . $this->getId()
                                                    . " aren't initialized or have been deleted, newly creating them didn't work!");
                        } else {
                                $ilLog->write("[" . __FILE__ . ":" . __LINE__
                                              . "] The standard roles for the orgu obj with id: " . $this->getId()
                                              . " were newly created as they couldnt be found.");
                        }
                }
        }


        private function doLoadRoles() {
                global $DIC;
                $ilDB = $DIC['ilDB'];
                if (!$this->employee_role || !$this->superior_role) {
                        $q = "SELECT obj_id, title FROM object_data WHERE title = 'il_orgu_employee_"
                             . $ilDB->quote($this->getRefId(), "integer") . "' OR title = 'il_orgu_superior_"
                             . $ilDB->quote($this->getRefId(), "integer") . "'";
                        $set = $ilDB->query($q);
                        while ($res = $ilDB->fetchAssoc($set)) {
                                if ($res["title"] == "il_orgu_employee_" . $this->getRefId()) {
                                        $this->employee_role = $res["obj_id"];
                                } elseif ($res["title"] == "il_orgu_superior_" . $this->getRefId()) {
                                        $this->superior_role = $res["obj_id"];
                                }
                        }

                        if (!$this->employee_role || !$this->superior_role) {
                                throw new Exception("The standard roles the orgu object with id: " . $this->getId()
                                                    . " aren't initialized or have been deleted!");
                        }
                }
        }


        public function assignUsersToEmployeeRole($user_ids) {
                global $DIC;
                $rbacadmin = $DIC['rbacadmin'];
                $ilAppEventHandler = $DIC['ilAppEventHandler'];
                foreach ($user_ids as $user_id) {
                        $rbacadmin->assignUser($this->getEmployeeRole(), $user_id);

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


        public function assignUsersToSuperiorRole($user_ids) {
                global $DIC;
                $rbacadmin = $DIC['rbacadmin'];
                $ilAppEventHandler = $DIC['ilAppEventHandler'];
                foreach ($user_ids as $user_id) {
                        $rbacadmin->assignUser($this->getSuperiorRole(), $user_id);

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


        public function deassignUserFromEmployeeRole($user_id) {
                global $DIC;
                $rbacadmin = $DIC['rbacadmin'];
                $ilAppEventHandler = $DIC['ilAppEventHandler'];
                $rbacadmin->deassignUser($this->getEmployeeRole(), $user_id);

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


        public function deassignUserFromSuperiorRole($user_id) {
                global $DIC;
                $rbacadmin = $DIC['rbacadmin'];
                $ilAppEventHandler = $DIC['ilAppEventHandler'];
                $rbacadmin->deassignUser($this->getSuperiorRole(), $user_id);

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


        public function assignUserToLocalRole($role_id, $user_id) {
                global $DIC;
                $rbacreview = $DIC['rbacreview'];
                $rbacadmin = $DIC['rbacadmin'];
                $ilAppEventHandler = $DIC['ilAppEventHandler'];

                $arrLocalRoles = $rbacreview->getLocalRoles($this->getRefId());
                if (!in_array($role_id, $arrLocalRoles)) {
                        return false;
                }

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

                $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($role_id, $user_id) {
                global $DIC;
                $rbacreview = $DIC['rbacreview'];
                $rbacadmin = $DIC['rbacadmin'];
                $ilAppEventHandler = $DIC['ilAppEventHandler'];

                $arrLocalRoles = $rbacreview->getLocalRoles($this->getRefId());
                if (!in_array($role_id, $arrLocalRoles)) {
                        return false;
                }

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

                $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 function setEmployeeRole($employee_role) {
                $this->employee_role = $employee_role;
        }


        public static function _exists($a_id, $a_reference = false, $type = "orgu") {
                return parent::_exists($a_id, $a_reference, "orgu");
        }


        public function getEmployeeRole() {
                $this->loadRoles();

                return $this->employee_role;
        }


        public function setSuperiorRole($superior_role) {
                $this->superior_role = $superior_role;
        }


        public function getSuperiorRole() {
                $this->loadRoles();

                return $this->superior_role;
        }


        public function initDefaultRoles() {
                global $DIC;
                $ilAppEventHandler = $DIC['ilAppEventHandler'];

                include_once './Services/AccessControl/classes/class.ilObjRole.php';
                $role_emp = ilObjRole::createDefaultRole('il_orgu_employee_'
                                                         . $this->getRefId(), "Emplyee of org unit obj_no."
                                                                              . $this->getId(), 'il_orgu_employee', $this->getRefId());

                $role_sup = ilObjRole::createDefaultRole('il_orgu_superior_'
                                                         . $this->getRefId(), "Superior of org unit obj_no."
                                                                              . $this->getId(), 'il_orgu_superior', $this->getRefId());

                $ilAppEventHandler->raise('Modules/OrgUnit', 'initDefaultRoles', array(
                        'object'           => $this,
                        'obj_id'           => $this->getId(),
                        'ref_id'           => $this->getRefId(),
                        'role_superior_id' => $role_sup->getId(),
                        'role_employee_id' => $role_emp->getId(),
                ));
        }


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


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


        public function getTranslations() {
                global $DIC;
                $lng = $DIC['lng'];
                $ilDB = $DIC['ilDB'];

                $translations = array();

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

                $num = 0;

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

                $translations = $data;

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

                return $translations;
        }


        public function delete() {
                global $DIC;
                $ilDB = $DIC['ilDB'];
                $ilAppEventHandler = $DIC['ilAppEventHandler'];

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

                // put here category specific stuff
                include_once('./Services/User/classes/class.ilObjUserFolder.php');
                ilObjUserFolder::_updateUserFolderAssignment($this->ref_id, USER_FOLDER_ID);

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

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

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

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

                if (!$this->employee_role || !$this->superior_role) {
                        $this->doLoadRoles();
                }
                $emp = new ilObjRole($this->employee_role);
                $emp->setParent($this->getRefId());
                $emp->delete();
                $sup = new ilObjRole($this->superior_role);
                $sup->setParent($this->getRefId());
                $sup->delete();

                return true;
        }


        public function removeTranslations() {
                global $DIC;
                $ilDB = $DIC['ilDB'];

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


        public function deleteTranslation($a_lang) {
                global $DIC;
                $ilDB = $DIC['ilDB'];

                $query = "DELETE FROM object_translation WHERE obj_id= "
                         . $ilDB->quote($this->getId(), 'integer') . " AND lang_code = "
                         . $ilDB->quote($a_lang, 'text');
                $res = $ilDB->manipulate($query);
        }


        public function addTranslation($a_title, $a_desc, $a_lang, $a_lang_default) {
                global $DIC;
                $ilDB = $DIC['ilDB'];

                if (empty($a_title)) {
                        $a_title = "NO TITLE";
                }

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

                return true;
        }


        public function updateTranslation($a_title, $a_desc, $a_lang, $a_lang_default) {
                global $DIC;
                $ilDB = $DIC['ilDB'];
                $ilLog = $DIC['ilLog'];

                if (empty($a_title)) {
                        $a_title = "NO TITLE";
                }

                $query = "UPDATE object_translation SET ";

                $query .= " title = " . $ilDB->quote($a_title, 'text');

                if ($a_desc != "") {
                        $query .= ", description = " . $ilDB->quote($a_desc, 'text') . " ";
                }

                if ($a_lang_default) {
                        $query .= ", lang_default = " . $ilDB->quote($a_lang_default, 'integer') . " ";
                }

                $query .= " WHERE obj_id = " . $ilDB->quote($this->getId(), 'integer') . " AND lang_code = "
                          . $ilDB->quote($a_lang, 'text');
                $res = $ilDB->manipulate($query);

                return true;
        }


        public function writePath() {
                if ($this->getRefId()) {
                        ilOrgUnitPathStorage::writePathByRefId($this->getRefId());
                }
        }
}