ilObjectFactory Class Reference

Class ilObjectFactory. More...

Collaboration diagram for ilObjectFactory:

Public Member Functions
	ObjectIdExists ($a_obj_id)
	check if obj_id exists. More...
	getObjectsForOwner ($object_type, $owner_id)
	returns all objects of an owner, filtered by type, objects are not deleted! More...

Static Public Member Functions
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...

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

Member Function Documentation

getClassByType()

static ilObjectFactory::getClassByType (   $a_obj_type )

static

Get class by type.

Returns

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

        {
                global $objDefinition;
 
                $location = $objDefinition->getLocation($a_obj_type);
                $class_name = "ilObj".$objDefinition->getClassName($a_obj_type);
 
                // create instance
                include_once($location."/class.".$class_name.".php");
                return $class_name;
        }

References $location.

Referenced by ilWorkspaceExplorer\__construct(), ilRepUtilGUI\confirmRemoveFromSystemObject(), ilWorkspaceTree\createTreeForUser(), ilObjStudyProgrammeTreeGUI\delete(), ilAdministrationCommandGUI\delete(), ilObject2GUI\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

int

$obj_id

object id

Returns

object instance of Ilias object (i.e. derived from ilObject)

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

        {
                global $ilias, $objDefinition, $ilDB;
 
                // 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 = ".$ilDB->quote($a_obj_id ,'integer');
                $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(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)
                        {
                                $ilias->raiseError($message,$ilias->error_obj->WARNING);
                                exit();
                        }
                        return false;
                }
 
                // get location
                $location = $objDefinition->getLocation($object_rec["type"]);
 
                // create instance
                include_once($location."/class.".$class_name.".php");
                $obj = new $class_name(0, false);       // this avoids reading of data
                $obj->setId($a_obj_id);
                $obj->read();
 
                return $obj;
        }

References $ilDB, $location, exit, and ilDBConstants\FETCHMODE_ASSOC.

Referenced by ilLearningProgressBaseGUI\__appendUserInfo(), ilRoleDesktopItem\__assign(), ilObjCategoryGUI\__checkGlobalRoles(), ilLocalUserGUI\__checkGlobalRoles(), ilCalendarUserSettings\__construct(), ilObjCategoryGUI\__getAssignableRoles(), ilLocalUserGUI\__getAssignableRoles(), ilLPListOfProgressGUI\__initUser(), ilLinkChecker\__sendMail(), ilLocalUserGUI\__showRolesTable(), ilSearch\__validateResults(), ilObjGroup\_isMember(), ilInfoScreenGUI\addObjectSections(), ilSoapRBACAdministration\addUserRoleEntry(), ilSoapCourseAdministration\assignCourseMember(), ilMembershipGUI\assignFromWaitingList(), ilSoapGroupAdministration\assignGroupMember(), ilExerciseMembers\assignMember(), ilCourseMembershipGUI\assignMembers(), ilObject2GUI\assignObject(), ilObjectGUI\assignObject(), ilLocalUserGUI\assignRoles(), ilObjCategoryGUI\assignRolesObject(), ilParticipants\assignSubscriber(), ilChatroom\byRoomId(), ilWorkspaceTree\cascadingDelete(), ilUserCronCheckAccounts\checkNotConfirmedUserAccounts(), ilObjPortfolioBase\cloneBasics(), ilContainer\cloneObject(), ilStartUpGUI\confirmRegistration(), ilContainerXmlParser\createObject(), ilObjWorkspaceFolderGUI\cut(), ilExerciseMembers\deassignMember(), ilObject2GUI\deleteConfirmedObjects(), ilSoapUtils\deleteExpiredDualOptInUserObjects(), ilRepUtil\deleteObjects(), ilSoapRBACAdministration\deleteRole(), ilObjRoleFolderGUI\deleteRoleObject(), ilSoapUserAdministration\deleteUser(), ilSoapRBACAdministration\deleteUserRoleEntry(), ilObjBlog\doCloneObject(), ilExerciseManagementGUI\downloadAllObject(), ilPublicSubmissionsTableGUI\fillRow(), ilTestImporter\finalProcessing(), ilObjForumAccess\getCachedUserInstance(), ilSoapCourseAdministration\getCoursesForUser(), ilObjCourse\getDefaultAdminRole(), ilObjCourse\getDefaultTutorRole(), ilChatroom\getDescription(), ilSoapExerciseAdministration\getExerciseXML(), ilSoapFileAdministration\getFileXML(), ilSoapGroupAdministration\getGroupsForUser(), ilSoapSCORMAdministration\getIMSManifestXML(), ilSoapRBACAdministration\getLocalRoles(), ilAttendanceList\getNonMemberUserData(), ilSoapObjectAdministration\getObjectsByTitle(), ilSoapRBACAdministration\getObjectTreeOperations(), ilCourseMembershipGUI\getPrintMemberData(), ilSoapRBACAdministration\getRoles(), ilChatroom\getTitle(), ilSoapUserAdministration\getUser(), ilSoapRBACAdministration\getUserRoles(), ilSoapRBACAdministration\grantPermissions(), ilObjCourse\handleAutoFill(), ilObjGroup\handleAutoFill(), ilObjSession\handleAutoFill(), ilECSTaskScheduler\handleDeprecatedAccounts(), ilECSAppEventListener\handleEvent(), ilRemoteObjectBase\handleUpdate(), ilObjTestAccess\hasFinished(), ilObjTestAccess\hasVisibleCertificate(), ilExternalFeedBlockGUI\importFile(), ilObjectGUI\importFileObject(), ilBibliographicDataSet\importRecord(), ilBlogDataSet\importRecord(), ilExerciseDataSet\importRecord(), ilExternalFeedDataSet\importRecord(), ilGlossaryDataSet\importRecord(), ilHTMLLearningModuleDataSet\importRecord(), ilItemGroupDataSet\importRecord(), ilLearningModuleDataSet\importRecord(), ilMediaCastDataSet\importRecord(), ilMediaPoolDataSet\importRecord(), ilPollDataSet\importRecord(), ilPortfolioDataSet\importRecord(), ilSessionDataSet\importRecord(), ilWikiDataSet\importRecord(), ilStyleDataSet\importRecord(), ilObjStyleSheetGUI\importStyleObject(), ilFileImporter\importXmlRepresentation(), ilFolderImporter\importXmlRepresentation(), ilForumImporter\importXmlRepresentation(), ilGlossaryImporter\importXmlRepresentation(), ilLearningModuleImporter\importXmlRepresentation(), ilSurveyImporter\importXmlRepresentation(), ilSurveyQuestionPoolImporter\importXmlRepresentation(), ilTestImporter\importXmlRepresentation(), ilTestQuestionPoolImporter\importXmlRepresentation(), ilWebResourceImporter\importXmlRepresentation(), ilFolderXmlWriter\init(), ilWebLinkXmlWriter\init(), ilPluginLP\initPlugin(), ilRoleXmlImporter\initRole(), ilParticipants\isGroupingMember(), ilObjRoleGUI\listUsersRoleObject(), ilSoapMailXmlParser\parseName(), ilExerciseSubmissionTableGUI\parseRow(), ilLPTableBaseGUI\parseTitle(), ilLocalUserGUI\performDeleteUsers(), ilObjCategoryGUI\performDeleteUsersObject(), ilObjWorkspaceFolderGUI\performPasteIntoMultipleObjects(), ilParticipants\readSubscribers(), ilPreviewGUI\renderPreview(), ilTestLP\resetCustomLPDataForUserIds(), ilSoapRBACAdministration\revokePermissions(), ilCronDeleteInactivatedUserAccounts\run(), ilPermissionGUI\savePermissions(), ilObjExercise\sendAssignment(), ilMailSearchCoursesGUI\showMembers(), ilNotificationSystem\toUsers(), ilPermissionGUI\unblockRoles(), ilSoapExerciseAdministration\updateExercise(), ilSoapFileAdministration\updateFile(), ilSoapObjectAdministration\updateObjects(), ilECSCourseCreationHandler\updateParallelCourses(), ilECSCourseCreationHandler\updateParallelGroups(), ilRegistrationSettingsGUI\updateRoles(), ilSoapWebLinkAdministration\updateWebLink(), and ilObjTestAccess\visibleUserResultExists().

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

int

$obj_id

object id

Returns

object instance of Ilias object (i.e. derived from ilObject)

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

        {
                global $ilias, $objDefinition, $ilDB;
 
                // 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
                
                $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!";
                                $ilias->raiseError($message,$ilias->error_obj->WARNING);
                                exit();
                        }
                        
                        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"].".";
                                $ilias->raiseError($message,$ilias->error_obj->WARNING);
                                exit();
                        }
                        
                        return false;
                }
 
                // get location
                $location = $objDefinition->getLocation($object_rec["type"]);
 
                // create instance
                include_once($location."/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->read();
                return $obj;
        }

References $ilDB, $location, $query, exit, and ilDBConstants\FETCHMODE_ASSOC.

Referenced by ilCourseArchives\__addHTMLFiles(), ilCourseArchives\__addZipFiles(), ilCourseArchives\__buildStructure(), ilConditionHandlerGUI\__construct(), ilCourseArchivesGUI\__initCourseObject(), ilCourseContentGUI\__initCourseObject(), ilCourseObjectivesGUI\__initCourseObject(), ilECSObjectSettings\_handleDelete(), ilForumNotification\_isParentNodeGrpCrs(), assQuestionGUI\addBackTab(), ilSoapCourseAdministration\addCourse(), ilSoapExerciseAdministration\addExercise(), ilSoapFileAdministration\addFile(), ilSoapObjectAdministration\addObject(), ilTestExpressPageObjectGUI\addPageOfQuestions(), ilSoapObjectAdministration\addReference(), ilSoapRBACAdministration\addRole(), ilSoapRBACAdministration\addRoleFromTemplate(), ilObjRoleGUI\askDeleteDesktopItemObject(), ilConditionHandlerGUI\assign(), ilObjCourseGroupingGUI\assignCourse(), ilSoapCourseAdministration\assignCourseMember(), ilSoapGroupAdministration\assignGroupMember(), ilObject2GUI\assignObject(), ilObjectGUI\assignObject(), assQuestionGUI\cancelSync(), ilSoapAdministration\checkObjectAccess(), ilForumNotification\checkParentNodeTree(), ilConditionHandlerGUI\chi_init(), ilContainerGUI\clipboardObject(), ilContainerGUI\cloneAllObject(), ilObjectGUI\cloneAllObject(), ilObjectActivation\cloneDependencies(), ilSoapUtils\cloneDependencies(), ilSoapUtils\cloneNode(), ilObjectCopyGUI\copyContainer(), ilObjectCopyGUI\copyMultipleNonContainer(), ilSoapObjectAdministration\copyObject(), ilObjStyleSheetGUI\copyStyleObject(), ilSoapWebLinkAdministration\createWebLink(), ilSoapObjectAdministration\deleteObject(), ilContainerReferenceAppEventListener\deleteReferences(), ilObjTest\ensureParticipantsLastActivePassFinished(), ilTestInfoScreenToolbarFactory\ensureTestObjectInitialised(), ilObjSessionGUI\eventsListObject(), ilSoapCourseAdministration\excludeCourseMember(), ilSoapGroupAdministration\excludeGroupMember(), ilTestExpressPageObjectGUI\executeCommand(), ilSessionOverviewGUI\exportCSV(), ilChatroomAdminViewGUI\forcePublicRoom(), ilSessionOverviewTableGUI\gatherEvents(), ilFolderDownloadBackgroundTaskHandler\gatherFiles(), ilForum\generatePost(), ilStudyProgrammeExpandableProgressListGUI\getAccordionContentCoursesHTML(), ilSoapGroupAdministration\getGroup(), ilObjectFactoryWrapper\getInstanceByRefId(), ilRoleDesktopItemsTableGUI\getItems(), ilSoapRBACAdministration\getLocalRoles(), ilCourseObjectiveQuestion\getMaxPointsByObjective(), ilCourseObjectiveQuestion\getMaxPointsByTest(), ilSoapObjectAdministration\getObjectByReference(), ilSoapObjectAdministration\getObjectsByTitle(), ilSoapRBACAdministration\getObjectTreeOperations(), ilOrgUnitExtension\getOrgUnit(), ilCourseStartObjectsTableGUI\getPossibleObjects(), ilContainerStartObjectsTableGUI\getPossibleObjects(), ilSoapLearningProgressAdministration\getProgressInfo(), ilCourseObjectivesGUI\getRandomTestQplOptions(), ilCourseStartObjectsTableGUI\getStartObjects(), ilContainerStartObjectsTableGUI\getStartObjects(), ilSOAPStructureObjectAdministration\getStructureObjects(), ilSoapObjectAdministration\getTreeChilds(), ilCategoryExporter\getXmlRepresentation(), ilCourseExporter\getXmlRepresentation(), ilGroupExporter\getXmlRepresentation(), ilContainerReferenceExporter\getXmlRepresentation(), ilSoapObjectAdministration\getXMLTree(), ilSoapRBACAdministration\grantPermissions(), ilRemoteObjectBase\handleDelete(), ilECSCategoryMapping\handleUpdate(), ilCourseObjective\ilClone(), ilObjStyleSheetGUI\importStyleObject(), ilSoapUserAdministration\importUsers(), ilCategoryImporter\importXmlRepresentation(), ilCourseImporter\importXmlRepresentation(), ilFolderImporter\importXmlRepresentation(), ilGroupImporter\importXmlRepresentation(), ilContainerReferenceImporter\initReference(), ilAssQuestionPreviewSettings\initSettingsWithTestObject(), ilDidacticTemplateAction\initSourceObject(), ilSoapCourseAdministration\isAssignedToCourse(), ilSoapGroupAdministration\isAssignedToGroup(), ilObjTest\isParticipantsLastPassActive(), ilObjectGUI\isVisible(), ilSoapUtils\linkNode(), ilLOUtils\lookupQplBySequence(), ilCourseObjectiveQuestionAssignmentTableGUI\parse(), ilContainerGUI\performPasteIntoMultipleObjectsObject(), ilObjQuestionPoolGUI\questionsObject(), ilRepUtil\removeDeletedNodes(), ilSoapObjectAdministration\removeFromSystemByImportId(), ilRepUtil\removeObjectsFromSystem(), ilSoapTestAdministration\removeTestResults(), ilMailGroupAddressType\resolve(), ilRepUtil\restoreObjects(), ilSoapRBACAdministration\revokePermissions(), ilWebResourceCronLinkCheck\run(), ilObjStyleSheetGUI\saveObject(), ilSoapObjectAdministration\searchObjects(), ilCourseMembershipMailNotification\send(), ilMailSearchGroupsGUI\showMembers(), assQuestionGUI\sync(), ilECSCmsTreeSynchronizer\syncCategory(), ilSoapCourseAdministration\updateCourse(), ilECSCourseCreationHandler\updateCourseData(), ilSoapGroupAdministration\updateGroup(), ilMembershipRegistrationCodeUtils\useCode(), and ilConditionHandler\validate().

Here is the caller graph for this function:

getObjectsForOwner()

ilObjectFactory::getObjectsForOwner	(		$object_type,
			$owner_id
	)

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

        {
                global $ilias, $ilDB;
 
                $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 $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

int

$obj_id

object id

Returns

string object type

Deprecated:

since version 5.3

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

        {
                global $ilias, $objDefinition, $ilDB;
 
                // 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=".$ilDB->quote($a_ref_id,'integer');
                $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(ilDBConstants::FETCHMODE_ASSOC);
                return $object_rec["type"];
        }

References $ilDB, exit, 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:

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

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

References $ilDB, $query, and $res.

---

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

• Services/Object/classes/class.ilObjectFactory.php