ILIAS  release_5-2 Revision v5.2.25-18-g3f80b828510
ilObjIndividualAssessment Class Reference

For the purpose of streamlining the grading and learning-process status definition outside of tests, SCORM courses e.t.c. More...

+ Inheritance diagram for ilObjIndividualAssessment:
+ Collaboration diagram for ilObjIndividualAssessment:

Public Member Functions

 __construct ($a_id=0, $a_call_by_reference=true)
 Constructor @access public. More...
 
 create ()
 createnote: title, description and type should be set when this function is called@access public

Returns
integer object id
More...
 
 read ()
 read object data from db into object
Parameters
boolean@access public
More...
 
 getSettings ()
 
 getInfoSettings ()
 
 loadMembers ()
 Get the members object associated with this. More...
 
 updateMembers (ilIndividualAssessmentMembers $members)
 Update the members object associated with this. More...
 
 delete ()
 delete object or referenced object (in the case of a referenced object, object data is only deleted if last reference is deleted) This function removes an object entirely from system!!@access public

Returns
boolean true if object was removed completely; false if only a references was removed
More...
 
 update ()
 update object in db@access public

Returns
boolean true on success
More...
 
 updateInfo ()
 
 membersStorage ()
 Get the member storage object used by this. More...
 
 initDefaultRoles ()
 init default roles settings Purpose of this function is to create a local role folder and local roles, that are needed depending on the object type If you want to setup default local roles you MUST overwrite this method in derived object classes (see ilObjForum for an example) @access public
Returns
array empty array
More...
 
 accessHandler ()
 Get the access handler of this. More...
 
 cloneObject ($a_target_id, $a_copy_id=0, $a_omit_tree=false)
 Clone object permissions, put in tree ...@access public

Parameters
inttarget id
intcopy id for class.ilCopyWizardOptions()
Returns
object new object
More...
 
 isActiveLP ()
 Check wether the LP is activated for current object. More...
 
 getParentContainerIdByType ($id, array $types)
 Bubbles up the tree. More...
 
- Public Member Functions inherited from ilObject
 __construct ($a_id=0, $a_reference=true)
 Constructor @access public. More...
 
 withReferences ()
 determines wehter objects are referenced or not (got ref ids or not) More...
 
 read ()
 read object data from db into object More...
 
 getId ()
 get object id @access public More...
 
 setId ($a_id)
 set object id @access public More...
 
 setRefId ($a_id)
 set reference id @access public More...
 
 getRefId ()
 get reference id @access public More...
 
 getType ()
 get object type @access public More...
 
 setType ($a_type)
 set object type @access public More...
 
 getPresentationTitle ()
 get presentation title Normally same as title Overwritten for sessions More...
 
 getTitle ()
 get object title @access public More...
 
 getUntranslatedTitle ()
 get untranslated object title @access public More...
 
 setTitle ($a_title)
 set object title More...
 
 getDescription ()
 get object description More...
 
 setDescription ($a_desc)
 set object description More...
 
 getLongDescription ()
 get object long description (stored in object_description) More...
 
 getImportId ()
 get import id More...
 
 setImportId ($a_import_id)
 set import id More...
 
 getOwner ()
 get object owner More...
 
 getOwnerName ()
 
 setOwner ($a_owner)
 set object owner More...
 
 getCreateDate ()
 get create date @access public More...
 
 getLastUpdateDate ()
 get last update date @access public More...
 
 getDiskUsage ()
 
 create ()
 create More...
 
 update ()
 update object in db More...
 
 MDUpdateListener ($a_element)
 Meta data update listener. More...
 
 createMetaData ()
 create meta data entry More...
 
 updateMetaData ()
 update meta data entry More...
 
 deleteMetaData ()
 delete meta data entry More...
 
 updateOwner ()
 update owner of object in db More...
 
 putInTree ($a_parent_ref)
 maybe this method should be in tree object!? More...
 
 setPermissions ($a_parent_ref)
 set permissions of object More...
 
 setParentRolePermissions ($a_parent_ref)
 Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g courses, groups for building permission intersections with non_member templates. More...
 
 createReference ()
 creates reference for object More...
 
 countReferences ()
 count references of object More...
 
 delete ()
 delete object or referenced object (in the case of a referenced object, object data is only deleted if last reference is deleted) This function removes an object entirely from system!! More...
 
 initDefaultRoles ()
 init default roles settings Purpose of this function is to create a local role folder and local roles, that are needed depending on the object type If you want to setup default local roles you MUST overwrite this method in derived object classes (see ilObjForum for an example) @access public More...
 
 applyDidacticTemplate ($a_tpl_id)
 Apply template. More...
 
 setRegisterMode ($a_bool)
 
 isUserRegistered ($a_user_id=0)
 
 requireRegistration ()
 
 getXMLZip ()
 
 getHTMLDirectory ()
 
 cloneObject ($a_target_id, $a_copy_id=0, $a_omit_tree=false)
 Clone object permissions, put in tree ... More...
 
 appendCopyInfo ($a_target_id, $a_copy_id)
 Prepend Copy info if object with same name exists in that container. More...
 
 cloneDependencies ($a_target_id, $a_copy_id)
 Clone object dependencies. More...
 
 cloneMetaData ($target_obj)
 Copy meta data. More...
 
 getPossibleSubObjects ($a_filter=true)
 get all possible subobjects of this type the object can decide which types of subobjects are possible jut in time overwrite if the decision distinguish from standard model More...
 

Protected Attributes

 $lp_active = null
 

Additional Inherited Members

- Static Public Member Functions inherited from ilObject
static _lookupObjIdByImportId ($a_import_id)
 
static _lookupImportId ($a_obj_id)
 
static _lookupOwnerName ($a_owner_id)
 lookup owner name for owner id More...
 
static _getIdForImportId ($a_import_id)
 get current object id for import id (static) More...
 
static _getAllReferences ($a_id)
 get all reference ids of object More...
 
static _lookupTitle ($a_id)
 lookup object title More...
 
static _lookupOwner ($a_id)
 lookup object owner More...
 
static _getIdsForTitle ($title, $type='', $partialmatch=false)
 
static _lookupDescription ($a_id)
 lookup object description More...
 
static _lookupLastUpdate ($a_id, $a_as_string=false)
 lookup last update More...
 
static _getLastUpdateOfObjects ($a_objs)
 Get last update for a set of media objects. More...
 
static _lookupObjId ($a_id)
 
static _setDeletedDate ($a_ref_id)
 only called in ilTree::saveSubTree More...
 
static setDeletedDates ($a_ref_ids)
 Set deleted date @global type $ilDB. More...
 
static _resetDeletedDate ($a_ref_id)
 only called in ilObjectGUI::insertSavedNodes More...
 
static _lookupDeletedDate ($a_ref_id)
 only called in ilObjectGUI::insertSavedNodes More...
 
static _writeTitle ($a_obj_id, $a_title)
 write title to db (static) More...
 
static _writeDescription ($a_obj_id, $a_desc)
 write description to db (static) More...
 
static _writeImportId ($a_obj_id, $a_import_id)
 write import id to db (static) More...
 
static _lookupType ($a_id, $a_reference=false)
 lookup object type More...
 
static _isInTrash ($a_ref_id)
 checks wether object is in trash More...
 
static _hasUntrashedReference ($a_obj_id)
 checks wether an object has at least one reference that is not in trash More...
 
static _lookupObjectId ($a_ref_id)
 lookup object id More...
 
static _getObjectsDataForType ($a_type, $a_omit_trash=false)
 get all objects of a certain type More...
 
static _exists ($a_id, $a_reference=false, $a_type=null)
 checks if an object exists in object_data@access public More...
 
static _getObjectsByType ($a_obj_type="", $a_owner="")
 Get objects by type. More...
 
static _prepareCloneSelection ($a_ref_ids, $new_type, $show_path=true)
 Prepare copy wizard object selection. More...
 
static _getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
 Get icon for repository item. More...
 
static collectDeletionDependencies (&$deps, $a_ref_id, $a_obj_id, $a_type, $a_depth=0)
 Collect deletion dependencies. More...
 
static getDeletionDependencies ($a_obj_id)
 Get deletion dependencies. More...
 
static getLongDescriptions (array $a_obj_ids)
 Get long description data. More...
 
static getAllOwnedRepositoryObjects ($a_user_id)
 Get all ids of objects user owns. More...
 
static fixMissingTitles ($a_type, array &$a_obj_title_map)
 Try to fix missing object titles. More...
 
static _lookupCreationDate ($a_id)
 Lookup creation date. More...
 
static hasAutoRating ($a_type, $a_ref_id)
 Check if auto rating is active for parent group/course. More...
 
- Data Fields inherited from ilObject
const TITLE_LENGTH = 255
 max length of object title More...
 
const DESC_LENGTH = 128
 
 $ilias
 
 $lng
 
 $id
 
 $ref_id
 
 $type
 
 $title
 
 $untranslatedTitle
 
 $desc
 
 $long_desc
 
 $owner
 
 $create_date
 
 $last_update
 
 $import_id
 
 $register = false
 
 $referenced
 
 $objectList
 
 $max_title
 
 $max_desc
 
 $add_dots
 

Detailed Description

For the purpose of streamlining the grading and learning-process status definition outside of tests, SCORM courses e.t.c.

the IndividualAssessment is used. It caries a LPStatus, which is set Individually.

Author
Denis Klöpfer denis.nosp@m..klo.nosp@m.epfer.nosp@m.@con.nosp@m.cepts.nosp@m.-and.nosp@m.-trai.nosp@m.ning.nosp@m..de

Definition at line 16 of file class.ilObjIndividualAssessment.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjIndividualAssessment::__construct (   $a_id = 0,
  $a_reference = true 
)

Constructor @access public.

Parameters
integerreference_id or object_id
booleantreat the id as reference_id (true) or object_id (false)

Reimplemented from ilObject.

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

20 {
21 global $DIC;
22 $this->type = 'iass';
23 parent::__construct($a_id, $a_call_by_reference);
24 $this->settings_storage = new ilIndividualAssessmentSettingsStorageDB($DIC['ilDB']);
25 $this->members_storage = new ilIndividualAssessmentMembersStorageDB($DIC['ilDB']);
26 $this->access_handler = new ilIndividualAssessmentAccessHandler(
27 $DIC['ilAccess']
28 ,$DIC['rbacadmin']
29 ,$DIC['rbacreview']
30 ,$DIC['ilUser']);
31
32 }
A settings storage handler to write iass settings to db.
global $DIC

References $DIC.

Member Function Documentation

◆ accessHandler()

ilObjIndividualAssessment::accessHandler ( )

Get the access handler of this.

Returns
IndividualAssessmentAccessHandler

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

131 {
132 return $this->access_handler;
133 }

◆ cloneObject()

ilObjIndividualAssessment::cloneObject (   $a_target_id,
  $a_copy_id = 0,
  $a_omit_tree = false 
)

Clone object permissions, put in tree ...@access public

Parameters
inttarget id
intcopy id for class.ilCopyWizardOptions()
Returns
object new object

Reimplemented from ilObject.

Definition at line 138 of file class.ilObjIndividualAssessment.php.

138 {
139 $new_obj = parent::cloneObject($a_target_id,$a_copy_id, $a_omit_tree);
140 $settings = $this->getSettings();
141 $info_settings = $this->getInfoSettings();
142 $new_settings = new ilIndividualAssessmentSettings($new_obj,
143 $settings->content()
144 ,$settings->recordTemplate());
145 $new_obj->settings = $new_settings;
146
147 $new_info_settings = new ilIndividualAssessmentInfoSettings($new_obj,
148 $info_settings->contact()
149 ,$info_settings->responsibility()
150 ,$info_settings->phone()
151 ,$info_settings->mails()
152 ,$info_settings->consultationHours());
153 $new_obj->settings = $new_settings;
154 $new_obj->info_settings = $new_info_settings;
155 $new_obj->settings_storage->updateSettings($new_settings);
156 $new_obj->settings_storage->updateInfoSettings($new_info_settings);
157 return $new_obj;
158 }
An object carrying settings of an Individual Assessment obj beyond the standart information.

References getInfoSettings(), and getSettings().

+ Here is the call graph for this function:

◆ create()

ilObjIndividualAssessment::create ( )

createnote: title, description and type should be set when this function is called@access public

Returns
integer object id

Reimplemented from ilObject.

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

37 {
38 parent::create();
39 $this->settings = new ilIndividualAssessmentSettings($this);
40 $this->settings_storage->createSettings($this->settings);
41 }
settings()
Definition: settings.php:2

References settings().

+ Here is the call graph for this function:

◆ delete()

ilObjIndividualAssessment::delete ( )

delete object or referenced object (in the case of a referenced object, object data is only deleted if last reference is deleted) This function removes an object entirely from system!!@access public

Returns
boolean true if object was removed completely; false if only a references was removed

Reimplemented from ilObject.

Definition at line 92 of file class.ilObjIndividualAssessment.php.

92 {
93 $this->settings_storage->deleteSettings($this);
94 $this->members_storage->deleteMembers($this);
95 parent::delete();
96 }

◆ getInfoSettings()

ilObjIndividualAssessment::getInfoSettings ( )

Definition at line 64 of file class.ilObjIndividualAssessment.php.

64 {
65 if(!$this->info_settings) {
66 $this->info_settings = $this->settings_storage->loadInfoSettings($this);
67 }
68 return $this->info_settings;
69 }

Referenced by cloneObject().

+ Here is the caller graph for this function:

◆ getParentContainerIdByType()

ilObjIndividualAssessment::getParentContainerIdByType (   $id,
array  $types 
)

Bubbles up the tree.

Starts from object with id $id. Ends at root or when a given $type of object is found.

@global array $DIC

Parameters
int$idstart at this id
string[]$typessearch for these strings
Returns
int the obj_id or 0 if root is reached

Definition at line 184 of file class.ilObjIndividualAssessment.php.

184 {
185 global $DIC;
186
187 $tree = $DIC['tree'];
188 $node = $tree->getParentNodeData($id);
189
190 while($node['type'] !== "root") {
191 if(in_array($node['type'], $types)) {
192 return $node['ref_id'];
193 }
194 $node = $tree->getParentNodeData($node['ref_id']);
195 }
196 return 0;
197 }

References $DIC, and ilObject\$id.

◆ getSettings()

ilObjIndividualAssessment::getSettings ( )

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

57 {
58 if(!$this->settings) {
59 $this->settings = $this->settings_storage->loadSettings($this);
60 }
61 return $this->settings;
62 }

References settings().

Referenced by cloneObject().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ initDefaultRoles()

ilObjIndividualAssessment::initDefaultRoles ( )

init default roles settings Purpose of this function is to create a local role folder and local roles, that are needed depending on the object type If you want to setup default local roles you MUST overwrite this method in derived object classes (see ilObjForum for an example) @access public

Returns
array empty array

Reimplemented from ilObject.

Definition at line 122 of file class.ilObjIndividualAssessment.php.

122 {
123 $this->access_handler->initDefaultRolesForObject($this);
124 }

◆ isActiveLP()

ilObjIndividualAssessment::isActiveLP ( )

Check wether the LP is activated for current object.

Returns
bool

Definition at line 165 of file class.ilObjIndividualAssessment.php.

165 {
166 if($this->lp_active === null) {
167 require_once 'Modules/IndividualAssessment/classes/LearningProgress/class.ilIndividualAssessmentLPInterface.php';
168 $this->lp_active = ilIndividualAssessmentLPInterface::isActiveLP($this->getId());
169 }
170 return $this->lp_active;
171 }
getId()
get object id @access public

References $lp_active, ilObject\getId(), and ilIndividualAssessmentLPInterface\isActiveLP().

+ Here is the call graph for this function:

◆ loadMembers()

ilObjIndividualAssessment::loadMembers ( )

Get the members object associated with this.

Returns
ilIndividualAssessmentMembers

Definition at line 76 of file class.ilObjIndividualAssessment.php.

76 {
77 return $this->members_storage->loadMembers($this);
78 }

◆ membersStorage()

ilObjIndividualAssessment::membersStorage ( )

Get the member storage object used by this.

Returns
ilIndividualAssessmentMembersStorage

Definition at line 115 of file class.ilObjIndividualAssessment.php.

115 {
116 return $this->members_storage;
117 }

◆ read()

ilObjIndividualAssessment::read ( )

read object data from db into object

Parameters
boolean@access public

Reimplemented from ilObject.

Definition at line 46 of file class.ilObjIndividualAssessment.php.

46 {
47 parent::read();
48 global $DIC;
49 $settings_storage = new ilIndividualAssessmentSettingsStorageDB($DIC['ilDB']);
50 $this->settings = $settings_storage->loadSettings($this);
51 $this->info_settings = $settings_storage->loadInfoSettings($this);
52 }

References $DIC, and settings().

+ Here is the call graph for this function:

◆ update()

ilObjIndividualAssessment::update ( )

update object in db@access public

Returns
boolean true on success

Reimplemented from ilObject.

Definition at line 101 of file class.ilObjIndividualAssessment.php.

101 {
102 parent::update();
103 $this->settings_storage->updateSettings($this->settings);
104 }

References settings().

+ Here is the call graph for this function:

◆ updateInfo()

ilObjIndividualAssessment::updateInfo ( )

Definition at line 106 of file class.ilObjIndividualAssessment.php.

106 {
107 $this->settings_storage->updateInfoSettings($this->info_settings);
108 }

◆ updateMembers()

ilObjIndividualAssessment::updateMembers ( ilIndividualAssessmentMembers  $members)

Update the members object associated with this.

Parameters
ilIndividualAssessmentMembers$members

Definition at line 85 of file class.ilObjIndividualAssessment.php.

85 {
86 $members->updateStorageAndRBAC($this->members_storage, $this->access_handler);
87 }
updateStorageAndRBAC(ilIndividualAssessmentMembersStorage $storage, IndividualAssessmentAccessHandler $access_handler)
Store the data to a persistent medium.

References ilIndividualAssessmentMembers\updateStorageAndRBAC().

+ Here is the call graph for this function:

Field Documentation

◆ $lp_active

ilObjIndividualAssessment::$lp_active = null
protected

Definition at line 18 of file class.ilObjIndividualAssessment.php.

Referenced by isActiveLP().


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