This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilObjectGUIFactory:

Public Member Functions
	__construct (ilObjectDefinition $obj_definition=null, ilDBInterface $db=null)

	getInstanceByRefId (int $ref_id)
	Get ilObj...GUI instance by reference id. More...

Protected Attributes
ilObjectDefinition	$obj_definition

ilDBInterface	$db

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning See bug discussion 24472

Do not use this class yet. This might need a general factory interface first. This could be moved to $DIC->object() service asap.

Author: killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 30 of file class.ilObjectGUIFactory.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjectGUIFactory::__construct	(	ilObjectDefinition	$obj_definition = `null`,
		ilDBInterface	$db = `null`
	)

Definition at line 35 of file class.ilObjectGUIFactory.php.

    {
        global $DIC;
 
        if (is_null($obj_definition)) {
            $obj_definition = $DIC["objDefinition"];
        }
        $this->obj_definition = $obj_definition;
 
        if (is_null($db)) {
            $db = $DIC->database();
        }
        $this->db = $db;
    }

References $db, $DIC, and $obj_definition.

Member Function Documentation

◆ getInstanceByRefId()

ilObjectGUIFactory::getInstanceByRefId ( int $ref_id )

Get ilObj...GUI instance by reference id.

Exceptions

ilObjectException
ilObjectNotFoundException

Definition at line 57 of file class.ilObjectGUIFactory.php.

                                                   : ilObject
    {
        // check reference id
        if (!isset($ref_id)) {
            throw new ilObjectNotFoundException("ilObjectGUIFactory::getInstanceByRefId(): No ref_id given!");
        }
 
        $sql =
            "SELECT object_data.type" . PHP_EOL
            . "FROM object_data,object_reference" . PHP_EOL
            . "WHERE object_reference.obj_id = object_data.obj_id" . PHP_EOL
            . "AND object_reference.ref_id = %s" . PHP_EOL
        ;
        // check if object exists
        $result = $this->db->queryF($sql, ["integer"], [$ref_id]);
        if (!($row = $this->db->fetchAssoc($result))) {
            throw new ilObjectNotFoundException(
                "ilObjectGUIFactory::getInstanceByRefId(): Object with ref_id " . $ref_id . " not found!"
            );
        }
 
        // check class name
        $class_name = "ilObj" . $this->obj_definition->getClassName($row["type"]) . "GUI";
        if ($class_name == "ilObjGUI") {
            throw new ilObjectException("ilObjectGUIFactory::getInstanceByRefId(): Not able to determine object " .
                "class for type" . $row["type"] . ".");
        }
 
        // create instance
        $location = $this->obj_definition->getLocation($row["type"]);
        include_once($location . "/class." . $class_name . ".php");
        return new $class_name("", $ref_id, true, false);
    }

References $location, and $ref_id.

Field Documentation

◆ $db

ilDBInterface ilObjectGUIFactory::$db

protected

Definition at line 33 of file class.ilObjectGUIFactory.php.

Referenced by __construct().

◆ $obj_definition

ilObjectDefinition ilObjectGUIFactory::$obj_definition