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". More...

Collaboration diagram for ilObjectFactory:

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

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

static	getInstanceByObjId ($a_obj_id, $stop_on_error=true)
	get an instance of an Ilias object by object id More...

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

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

static	getClassByType ($a_obj_type)
	Get class by type. More...

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

Detailed Description

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 15 of file class.ilObjectFactory.php.

Member Function Documentation

◆ getClassByType()

static ilObjectFactory::getClassByType ( $a_obj_type )

static

Get class by type.

Returns

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

    {
        global $DIC;
 
        $objDefinition = $DIC["objDefinition"];
 
        $class_name = "ilObj" . $objDefinition->getClassName($a_obj_type);
 
        (new self())->includeClassIfNotExists($class_name, $a_obj_type, $objDefinition);
 
        // create instance
        return $class_name;
    }

References $DIC.

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

Here is the caller graph for this function:

◆ getInstanceByObjId()

static ilObjectFactory::getInstanceByObjId	(	$a_obj_id,
		$stop_on_error = `true`
	)

static

get an instance of an Ilias object by object id

Parameters

	$a_obj_id
bool	$stop_on_error

Returns: bool|ilObject

Exceptions

ilDatabaseException
ilObjectNotFoundException

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

    {
        global $DIC;
 
        $objDefinition = $DIC["objDefinition"];
        $ilDB = $DIC->database();
 
        // check object id
        if (!isset($a_obj_id)) {
            $message = "ilObjectFactory::getInstanceByObjId(): No obj_id given!";
            if ($stop_on_error === true) {
                throw new ilObjectNotFoundException($message);
            }
 
            return false;
        }
 
        // read object data
        $q = "SELECT * FROM object_data " .
            "WHERE obj_id = " . $ilDB->quote($a_obj_id, 'integer');
        $object_set = $ilDB->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) {
                throw new ilObjectNotFoundException($message);
            }
            return false;
        }
 
        $object_rec = $object_set->fetchRow(ilDBConstants::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) {
                throw new ilObjectNotFoundException($message);
            }
            return false;
        }
 
        (new self())->includeClassIfNotExists($class_name, $object_rec["type"], $objDefinition);
 
        // create instance
        $obj = new $class_name(0, false);    // this avoids reading of data
        $obj->setId($a_obj_id);
        $obj->read();
 
        return $obj;
    }

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

Here is the caller graph for this function:

◆ getInstanceByRefId()

static ilObjectFactory::getInstanceByRefId	(	$a_ref_id,
		$stop_on_error = `true`
	)

static

get an instance of an Ilias object by reference id

Parameters

	$a_ref_id
bool	$stop_on_error

Returns: bool|ilObject

Exceptions

ilDatabaseException
ilObjectNotFoundException

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

    {
        global $DIC;
 
        $objDefinition = $DIC["objDefinition"];
        $ilDB = $DIC->database();
 
        // check reference id
        if (!isset($a_ref_id)) {
            if ($stop_on_error === true) {
                $message = "ilObjectFactory::getInstanceByRefId(): No ref_id given!";
                throw new ilObjectNotFoundException($message);
            }
 
            return false;
        }
 
        // read object data
 
        $query = "SELECT * FROM object_data,object_reference " .
            "WHERE object_reference.obj_id = object_data.obj_id " .
            "AND object_reference.ref_id = " . $ilDB->quote($a_ref_id, 'integer');
        $object_set = $ilDB->query($query);
 
        // 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!";
                throw new ilObjectNotFoundException($message);
            }
 
            return false;
        }
 
        $object_rec = $object_set->fetchRow(ilDBConstants::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"] . ".";
                throw new ilObjectNotFoundException($message);
            }
 
            return false;
        }
 
        (new self())->includeClassIfNotExists($class_name, $object_rec["type"], $objDefinition);
 
        // create instance
        $obj = new $class_name(0, false);    // this avoids reading of data
        $obj->setId($object_rec["obj_id"]);
        $obj->setRefId($a_ref_id);
        $obj->read();
        return $obj;
    }

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

Here is the caller graph for this function:

◆ getObjectsForOwner()

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

static

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

Parameters

unknown_type	$object_type
unknown_type	$owner_id

Returns: unknown

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

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

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

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

Here is the caller graph for this function:

◆ getTypeByRefId()

static ilObjectFactory::getTypeByRefId	(	$a_ref_id,
		$stop_on_error = `true`
	)

static

get object type by reference id

Parameters

	$a_ref_id
bool	$stop_on_error

Returns: bool

Exceptions

ilDatabaseException
ilObjectNotFoundException

Deprecated:: since version 5.3

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

    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        // check reference id
        if (!isset($a_ref_id)) {
            if ($stop_on_error === true) {
                $message = "ilObjectFactory::getTypeByRefId(): No ref_id given!";
                throw new ilObjectNotFoundException($message);
            }
 
            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=" . $ilDB->quote($a_ref_id, 'integer');
        $object_set = $ilDB->query($q);
 
        if ($object_set->numRows() == 0) {
            if ($stop_on_error === true) {
                $message = "ilObjectFactory::getTypeByRefId(): Object with ref_id " . $a_ref_id . " not found!";
                throw new ilObjectNotFoundException($message);
            }
 
            return false;
        }
 
        $object_rec = $object_set->fetchRow(ilDBConstants::FETCHMODE_ASSOC);
        return $object_rec["type"];
    }

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

Referenced by ilSoapAdministration\checkObjectAccess(), ilSoapObjectAdministration\copyObject(), ilCopyWizardSettingsXMLParser\handlerBeginTag(), ilSoapObjectAdministration\moveObject(), and ilSoapGroupAdministration\updateGroup().

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 259 of file class.ilObjectFactory.php.

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

References $location, and ilObjectDefinition\getLocation().

Here is the call graph for this function:

◆ ObjectIdExists()

ilObjectFactory::ObjectIdExists ( $a_obj_id )

check if obj_id exists.

To check for ref_ids use ilTree::isInTree()

Parameters

int $obj_id object id

Returns: bool

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

    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $query = "SELECT * FROM object_data " .
            "WHERE obj_id = " . $ilDB->quote($a_obj_id, 'integer');
 
        $res = $ilDB->query($query);
 
        return $res->numRows() ? true : false;
    }

References $DIC, $ilDB, $query, $res, and true.

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()