ILIAS  Release_5_0_x_branch Revision 61816
 All Data Structures Namespaces Files Functions Variables Groups Pages
ilObjectFactory Class Reference

Class ilObjectFactory. More...

+ Collaboration diagram for ilObjectFactory:

Public Member Functions

 ObjectIdExists ($a_obj_id)
 check if obj_id exists.
 getObjectsForOwner ($object_type, $owner_id)
 returns all objects of an owner, filtered by type, objects are not deleted!
 getInstanceByObjId ($a_obj_id, $stop_on_error=true)
 get an instance of an Ilias object by object id
 getInstanceByRefId ($a_ref_id, $stop_on_error=true)
 get an instance of an Ilias object by reference id
 getTypeByRefId ($a_ref_id, $stop_on_error=true)
 get object type by reference id

Static Public Member Functions

static getClassByType ($a_obj_type)
 Get class by type.

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:
class.ilObjectFactory.php 33501 2012-03-03 11:11:05Z akill

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

Member Function Documentation

static ilObjectFactory::getClassByType (   $a_obj_type)
static

Get class by type.

Returns

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

References $location.

Referenced by ilWorkspaceExplorer\__construct(), ilRepUtilGUI\confirmRemoveFromSystemObject(), ilWorkspaceTree\createTreeForUser(), ilAdministrationCommandGUI\delete(), ilObject2GUI\deleteConfirmation(), and ilRepUtilGUI\showDeleteConfirmation().

{
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;
}

+ Here is the caller graph for this function:

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

get an instance of an Ilias object by object id

Parameters
int$obj_idobject id
Returns
object instance of Ilias object (i.e. derived from ilObject)

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

References $ilDB, $location, DB_FETCHMODE_ASSOC, and exit.

Referenced by ilLearningProgressBaseGUI\__appendUserInfo(), ilRoleDesktopItem\__assign(), ilLocalUserGUI\__checkGlobalRoles(), ilObjCategoryGUI\__checkGlobalRoles(), ilCalendarUserSettings\__construct(), ilObjExercise\__formatRecipients(), ilLocalUserGUI\__getAssignableRoles(), ilObjCategoryGUI\__getAssignableRoles(), ilObjPaymentSettingsGUI\__getVendors(), ilLPListOfProgressGUI\__initUser(), ilLinkChecker\__sendMail(), ilLocalUserGUI\__showRolesTable(), ilObjCategoryGUI\__showRolesTable(), ilObjCourseGUI\__showWaitingList(), ilSearch\__validateResults(), ilObjGroup\_isMember(), ilPaymentStatisticGUI\addCustomer(), ilObjPaymentSettingsGUI\addCustomerObject(), ilInfoScreenGUI\addObjectSections(), ilSoapRBACAdministration\addUserRoleEntry(), ilObjPaymentSettingsGUI\addVendorWorksheet(), ilObjUserFolderGUI\appliedUsersObject(), ilSoapCourseAdministration\assignCourseMember(), ilObjGroupGUI\assignFromWaitingListObject(), ilObjCourseGUI\assignFromWaitingListObject(), ilSoapGroupAdministration\assignGroupMember(), ilExerciseMembers\assignMember(), ilObjCourseGUI\assignMembersObject(), ilObject2GUI\assignObject(), ilObjectGUI\assignObject(), ilLocalUserGUI\assignRoles(), ilObjCategoryGUI\assignRolesObject(), ilParticipants\assignSubscriber(), ilChatroom\byRoomId(), ilWorkspaceTree\cascadingDelete(), ilObjiLincCourseGUI\changeMemberObject(), ilUserCronCheckAccounts\checkNotConfirmedUserAccounts(), ilObjPortfolioBase\cloneBasics(), ilStartUpGUI\confirmRegistration(), ilContainerXmlParser\createObject(), ilObjWorkspaceFolderGUI\cut(), ilExerciseMembers\deassignMember(), ilObject2GUI\deleteConfirmedObjects(), ilSoapUtils\deleteExpiredDualOptInUserObjects(), ilRepUtil\deleteObjects(), ilSoapRBACAdministration\deleteRole(), ilObjRoleFolderGUI\deleteRoleObject(), ilObjCourseGUI\deleteSubscribers(), ilSoapUserAdministration\deleteUser(), ilSoapRBACAdministration\deleteUserRoleEntry(), ilObjBlog\doCloneObject(), ilObjExerciseGUI\downloadAllObject(), ilObjUserFolderGUI\editAppliedUsersObject(), ilPaymentStatisticGUI\editStatistic(), ilObjPaymentSettingsGUI\editStatisticObject(), ilObjCourseGUI\fetchPrintMemberData(), ilObjCourseGUI\fetchPrintSubscriberData(), ilPublicSubmissionsTableGUI\fillRow(), ilExerciseMemberTableGUI\fillRow(), 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(), ilSoapRBACAdministration\getRoles(), ilChatroom\getTitle(), ilSoapUserAdministration\getUser(), ilSoapRBACAdministration\getUserRoles(), ilSoapRBACAdministration\grantPermissions(), ilECSTaskScheduler\handleDeprecatedAccounts(), ilECSAppEventListener\handleEvent(), ilRemoteObjectBase\handleUpdate(), ilObjTestAccess\hasFinished(), ilExternalFeedBlockGUI\importFile(), ilObjectGUI\importFileObject(), ilExternalFeedDataSet\importRecord(), ilHTMLLearningModuleDataSet\importRecord(), ilItemGroupDataSet\importRecord(), ilMediaPoolDataSet\importRecord(), ilMediaCastDataSet\importRecord(), ilPortfolioDataSet\importRecord(), ilPollDataSet\importRecord(), ilWikiDataSet\importRecord(), ilSessionDataSet\importRecord(), ilBlogDataSet\importRecord(), ilExerciseDataSet\importRecord(), ilSurveyQuestionPoolImporter\importXmlRepresentation(), ilSurveyImporter\importXmlRepresentation(), ilForumImporter\importXmlRepresentation(), ilLearningModuleImporter\importXmlRepresentation(), ilGlossaryImporter\importXmlRepresentation(), ilFileImporter\importXmlRepresentation(), ilTestImporter\importXmlRepresentation(), ilTestQuestionPoolImporter\importXmlRepresentation(), ilFolderImporter\importXmlRepresentation(), ilWebResourceImporter\importXmlRepresentation(), ilWebLinkXmlWriter\init(), ilFolderXmlWriter\init(), ilPluginLP\initPlugin(), ilRoleXmlImporter\initRole(), ilObjiLincCourseGUI\listUsersGroupObject(), ilObjiLincCourseGUI\listUsersRoleObject(), ilObjRoleGUI\listUsersRoleObject(), ilAuthContainerSOAP\loginObserver(), ilObjGroupGUI\membersGalleryObject(), ilObjiLincCourseGUI\membersGalleryObject(), ilObjCourseGUI\membersGalleryObject(), ilObjPaymentSettingsGUI\objectsObject(), ilSoapMailXmlParser\parseName(), ilLPTableBaseGUI\parseTitle(), ilLocalUserGUI\performDeleteUsers(), ilObjCategoryGUI\performDeleteUsersObject(), ilObjWorkspaceFolderGUI\performPasteIntoMultipleObjects(), ilPaymentTrusteeGUI\performSearch(), ilPaymentStatisticGUI\performSearch(), ilObjPaymentSettingsGUI\performSearchSPObject(), ilParticipants\readSubscribers(), ilObjCourseGUI\redirectLocToTestObject(), ilObjCourseGUI\removeFromWaitingList(), ilObjiLincCourseGUI\removeMemberObject(), ilPreviewGUI\renderPreview(), ilTestLP\resetCustomLPDataForUserIds(), ilSoapRBACAdministration\revokePermissions(), ilCronDeleteInactivatedUserAccounts\run(), ilPermissionGUI\savePermissions(), ilObjiLincCourseGUI\searchObject(), ilObjPaymentSettingsGUI\searchObject(), ilShopBoughtObjectsGUI\showItems(), ilMailSearchCoursesGUI\showMembers(), ilPaymentTrusteeGUI\showTrustees(), ilObjUserFolderGUI\updateAppliedUsersObject(), ilSoapExerciseAdministration\updateExercise(), ilSoapFileAdministration\updateFile(), ilSoapObjectAdministration\updateObjects(), ilECSCourseCreationHandler\updateParallelCourses(), ilECSCourseCreationHandler\updateParallelGroups(), ilSoapUserAdministration\updatePassword(), ilRegistrationSettingsGUI\updateRoles(), ilSoapWebLinkAdministration\updateWebLink(), and ilObjPaymentSettingsGUI\vendorsObject().

{
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(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 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->setObjDataRecord($object_rec);
$obj->read();
return $obj;
}

+ Here is the caller graph for this function:

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

get an instance of an Ilias object by reference id

Parameters
int$obj_idobject id
Returns
object instance of Ilias object (i.e. derived from ilObject)

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

References $ilDB, $location, $query, DB_FETCHMODE_ASSOC, and exit.

Referenced by ilCourseArchives\__addHTMLFiles(), ilCourseArchives\__addZipFiles(), ilCourseArchives\__buildStructure(), ilShopPurchaseGUI\__construct(), ilConditionHandlerGUI\__construct(), ilObjPaymentSettingsGUI\__editPricesTable(), ilForum\__formatMessage(), ilObjExerciseGUI\__getMembersOfObject(), ilPurchaseBaseGUI\__getShoppingCart(), ilCourseObjectivesGUI\__initCourseObject(), ilCourseArchivesGUI\__initCourseObject(), ilCourseContentGUI\__initCourseObject(), ilObjExerciseGUI\__showObjectSelect(), ilPurchaseBaseGUI\__showShoppingCart(), ilECSObjectSettings\_handleDelete(), ilForumNotification\_isParentNodeGrpCrs(), ilShopUtils\_sendNotificationToVATAdministration(), assQuestionGUI\addBackTab(), ilSoapCourseAdministration\addCourse(), ilPaymentStatisticGUI\addCustomer(), ilObjPaymentSettingsGUI\addCustomerObject(), 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(), ilObjectGUI\cloneAllObject(), ilContainerGUI\cloneAllObject(), ilSoapUtils\cloneDependencies(), ilObjectActivation\cloneDependencies(), ilSoapUtils\cloneNode(), ilObjectCopyGUI\copyContainer(), ilObjectCopyGUI\copyMultipleNonContainer(), ilSoapObjectAdministration\copyObject(), ilObjectCopyGUI\copySingleObject(), ilObjStyleSheetGUI\copyStyleObject(), ilSoapWebLinkAdministration\createWebLink(), ilSoapObjectAdministration\deleteObject(), ilRepUtil\deleteObjects(), ilSoapLearningProgressAdministration\deleteProgress(), ilContainerReferenceAppEventListener\deleteReferences(), ilObjPaymentSettingsGUI\editDetailsObject(), ilObjPaymentSettingsGUI\editPriceObject(), ilObjTest\ensureParticipantsLastActivePassFinished(), ilObjSessionGUI\eventsListObject(), ilSoapCourseAdministration\excludeCourseMember(), ilSoapGroupAdministration\excludeGroupMember(), ilTestExpressPageObjectGUI\executeCommand(), ilSessionOverviewGUI\exportCSV(), ilChatroomViewTask\forcePublicRoom(), ilForum\generatePost(), ilMail\getEmailsOfRecipients(), ilSoapGroupAdministration\getGroup(), ilSoapRBACAdministration\getLocalRoles(), ilCourseObjectiveQuestion\getMaxPointsByObjective(), ilCourseObjectiveQuestion\getMaxPointsByTest(), ilSoapObjectAdministration\getObjectByReference(), ilSoapObjectAdministration\getObjectsByTitle(), ilSoapRBACAdministration\getObjectTreeOperations(), ilCourseStartObjectsTableGUI\getPossibleObjects(), ilContainerStartObjectsTableGUI\getPossibleObjects(), ilCourseObjectivesGUI\getRandomTestQplOptions(), ilPaymentShoppingCart\getShoppingCart(), ilCourseStartObjectsTableGUI\getStartObjects(), ilContainerStartObjectsTableGUI\getStartObjects(), ilSOAPStructureObjectAdministration\getStructureObjects(), ilSoapObjectAdministration\getTreeChilds(), ilMail\getUserIds(), ilContainerReferenceExporter\getXmlRepresentation(), ilCourseExporter\getXmlRepresentation(), ilGroupExporter\getXmlRepresentation(), ilCategoryExporter\getXmlRepresentation(), ilSoapObjectAdministration\getXMLTree(), ilSoapRBACAdministration\grantPermissions(), ilRemoteObjectBase\handleDelete(), ilECSCategoryMapping\handleUpdate(), ilCourseObjective\ilClone(), ilObjStyleSheetGUI\importStyleObject(), ilSoapUserAdministration\importUsers(), ilCategoryImporter\importXmlRepresentation(), ilCourseImporter\importXmlRepresentation(), ilGroupImporter\importXmlRepresentation(), ilFolderImporter\importXmlRepresentation(), ilContainerReferenceImporter\initReference(), ilAssQuestionPreviewSettings\initSettingsWithTestObject(), ilDidacticTemplateAction\initSourceObject(), ilRepUtil\insertSavedNodes(), ilSoapCourseAdministration\isAssignedToCourse(), ilSoapGroupAdministration\isAssignedToGroup(), ilObjTest\isParticipantsLastPassActive(), ilObjectGUI\isVisible(), ilSoapUtils\linkNode(), ilObjRoleGUI\listDesktopItemsObject(), ilSessionOverviewGUI\listSessions(), ilObjiLincCourseGUI\listUsersGroupObject(), ilLOUtils\lookupQplBySequence(), ilObjPaymentSettingsGUI\objectsObject(), ilCourseObjectiveQuestionAssignmentTableGUI\parse(), ilContainerGUI\performPasteIntoMultipleObjectsObject(), ilObjDlBookGUI\properties(), ilObjQuestionPoolGUI\questionsObject(), ilRepUtil\removeDeletedNodes(), ilSoapObjectAdministration\removeFromSystemByImportId(), ilRepUtil\removeObjectsFromSystem(), ilSoapTestAdministration\removeTestResults(), ilRepUtil\restoreObjects(), ilSoapRBACAdministration\revokePermissions(), ilWebResourceCronLinkCheck\run(), ilObjStyleSheetGUI\saveObject(), ilObjiLincCourseGUI\searchObject(), ilSoapObjectAdministration\searchObjects(), ilCourseMembershipMailNotification\send(), ilObjDlBookGUI\showAbstract(), ilPaymentCouponGUI\showCoupons(), ilShopPurchaseGUI\showDemoVersion(), ilShopBoughtObjectsGUI\showItems(), ilMailSearchGroupsGUI\showMembers(), ilPaymentCouponGUI\showObjects(), ilPaymentObjectGUI\showSelectedObject(), ilObjDlBookGUI\showTranslationSelect(), assQuestionGUI\sync(), ilECSCmsTreeSynchronizer\syncCategory(), ilSoapCourseAdministration\updateCourse(), ilECSCourseCreationHandler\updateCourseData(), ilSoapGroupAdministration\updateGroup(), ilMembershipRegistrationCodeUtils\useCode(), and ilConditionHandler\validate().

{
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(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 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->setObjDataRecord($object_rec);
$obj->read();
return $obj;
}

+ Here is the caller graph for this function:

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.

References $ilDB, $query, $res, and DB_FETCHMODE_ASSOC.

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

{
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(DB_FETCHMODE_ASSOC)) {
$obj_ids [] = $object_rec["obj_id"];
}
return $obj_ids;
}

+ Here is the caller graph for this function:

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

get object type by reference id

Parameters
int$obj_idobject id
Returns
string object type

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

References $ilDB, DB_FETCHMODE_ASSOC, and exit.

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

{
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(DB_FETCHMODE_ASSOC);
return $object_rec["type"];
}

+ Here is the caller graph for this function:

ilObjectFactory::ObjectIdExists (   $a_obj_id)

check if obj_id exists.

To check for ref_ids use ilTree::isInTree()

Parameters
int$obj_idobject id
Returns
bool

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

References $ilDB, $query, and $res.

{
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;
}

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