Group.class.php

Go to the documentation of this file.

<?php
include_once("core/system/JBaseObject.class.php");
include_once("core/db/dbjames.class.php");
include_once("core/system/JSystemError.class.php");

class Group extends JBaseObject
{
        var $data;      
        var $modules;   


        function Group ($idG)
        {
                $dbObj = new DBJames();

                $query = "SELECT * FROM Groups ";
                $query .= "WHERE idG = " . $idG;
    
                $dbObj->Query($query);
                        
                if ($dbObj->numRows == 1)
                {
                        $this->data = $dbObj->row;
                        $this->_UpdateModulesList();
                }
                else
                {
                        $this->data = null;
                        $this->RaiseConstructorError(new JSystemError(ERROR_GROUP_NOT_FOUND));
                }
        }
        
        function _UpdateModulesList()
        {
                $dbObj = new DBJames();

                $query  = " SELECT Modules.*, RelModulesGroups.idRMG, ";
                $query .= " RelModulesGroups.rmgName FROM ";
                $query .= " Modules,RelModulesGroups ";
                $query .= " WHERE RelModulesGroups.idG = ".$this->GetId();
                $query .= " AND Modules.idM = RelModulesGroups.idM";
                $query .= " ORDER BY Modules.idM ";

                $dbObj->Query($query);
                
                $this->modules = array();
                
                while (!$dbObj->EOF)
                {       
                        $this->modules[$dbObj->row["idRMG"]]["id"] = $dbObj->row["idM"];
                        $this->modules[$dbObj->row["idRMG"]]["name"] = $dbObj->row["rmgName"];
                        $dbObj->Next();
                }               
        }

        function GetId()
        {
                return $this->data["idG"];
        }
        
        function GetName()
        {
                return $this->data["name"];
        }
        
        function IsGlobal()
        {
                return $this->data["isGlobal"];
        }
        
        function SetGlobal()
        {
                $this->data["isGlobal"]=1;
        }
        
        function &GetParent()
        {
                $ugrsystem =& JUgrSystem::GetInstance();
                return $ugrsystem->GetGroup($this->data["idParent"]);
        }
        
        function SetName($name)
        {
                $this->data["name"] = $name;
        }
        
        function Commit()
        {
                $dbObj = new DBJames();
                
                if ($this->IsGlobal())
                {       
                        $glob = 1;
                }
                else
                { 
                        $glob = 0;
                }
                
                $query  = " UPDATE Groups SET ";
                $query .= " name = '".$this->GetName()."', ";
                $query .= " isGlobal = ".$glob. " ";
                $query .= " WHERE idG = ".$this->GetId();
                
                $dbObj->Execute($query);
        }
                

//---------------------------- User methods ----------------------------------
        
        function &GetUsers()
        {
                if($this->data == null)
                        return JSystem::RaiseError(
                                        new JSystemError(ERROR_NOT_INITIALIZED));

                $dbObj = new DBJames();

                $query  = " SELECT DISTINCT Users.*, RelUsersGroups.idR FROM ";
                $query .= " Users,RelUsersGroups ";
                $query .= " WHERE RelUsersGroups.idG = ".$this->GetId();
                $query .= " AND   Users.idU = RelUsersGroups.idU";

                $dbObj->Query($query);

                return $dbObj;
        }
        
        function HasUser($idU)
        {
                $dbObj =& $this->GetUsers();
                
                $result = false;
                
                while (! $dbObj->EOF && !$result)
                {
                        if ($dbObj->row["idU"] == $idU)
                                $result = true;
                        else
                                $dbObj->Next();
                }
                
                return $result;
        }               


        function &GetUsersWithPermission($permission, $mod)
        {
                if($this->data == null)
                        return JSystem::RaiseError(
                                        new JSystemError(ERROR_NOT_INITIALIZED));

                $dbObj = new DBJames();

                $query  = " SELECT DISTINCT Users.*, RelUsersGroups.idR FROM ";
                $query .= " Users,RelUsersGroups,RelRolesPermissions,Permissions ";
                $query .= " WHERE RelUsersGroups.idG = ".$this->GetId();
                $query .= " AND   Users.idU = RelUsersGroups.idU ";
                $query .= " AND   Permissions.name = '".$permission."' ";
                $query .= " AND   Permissions.idM = ".$mod;
                $query .= " AND   RelRolesPermissions.idP = Permissions.idP ";
                $query .= " AND   RelUsersGroups.idR = RelRolesPermissions.idR";

                $dbObj->Query($query);

                return $dbObj;
        }

        function AddUser($idU, $idR)
        {
                $ugrsystem =& JUgrSystem::GetInstance();
                
                if ($this->IsGlobal())
                {
                        return JSystem::RaiseError(new JSystemError(ERROR_IS_GLOBAL_GROUP));
                }
                elseif ($this->HasUser($idU))
                {
                        return JSystem::RaiseError(
                                        new JSystemError(ERROR_ALREADY_IN_GROUP));
                }
                elseif (JSystem::IsError($ugrsystem->GetUser($idU)))
                {
                        return JSystem::RaiseError(new JSystemError(ERROR_USER_NOT_FOUND));
                }               
                elseif (JSystem::IsError($ugrsystem->GetRole($idR)))
                {
                        return JSystem::RaiseError(new JSystemError(ERROR_ROLE_NOT_FOUND));
                }
                else
                {
                        $dbObj = new DBJames();
                        
                        $query  = " INSERT INTO RelUsersGroups ";
                        $query .= " (idU, idG, idR) VALUES ";
                        $query .= "(".$idU.", ".$this->GetId().", ".$idR.")";
                        
                        $dbObj->Execute($query);
                }               
                return null;
        }
        
        
        function RemoveUser($idU)
        {
                if (! $this->HasUser($idU))
                {
                        return JSystem::RaiseError(
                                                new JSystemError(ERROR_NOT_IN_GROUP));
                }
                else
                {
                        $dbObj = new DBJames();
                        
                        $query  = " DELETE FROM RelUsersGroups ";
                        $query .= " WHERE idU = ".$idU;
                        $query .= " AND idG = ".$this->GetId();
                        
                        $dbObj->Execute($query);
                }               
        }
        

//--------------------------- Modules methods ---------------------------------
        
        function &GetModules()
        {
                $modules =& Modules::GetInstance();
                
                if($this->data == null)
                        return JSystem::RaiseError(new JSystemError(ERROR_NOT_INITIALIZED));

                $result = array();
                
                if (count($this->modules) > 0)
                {
                        foreach ($this->modules as $idRmg => $cont)
                        {
                                $result[$idRmg] =& $modules->GetModule($cont["id"]);
                        }
                }               
                        
                return $result;
        }

        function HasModule($idM)
        {
                if($this->data == null)
                        return JSystem::RaiseError(
                                        new JSystemError(ERROR_NOT_INITIALIZED));

                $dbObj = new DBJames();

                $query  = " SELECT RelModulesGroups.idRMG, ";
                $query .= " RelModulesGroups.rmgName FROM ";
                $query .= " Modules,RelModulesGroups ";
                $query .= " WHERE RelModulesGroups.idG = ".$this->GetId();
                $query .= " AND RelModulesGroups.idM = ".$idM;

                $dbObj->Query($query);

                if ($dbObj->numRows > 0)
                        return true;
                else                    
                        return false;
        }
        
        function GetModuleName($idRmg)
        {
                return $this->modules[$idRmg]["name"];
        }
        
        function SetModuleName($idRmg, $name)
        {
                // Just set the module name if the module belongs to the group
                if (isset($this->modules[$idRmg]))
                {
                        // If no name is given, we will use the specified by the module
                        // config file
                        if ($name == "")
                        {
                                $modules =& Modules::GetInstance();
                                $module =& $modules->GetModule($this->modules[$idRmg]["idM"]);
                                $info =& $module->GetInformation();
                                $name = I18N::Language($info->GetScreenNames());
                        }
                        
                        // Update the values in the db
                        $dbObj = new DBJames();
                        
                        $query  = "UPDATE RelModulesGroups ";
                        $query .= " SET rmgName=".$name;
                        $query .= " WHERE idRMG=".$idRmg;
                                
                        $dbObj->Execute($query);                        
                        
                        // Update the group object
                        $this->_UpdateModulesList();
                }
        }
        
        
        function AddModule($idM, $name="")
        {
                $modules =& Modules::GetInstance();
                $module =& $modules->GetModule($idM);
                if (JSystem::IsError($modules))
                {
                        return JSystem::RaiseError(
                                                new JSystemError(ERROR_MODULE_NOT_FOUND));
                }
                else
                {
                        // If no name is given, we will use the specified by the module
                        // config file
                        if ($name == "")
                        {
                                $info =& $module->GetInformation();
                                $name = I18N::Language($info->GetScreenNames());
                        }
                                
                        // We store it in RelModulesGroups
                        $dbObj = new DBJames();
        
                        $query  = "INSERT INTO RelModulesGroups ";
                        $query .= " (idM, idG, rmgName) VALUES ";
                        $query .= " (".$idM.", ".$this->GetId().", '".$name."') ";
                                
                        $dbObj->Execute($query);
                        
                        $dbObj->SetInsertId();
                        
                        $newId = $dbObj->newID;

                        // Updates the group object                     
                        $this->_UpdateModulesList();
                        
                        return $newId;
                }
        }
        
        
        function RemoveModule($idRMG)
        {
                $dbObj = new DBJames();
                
                $query  = " DELETE FROM RelModulesGroups ";
                $query .= " WHERE idRMG = ".$idRMG;
                
                $dbObj->Execute($query);
                
                $this->_UpdateModulesList();
        }

        
//------------------------- Subgroups methods ---------------------------------

        function &GetSubgroups()
        {
                if($this->data == null)
                        return JSystem::RaiseError(
                                        new JSystemError(ERROR_NOT_INITIALIZED));

                $ugrsystem =& JUgrSystem::GetInstance();
                $dbObj = new DBJames();
                
                $query  = " SELECT * FROM Groups ";
                $query .= " WHERE Groups.idParent = ".$this->GetId();

                $dbObj->Query($query);

                $result = array();
                
                while (!$dbObj->EOF)
                {       
                        $idG = $dbObj->row["idG"];
                        $result[$idG] =& $ugrsystem->GetGroup($idG);
                        $dbObj->Next();
                }               
                        
                return $result;
        }


        function &GetSubgroupsOfUser($idU)
        {
                if($this->data == null)
                        return JSystem::RaiseError(
                                        new JSystemError(ERROR_NOT_INITIALIZED));

                $ugrsystem =& JUgrSystem::GetInstance();
                $dbObj = new DBJames();         
        
                $query  = " SELECT Groups.*, RelUsersGroups.idR FROM ";
                $query .= " Groups, RelUsersGroups ";
                $query .= " WHERE Groups.idParent = ".$this->GetId();
                $query .= " AND RelUsersGroups.idG = Groups.idG ";
                $query .= " AND RelUsersGroups.idU = " .$idU;
                $query .= " ORDER BY Groups.idG";
          
                $dbObj->Query($query);

                $result = array();
                
                while (!$dbObj->EOF)
                {       
                        $idG = $dbObj->row["idG"];
                        $result[$idG] =& $ugrsystem->GetGroup($idG);
                        $dbObj->Next();
                }               
                        
                return $result;
        }

        
        function &AddSubgroup($name)
        {
                return $this->Create($name, $this->IsGlobal(), $this->GetId());
        }
        


//-------------------- Groups admin methods (static) -------------------------
        
        function &Create($name, $global=false, $parent=null)
        {
                $ugrsystem =& JUgrSystem::GetInstance();
                
                if ($parent != null && $parent !=0  &&
                        JSystem::IsError($ugrsystem->GetGroup($parent)))
                {
                        return JSystem::RaiseError(
                                        new JSystemError(ERROR_GROUP_NOT_FOUND));
                }
                else
                {
                        // Set the value for the top level groups
                        if ($parent === null)
                                $parent = 0;
                        
                        if ($global) $glob = 1;
                        else $glob = 0;
                                
                        $dbObj = new DBJames();
                        
                        $query  = " INSERT INTO Groups ";
                        $query .= " (name, idParent, isGlobal) VALUES ";
                        $query .= " ('".$name."', ".$parent.", ".$glob.") ";
                        
                        $dbObj->Execute($query);
                        
                        $dbObj->SetInsertId();
                        
                        $group =& new Group($dbObj->newID);
                        if (JSystem::IsError($group))
                                return JSystem::GetLastError();
                        else
                                return $group;
                }
        }
        
        
        function Remove($idG)
        {
                $ugrsystem =& JUgrSystem::GetInstance();
                $group =& $ugrsystem->GetGroup($idG);
                
                if (JSystem::IsError($group))
                {
                        return JSystem::RaiseError(new JSystemError(ERROR_GROUP_NOT_FOUND));
                }
                elseif (count($group->GetSubgroups()) > 0)
                {
                        return JSystem::RaiseError(
                                                new JSystemError(ERROR_GROUP_HAS_SUBGROUPS));
                }
                else
                {
                        $dbObj = new DBJames();
                        
                        // First we remove all users from this group.
                        $query  = " DELETE FROM RelUsersGroups ";
                        $query .= " WHERE idG=".$group->GetId();
                        $dbObj->Execute($query);
                        
                        // Then, we delete all modules from it.
                        $query  = " DELETE FROM RelModulesGroups ";
                        $query .= " WHERE idG = ".$group->GetId();
                        $dbObj->Execute($query);
                        
                        // Finally, we remove the group.
                        $query  = " DELETE FROM Groups ";
                        $query .= " WHERE idG = ". $group->GetId();
                        $dbObj->Execute($query);
                }
        }
        
        function GetAllGroupsId($parent = null, $global=null)
        {
                $dbObj = new DBJames();         
                $query  = " SELECT * FROM Groups ";
                $query .= " WHERE 1 ";
                
                if ($parent !== null)
                        $query .= " AND idParent=".$parent;

                if ($global !== null)
                {
                        if ($global) $glob = 1;
                        else $glob = 0;
                        $query .= " AND isGlobal=".$glob;
                }
                
                $dbObj->Query($query);
                
                return $dbObj;
        }                               

}
?>

---