classes/class.ilObjectFactory.php

Go to the documentation of this file.

<?php
/*
        +-----------------------------------------------------------------------------+
        | ILIAS open source                                                           |
        +-----------------------------------------------------------------------------+
        | Copyright (c) 1998-2001 ILIAS open source, University of Cologne            |
        |                                                                             |
        | This program is free software; you can redistribute it and/or               |
        | modify it under the terms of the GNU General Public License                 |
        | as published by the Free Software Foundation; either version 2              |
        | of the License, or (at your option) any later version.                      |
        |                                                                             |
        | This program is distributed in the hope that it will be useful,             |
        | but WITHOUT ANY WARRANTY; without even the implied warranty of              |
        | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               |
        | GNU General Public License for more details.                                |
        |                                                                             |
        | You should have received a copy of the GNU General Public License           |
        | along with this program; if not, write to the Free Software                 |
        | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA. |
        +-----------------------------------------------------------------------------+
*/


class ilObjectFactory
{
        function ObjectIdExists($a_obj_id)
        {
                global $ilias;

                $query = "SELECT * FROM object_data ".
                        "WHERE obj_id = '".$a_obj_id."'";

                $res = $ilias->db->query($query);
                
                return $res->numRows() ? true : false;
        }
                
        function getInstanceByObjId($a_obj_id,$stop_on_error = true)
        {
                global $ilias, $objDefinition;

                // check object id
                if (!isset($a_obj_id))
                {
                        $message = "ilObjectFactory::getInstanceByObjId(): No obj_id given!";
                        if ($stop_on_error === true)
                        {
                                $ilias->raiseError($message,$ilias->error_obj->WARNING);
                                exit();
                        }
                        #var_dump("<pre>",$message,"<pre>");

                        return false;
                }

                // read object data
                $q = "SELECT * FROM object_data ".
                         "WHERE obj_id = '".$a_obj_id."'";
                $object_set = $ilias->db->query($q);
                // check number of records
                if ($object_set->numRows() == 0)
                {
                        $message = "ilObjectFactory::getInstanceByObjId(): Object with obj_id: ".$a_obj_id." not found!";
                        if ($stop_on_error === true)
                        {
                                $ilias->raiseError($message,$ilias->error_obj->WARNING);
                                exit();
                        }
                        #var_dump("<pre>",$message,"<pre>");
                        return false;
                }

                $object_rec = $object_set->fetchRow(DB_FETCHMODE_ASSOC);
                $class_name = "ilObj".$objDefinition->getClassName($object_rec["type"]);
                
                // check class
                if ($class_name == "ilObj")
                {
                        $message = "ilObjectFactory::getInstanceByObjId(): Not able to determine object ".
                                "class for type".$object_rec["type"].".";
                        if ($stop_on_error === true)
                        {
                                $ilias->raiseError($message,$ilias->error_obj->WARNING);
                                exit();
                        }
                        return false;
                }

                // get module
                $module = $objDefinition->getModule($object_rec["type"]);
                $module_dir = ($module == "")
                        ? ""
                        : $module."/";

                // create instance
                include_once($module_dir."classes/class.".$class_name.".php");
                $obj =& new $class_name(0, false);      // this avoids reading of data
                $obj->setId($a_obj_id);
                $obj->setObjDataRecord($object_rec);
                $obj->read();

                return $obj;
        }


        function getInstanceByRefId($a_ref_id,$stop_on_error = true)
        {
                global $ilias, $objDefinition;

                // check reference id
                if (!isset($a_ref_id))
                {
                        if ($stop_on_error === true)
                        {
                                $message = "ilObjectFactory::getInstanceByRefId(): No ref_id given!";
                                $ilias->raiseError($message,$ilias->error_obj->WARNING);
                                exit();
                        }
                        
                        return false;
                }

                // read object data
                
                // Much too slow
                #$q = "SELECT * FROM object_data ".
                #        "LEFT JOIN object_reference ON object_data.obj_id=object_reference.obj_id ".
                #        "WHERE object_reference.ref_id='".$a_ref_id."'";
                $q = "SELECT * FROM object_data,object_reference ".
                        "WHERE object_reference.obj_id = object_data.obj_id ".
                        "AND object_reference.ref_id = '".$a_ref_id."'";

                $object_set = $ilias->db->query($q);

                // check number of records
                if ($object_set->numRows() == 0)
                {
                        if ($stop_on_error === true)
                        {
                                $message = "ilObjectFactory::getInstanceByRefId(): Object with ref_id ".$a_ref_id." not found!";
                                $ilias->raiseError($message,$ilias->error_obj->WARNING);
                                exit();
                        }
                        
                        return false;
                }

                $object_rec = $object_set->fetchRow(DB_FETCHMODE_ASSOC);
                $class_name = "ilObj".$objDefinition->getClassName($object_rec["type"]);

                // check class
                if ($class_name == "ilObj")
                {
                        if ($stop_on_error === true)
                        {
                                $message = "ilObjectFactory::getInstanceByRefId(): Not able to determine object ".
                                                   "class for type".$object_rec["type"].".";
                                $ilias->raiseError($message,$ilias->error_obj->WARNING);
                                exit();
                        }
                        
                        return false;
                }

                // get module
                $module = $objDefinition->getModule($object_rec["type"]);
                $module_dir = ($module == "")
                        ? ""
                        : $module."/";

                // create instance
                include_once($module_dir."classes/class.".$class_name.".php");
                $obj =& new $class_name(0, false);      // this avoids reading of data
                $obj->setId($object_rec["obj_id"]);
                $obj->setRefId($a_ref_id);
                $obj->setObjDataRecord($object_rec);
                $obj->read();
                return $obj;
        }

        function getTypeByRefId($a_ref_id,$stop_on_error = true)
        {
                global $ilias, $objDefinition;

                // check reference id
                if (!isset($a_ref_id))
                {
                        if ($stop_on_error === true)
                        {
                                $message = "ilObjectFactory::getTypeByRefId(): No ref_id given!";
                                $ilias->raiseError($message,$ilias->error_obj->WARNING);
                                exit();
                        }
                        
                        return false;
                }

                // read object data
                $q = "SELECT * FROM object_data ".
                         "LEFT JOIN object_reference ON object_data.obj_id=object_reference.obj_id ".
                         "WHERE object_reference.ref_id='".$a_ref_id."'";
                $object_set = $ilias->db->query($q);

                if ($object_set->numRows() == 0)
                {
                        if ($stop_on_error === true)
                        {
                                $message = "ilObjectFactory::getTypeByRefId(): Object with ref_id ".$a_ref_id." not found!";
                                $ilias->raiseError($message,$ilias->error_obj->WARNING);
                                exit();
                        }
                        
                        return false;
                }

                $object_rec = $object_set->fetchRow(DB_FETCHMODE_ASSOC);
                return $object_rec["type"];
        }
}
?>