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

Collaboration diagram for ilObjectFactory:

Public Member Functions
	ObjectIdExists (int $obj_id)
	check if obj_id exists. More...

Static Public Member Functions
static	getObjectsForOwner (string $object_type, int $owner_id)
	returns all objects of an owner, filtered by type, objects are not deleted! More...

static	getInstanceByObjId (?int $obj_id, bool $stop_on_error=true)
	get an instance of an Ilias object by object id More...

static	getInstanceByRefId (int $ref_id, bool $stop_on_error=true)
	get an instance of an Ilias object by reference id More...

static	getTypeByRefId (int $ref_id, bool $stop_on_error=true)
	get object type by reference id More...

static	getClassByType (string $obj_type)

Protected Member Functions
	includeClassIfNotExists (string $class_name, string $a_obj_type, ilObjectDefinition $objDefinition)
	Ensures a class is properly included. More...

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 Class ilObjectFactory This class offers methods to get instances of the type-specific object classes (derived from ilObject) by their object or reference id Note: The term "Ilias objects" means all object types that are stored in the database table "object_data"

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

Definition at line 32 of file class.ilObjectFactory.php.

Member Function Documentation

◆ getClassByType()

static ilObjectFactory::getClassByType ( string $obj_type )

static

Definition at line 240 of file class.ilObjectFactory.php.

References $DIC.

Referenced by ilRepositoryTrashGUI\confirmRemoveFromSystemObject(), ilWorkspaceTree\createTreeForUser(), ilAdministrationCommandGUI\delete(), ilObjStudyProgrammeTreeGUI\delete(), ilObjWorkspaceFolderGUI\deleteConfirmation(), ilObjectCopyGUI\saveSource(), ilObjectCopyGUI\saveTarget(), and ilRepositoryTrashGUI\showDeleteConfirmation().

                                                            : string
     {
         global $DIC;
         $objDefinition = $DIC["objDefinition"];
 
         $class_name = "ilObj" . $objDefinition->getClassName($obj_type);
 
         (new self())->includeClassIfNotExists($class_name, $obj_type, $objDefinition);
 
         return $class_name;
     }

Here is the caller graph for this function:

◆ getInstanceByObjId()

static ilObjectFactory::getInstanceByObjId	(	?int	$obj_id,
		bool	$stop_on_error = `true`
	)

static

get an instance of an Ilias object by object id

Exceptions

ilDatabaseException
ilObjectNotFoundException

Definition at line 84 of file class.ilObjectFactory.php.

References $DIC, $ilDB, $message, and ilDBConstants\FETCHMODE_ASSOC.

                                                                                        : ?ilObject
     {
         global $DIC;
         $objDefinition = $DIC["objDefinition"];
         $ilDB = $DIC->database();
 
         // check object id
         if (!isset($obj_id)) {
             $message = "ilObjectFactory::getInstanceByObjId(): No obj_id given!";
             if ($stop_on_error === true) {
                 throw new ilObjectNotFoundException($message);
             }
             return null;
         }
 
         // read object data
         $sql =
             "SELECT obj_id, type, title, description, owner, create_date, last_update, import_id, offline" . PHP_EOL
             . "FROM object_data" . PHP_EOL
             . "WHERE obj_id = " . $ilDB->quote($obj_id, 'integer') . PHP_EOL
         ;
         $result = $ilDB->query($sql);
         // check number of records
         if ($result->numRows() == 0) {
             $message = "ilObjectFactory::getInstanceByObjId(): Object with obj_id: " . $obj_id . " not found!";
             if ($stop_on_error === true) {
                 throw new ilObjectNotFoundException($message);
             }
             return null;
         }
 
         $row = $result->fetchRow(ilDBConstants::FETCHMODE_ASSOC);
         $class_name = "ilObj" . $objDefinition->getClassName($row["type"]);
 
         // check class
         if ($class_name == "ilObj") {
             $message = "ilObjectFactory::getInstanceByObjId(): Not able to determine object " .
                 "class for type" . $row["type"] . ".";
             if ($stop_on_error === true) {
                 throw new ilObjectNotFoundException($message);
             }
             return null;
         }
 
         (new self())->includeClassIfNotExists($class_name, $row["type"], $objDefinition);
 
         // create instance
         $obj = new $class_name(0, false);    // this avoids reading of data
         $obj->setId($obj_id);
         $obj->read();
 
         return $obj;
     }

Here is the caller graph for this function:

◆ getInstanceByRefId()

static ilObjectFactory::getInstanceByRefId	(	int	$ref_id,
		bool	$stop_on_error = `true`
	)

static

get an instance of an Ilias object by reference id

Exceptions

ilDatabaseException
ilObjectNotFoundException

Definition at line 143 of file class.ilObjectFactory.php.

References $DIC, $ilDB, $message, and ilDBConstants\FETCHMODE_ASSOC.

                                                                                       : ?ilObject
     {
         global $DIC;
         $objDefinition = $DIC["objDefinition"];
         $ilDB = $DIC->database();
 
         // check reference id
         if (!isset($ref_id)) {
             if ($stop_on_error === true) {
                 $message = "ilObjectFactory::getInstanceByRefId(): No ref_id given!";
                 throw new ilObjectNotFoundException($message);
             }
             return null;
         }
 
         // read object data
         $sql =
             "SELECT object_data.obj_id, 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 = " . $ilDB->quote($ref_id, 'integer') . PHP_EOL
         ;
 
         $result = $ilDB->query($sql);
 
         // check number of records
         if ($result->numRows() == 0) {
             if ($stop_on_error === true) {
                 $message = "ilObjectFactory::getInstanceByRefId(): Object with ref_id " . $ref_id . " not found!";
                 throw new ilObjectNotFoundException($message);
             }
             return null;
         }
 
         $row = $result->fetchRow(ilDBConstants::FETCHMODE_ASSOC);
         $class_name = "ilObj" . $objDefinition->getClassName($row["type"]);
 
         // check class
         if ($class_name == "ilObj") {
             if ($stop_on_error === true) {
                 $message = "ilObjectFactory::getInstanceByRefId(): Not able to determine object " .
                     "class for type" . $row["type"] . ".";
                 throw new ilObjectNotFoundException($message);
             }
             return null;
         }
 
         (new self())->includeClassIfNotExists($class_name, $row["type"], $objDefinition);
 
         // create instance
         $obj = new $class_name(0, false);    // this avoids reading of data
         $obj->setId((int) $row["obj_id"]);
         $obj->setRefId($ref_id);
         $obj->read();
         return $obj;
     }

Here is the caller graph for this function:

◆ getObjectsForOwner()

static ilObjectFactory::getObjectsForOwner	(	string	$object_type,
		int	$owner_id
	)

static

returns all objects of an owner, filtered by type, objects are not deleted!

Definition at line 56 of file class.ilObjectFactory.php.

References $DIC, $ilDB, and ilDBConstants\FETCHMODE_ASSOC.

Referenced by ilSoapCourseAdministration\getCoursesForUser(), and ilSoapGroupAdministration\getGroupsForUser().

                                                                                  : array
     {
         global $DIC;
         $ilDB = $DIC->database();
 
         $sql =
             "SELECT object_data.obj_id" . PHP_EOL
             . "FROM object_data, object_reference" . PHP_EOL
             . "WHERE object_reference.obj_id = object_data.obj_id" . PHP_EOL
             . "AND object_data.type = " . $ilDB->quote($object_type, 'text') . PHP_EOL
             . "AND object_data.owner = " . $ilDB->quote($owner_id, 'integer') . PHP_EOL
         ;
 
         $result = $ilDB->query($sql);
 
         $obj_ids = [];
         while ($row = $result->fetchRow(ilDBConstants::FETCHMODE_ASSOC)) {
             $obj_ids [] = $row["obj_id"];
         }
 
         return $obj_ids;
     }

Here is the caller graph for this function:

◆ getTypeByRefId()

static ilObjectFactory::getTypeByRefId	(	int	$ref_id,
		bool	$stop_on_error = `true`
	)

static

get object type by reference id

Exceptions

ilObjectNotFoundException

Deprecated:: since version 5.3

Definition at line 205 of file class.ilObjectFactory.php.

References $DIC, $ilDB, $message, and ilDBConstants\FETCHMODE_ASSOC.

Referenced by ilSoapGroupAdministration\addGroup(), ilSoapObjectAdministration\copyObject(), ilCopyWizardSettingsXMLParser\handlerBeginTag(), ilSoapObjectAdministration\moveObject(), and ilObjLTIConsumerGUI\saveContentSelection().

                                                                                   : ?string
     {
         global $DIC;
         $ilDB = $DIC->database();
 
         // check reference id
         if (!isset($ref_id)) {
             if ($stop_on_error === true) {
                 $message = "ilObjectFactory::getTypeByRefId(): No ref_id given!";
                 throw new ilObjectNotFoundException($message);
             }
             return null;
         }
 
         // read object data
         $sql =
             "SELECT object_data.obj_id, object_data.type" . PHP_EOL
             . "FROM object_data" . PHP_EOL
             . "LEFT JOIN object_reference ON object_data.obj_id=object_reference.obj_id " . PHP_EOL
             . "WHERE object_reference.ref_id=" . $ilDB->quote($ref_id, 'integer') . PHP_EOL
         ;
         $result = $ilDB->query($sql);
 
         if ($result->numRows() == 0) {
             if ($stop_on_error === true) {
                 $message = "ilObjectFactory::getTypeByRefId(): Object with ref_id " . $ref_id . " not found!";
                 throw new ilObjectNotFoundException($message);
             }
             return null;
         }
 
         $row = $result->fetchRow(ilDBConstants::FETCHMODE_ASSOC);
         return $row["type"];
     }

Here is the caller graph for this function:

◆ includeClassIfNotExists()

ilObjectFactory::includeClassIfNotExists	(	string	$class_name,
		string	$a_obj_type,
		ilObjectDefinition	$objDefinition
	)

protected

Ensures a class is properly included.

This is needed, since not all possible classes are yet part of the autoloader (e.g. repo-plugins). See: #27073

Parameters

string	$class_name
string	$a_obj_type
ilObjectDefinition	$objDefinition

Definition at line 260 of file class.ilObjectFactory.php.

References $location, and ilObjectDefinition\getLocation().

      : void {
         if (!class_exists($class_name)) {
             $location = $objDefinition->getLocation($a_obj_type);
             include_once($location . "/class." . $class_name . ".php");
         }
     }

Here is the call graph for this function:

◆ ObjectIdExists()

ilObjectFactory::ObjectIdExists ( int $obj_id )

check if obj_id exists.

To check for ref_ids use ilTree::isInTree()

Definition at line 37 of file class.ilObjectFactory.php.

References $DIC, and $ilDB.

                                                : bool
     {
         global $DIC;
         $ilDB = $DIC->database();
 
         $sql =
             "SELECT obj_id, type, title, description, owner, create_date, last_update, import_id, offline" . PHP_EOL
             . "FROM object_data" . PHP_EOL
             . "WHERE obj_id = " . $ilDB->quote($obj_id, 'integer') . PHP_EOL
         ;
 
         $result = $ilDB->query($sql);
 
         return (bool) $result->numRows();
     }

The documentation for this class was generated from the following file:

Services/Object/classes/class.ilObjectFactory.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation

◆ getClassByType()

◆ getInstanceByObjId()

◆ getInstanceByRefId()

◆ getObjectsForOwner()

◆ getTypeByRefId()

◆ includeClassIfNotExists()

◆ ObjectIdExists()