ILIAS  release_7 Revision v7.30-3-g800a261c036
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)
 
 create ()
 
 read ()
 
 getSettings ()
 
 setSettings (ilIndividualAssessmentSettings $settings)
 Set the settings. More...
 
 getInfoSettings ()
 
 setInfoSettings (ilIndividualAssessmentInfoSettings $info)
 Set info settings. More...
 
 loadMembers ()
 Get the members object associated with this. More...
 
 loadMembersAsSingleObjects (string $filter=null, string $sort=null)
 Get the members as single object associated with this. More...
 
 loadVisibleMembers ()
 Get the members object associated with this and visible by the current user. More...
 
 updateMembers (ilIndividualAssessmentMembers $members)
 Update the members object associated with this. More...
 
 delete ()
 
 update ()
 
 updateInfo ()
 
 membersStorage ()
 Get the member storage object used by this. More...
 
 initDefaultRoles ()
 
 accessHandler ()
 Get the access handler of this. More...
 
 cloneObject ($a_target_id, $a_copy_id=0, $a_omit_tree=false)
 
 getFileStorage ()
 Get the file storage system. More...
 
 isActiveLP ()
 Check wether the LP is activated for current object. More...
 
 getParentContainerIdByType ($id, array $types)
 Bubbles up the tree. More...
 
 getMembersGUI ()
 
 getSettingsGUI ()
 
- Public Member Functions inherited from ilObject
 __construct ($a_id=0, $a_reference=true)
 Constructor 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 public More...
 
 setId ($a_id)
 set object id public More...
 
 setRefId ($a_id)
 set reference id public More...
 
 getRefId ()
 get reference id public More...
 
 getType ()
 get object type public More...
 
 setType ($a_type)
 set object type public More...
 
 getPresentationTitle ()
 get presentation title Normally same as title Overwritten for sessions More...
 
 getTitle ()
 get object title public More...
 
 getUntranslatedTitle ()
 get untranslated object title 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...
 
 setOfflineStatus ($a_status)
 Set offline status. More...
 
 getOfflineStatus ()
 Get offline status. More...
 
 supportsOfflineHandling ()
 Check whether object supports offline handling. More...
 
 getOwner ()
 get object owner More...
 
 getOwnerName ()
 
 setOwner ($a_owner)
 set object owner More...
 
 getCreateDate ()
 get create date public More...
 
 getLastUpdateDate ()
 get last update date public More...
 
 getDiskUsage ()
 Gets the disk usage of the object in bytes. More...
 
 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) public More...
 
 applyDidacticTemplate ($a_tpl_id)
 Apply template. More...
 
 setRegisterMode ($a_bool)
 
 isUserRegistered ($a_user_id=0)
 
 requireRegistration ()
 
 getXMLZip ()
 
 getHTMLDirectory ()
 
 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 Member Functions

 getDic ()
 

Protected Attributes

 $lp_active = null
 
 $settings
 
 $settings_storage
 
 $members_storage
 
 $access_handler
 
 $il_access_handler
 
 $dic
 
- Protected Attributes inherited from ilObject
 $objDefinition
 
 $db
 
 $log
 
 $error
 
 $tree
 
 $app_event_handler
 
 $rbacadmin
 
 $rbacreview
 

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 lookupOfflineStatus ($a_obj_id)
 Lookup offline status using objectDataCache. 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, $a_deleted_by)
 
static setDeletedDates ($a_ref_ids, $a_user_id)
 Set deleted date. 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 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
 
 $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 10 of file class.ilObjIndividualAssessment.php.

Constructor & Destructor Documentation

◆ __construct()

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

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

References $DIC, and ILIAS\GlobalScreen\Provider\__construct().

50  {
51  global $DIC;
52  $this->type = 'iass';
53  $this->il_access_handler = $DIC["ilAccess"];
54  parent::__construct($a_id, $a_call_by_reference);
55  $this->settings_storage = new ilIndividualAssessmentSettingsStorageDB($DIC['ilDB']);
56  $this->members_storage = new ilIndividualAssessmentMembersStorageDB($DIC['ilDB']);
57  $this->access_handler = new ilIndividualAssessmentAccessHandler(
58  $this,
59  $DIC['ilAccess'],
60  $DIC['rbacadmin'],
61  $DIC['rbacreview'],
62  $DIC['ilUser']
63  );
64  }
A settings storage handler to write iass settings to db.
global $DIC
Definition: goto.php:24
__construct(Container $dic, ilPlugin $plugin)
+ Here is the call graph for this function:

Member Function Documentation

◆ accessHandler()

ilObjIndividualAssessment::accessHandler ( )

Get the access handler of this.

Returns
IndividualAssessmentAccessHandler

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

References $access_handler.

◆ cloneObject()

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

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

References $settings, getFileStorage(), getInfoSettings(), and getSettings().

232  {
233  $new_obj = parent::cloneObject($a_target_id, $a_copy_id, $a_omit_tree);
234  $settings = $this->getSettings();
235  $info_settings = $this->getInfoSettings();
236  $new_settings = new ilIndividualAssessmentSettings(
237  (int) $new_obj->getId(),
238  (int) $new_obj->getTitle(),
239  (int) $new_obj->getDescription(),
240  $settings->getContent(),
241  $settings->getRecordTemplate(),
242  $settings->isEventTimePlaceRequired(),
243  $settings->isFileRequired()
244  );
245  $new_obj->settings = $new_settings;
246 
247  $new_info_settings = new ilIndividualAssessmentInfoSettings(
248  (int) $new_obj->getId(),
249  $info_settings->getContact(),
250  $info_settings->getResponsibility(),
251  $info_settings->getPhone(),
252  $info_settings->getMails(),
253  $info_settings->getConsultationHours()
254  );
255  $new_obj->settings = $new_settings;
256  $new_obj->info_settings = $new_info_settings;
257  $new_obj->settings_storage->updateSettings($new_settings);
258  $new_obj->settings_storage->updateInfoSettings($new_info_settings);
259 
260  $fstorage = $this->getFileStorage();
261  if (count($fstorage->readDir()) > 0) {
262  $n_fstorage = $new_obj->getFileStorage();
263  $n_fstorage->create();
264  $fstorage->_copyDirectory($fstorage->getAbsolutePath(), $n_fstorage->getAbsolutePath());
265  }
266  return $new_obj;
267  }
An object carrying settings of an Individual Assessment obj beyond the standart information.
getFileStorage()
Get the file storage system.
+ Here is the call graph for this function:

◆ create()

ilObjIndividualAssessment::create ( )

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

References ilObject\createMetaData(), ilObject\getId(), and settings().

70  {
71  parent::create();
72  $this->createMetaData();
73 
75  (int) $this->getId(),
76  '',
77  '',
78  '',
79  '',
80  false,
81  false
82  );
83  $this->settings_storage->createSettings($this->settings);
84  }
settings()
Definition: settings.php:2
An object carrying settings of an Individual Assessment obj beyond the standart information.
createMetaData()
create meta data entry
getId()
get object id public
+ Here is the call graph for this function:

◆ delete()

ilObjIndividualAssessment::delete ( )

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

References ilObject\deleteMetaData().

177  {
178  $this->deleteMetaData();
179  $this->settings_storage->deleteSettings($this);
180  $this->members_storage->deleteMembers($this);
181  parent::delete();
182  }
deleteMetaData()
delete meta data entry
+ Here is the call graph for this function:

◆ getDic()

ilObjIndividualAssessment::getDic ( )
protected

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

References $DIC, and $dic.

Referenced by getMembersGUI(), and getSettingsGUI().

324  {
325  if (is_null($this->dic)) {
326  global $DIC;
327  $this->dic = $this->getObjectDIC(
328  $this,
329  $DIC
330  );
331  }
332  return $this->dic;
333  }
global $DIC
Definition: goto.php:24
+ Here is the caller graph for this function:

◆ getFileStorage()

ilObjIndividualAssessment::getFileStorage ( )

Get the file storage system.

Returns
ilIndividualAssessmentFileStorage

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

References ilObject\getId(), and ilIndividualAssessmentFileStorage\getInstance().

Referenced by cloneObject().

275  {
276  if ($this->file_storage === null) {
277  $this->file_storage = ilIndividualAssessmentFileStorage::getInstance($this->getId());
278  }
279  return $this->file_storage;
280  }
getId()
get object id public
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getInfoSettings()

ilObjIndividualAssessment::getInfoSettings ( )

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

Referenced by cloneObject().

117  {
118  if (!$this->info_settings) {
119  $this->info_settings = $this->settings_storage->loadInfoSettings($this);
120  }
121  return $this->info_settings;
122  }
+ Here is the caller graph for this function:

◆ getMembersGUI()

ilObjIndividualAssessment::getMembersGUI ( )

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

References getDic().

336  {
337  return $this->getDic()['ilIndividualAssessmentMembersGUI'];
338  }
For the purpose of streamlining the grading and learning-process status definition outside of tests...
+ Here is the call 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.

array $DIC

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

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

References $DIC, ilObject\$id, and ilObject\$tree.

308  {
309  global $DIC;
310 
311  $tree = $DIC['tree'];
312  $node = $tree->getParentNodeData($id);
313 
314  while ($node['type'] !== "root") {
315  if (in_array($node['type'], $types)) {
316  return $node['ref_id'];
317  }
318  $node = $tree->getParentNodeData($node['ref_id']);
319  }
320  return 0;
321  }
global $DIC
Definition: goto.php:24

◆ getSettings()

ilObjIndividualAssessment::getSettings ( )

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

References $settings, and settings().

Referenced by cloneObject().

99  {
100  if (!$this->settings) {
101  $this->settings = $this->settings_storage->loadSettings($this);
102  }
103  return $this->settings;
104  }
settings()
Definition: settings.php:2
An object carrying settings of an Individual Assessment obj beyond the standart information.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getSettingsGUI()

ilObjIndividualAssessment::getSettingsGUI ( )

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

References getDic().

341  {
342  return $this->getDic()['ilIndividualAssessmentSettingsGUI'];
343  }
ilIndividualAssessmentSettingsGUI: ilIndividualAssessmentCommonSettingsGUI
+ Here is the call graph for this function:

◆ initDefaultRoles()

ilObjIndividualAssessment::initDefaultRoles ( )

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

214  {
215  $this->access_handler->initDefaultRolesForObject($this);
216  }

◆ isActiveLP()

ilObjIndividualAssessment::isActiveLP ( )

Check wether the LP is activated for current object.

Returns
bool

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

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

288  {
289  if ($this->lp_active === null) {
290  require_once 'Modules/IndividualAssessment/classes/LearningProgress/class.ilIndividualAssessmentLPInterface.php';
291  $this->lp_active = ilIndividualAssessmentLPInterface::isActiveLP($this->getId());
292  }
293  return $this->lp_active;
294  }
getId()
get object id public
+ Here is the call graph for this function:

◆ loadMembers()

ilObjIndividualAssessment::loadMembers ( )

Get the members object associated with this.

Returns
ilIndividualAssessmentMembers

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

138  {
139  return $this->members_storage->loadMembers($this);
140  }

◆ loadMembersAsSingleObjects()

ilObjIndividualAssessment::loadMembersAsSingleObjects ( string  $filter = null,
string  $sort = null 
)

Get the members as single object associated with this.

Returns
ilIndividualAssessmentMember[]

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

148  {
149  return $this->members_storage->loadMembersAsSingleObjects($this, $filter, $sort);
150  }

◆ loadVisibleMembers()

ilObjIndividualAssessment::loadVisibleMembers ( )

Get the members object associated with this and visible by the current user.

Returns
ilIndividualAssessmentMembers

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

158  {
159  return $this->members_storage->loadMembers($this)
160  ->withAccessHandling($this->il_access_handler);
161  }

◆ membersStorage()

ilObjIndividualAssessment::membersStorage ( )

Get the member storage object used by this.

Returns
ilIndividualAssessmentMembersStorage

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

References $members_storage.

◆ read()

ilObjIndividualAssessment::read ( )

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

References $DIC, $settings_storage, and settings().

90  {
91  parent::read();
92  global $DIC;
94  $this->settings = $settings_storage->loadSettings($this);
95  $this->info_settings = $settings_storage->loadInfoSettings($this);
96  }
settings()
Definition: settings.php:2
A settings storage handler to write iass settings to db.
global $DIC
Definition: goto.php:24
+ Here is the call graph for this function:

◆ setInfoSettings()

ilObjIndividualAssessment::setInfoSettings ( ilIndividualAssessmentInfoSettings  $info)

Set info settings.

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

128  {
129  $this->info_settings = $info;
130  }

◆ setSettings()

ilObjIndividualAssessment::setSettings ( ilIndividualAssessmentSettings  $settings)

Set the settings.

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

References $settings, ilIndividualAssessmentSettings\getDescription(), ilIndividualAssessmentSettings\getTitle(), ilObject\setDescription(), settings(), and ilObject\setTitle().

110  {
111  $this->settings = $settings;
112  $this->setTitle($settings->getTitle());
113  $this->setDescription($settings->getDescription());
114  }
settings()
Definition: settings.php:2
getTitle()
Get the content of this assessment, e.g.
setTitle($a_title)
set object title
getDescription()
Get the content of this assessment, e.g.
setDescription($a_desc)
set object description
+ Here is the call graph for this function:

◆ update()

ilObjIndividualAssessment::update ( )

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

References settings(), and ilObject\updateMetaData().

188  {
189  parent::update();
190  $this->updateMetaData();
191 
192  $this->settings_storage->updateSettings($this->settings);
193  }
settings()
Definition: settings.php:2
updateMetaData()
update meta data entry
+ Here is the call graph for this function:

◆ updateInfo()

ilObjIndividualAssessment::updateInfo ( )

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

196  {
197  $this->settings_storage->updateInfoSettings($this->info_settings);
198  }

◆ updateMembers()

ilObjIndividualAssessment::updateMembers ( ilIndividualAssessmentMembers  $members)

Update the members object associated with this.

Parameters
ilIndividualAssessmentMembers$members

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

References ilIndividualAssessmentMembers\updateStorageAndRBAC().

169  {
170  $members->updateStorageAndRBAC($this->members_storage, $this->access_handler);
171  }
updateStorageAndRBAC(ilIndividualAssessmentMembersStorage $storage, IndividualAssessmentAccessHandler $access_handler)
Store the data to a persistent medium.
+ Here is the call graph for this function:

Field Documentation

◆ $access_handler

ilObjIndividualAssessment::$access_handler
protected

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

Referenced by accessHandler().

◆ $dic

ilObjIndividualAssessment::$dic
protected

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

Referenced by getDic().

◆ $il_access_handler

ilObjIndividualAssessment::$il_access_handler
protected

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

◆ $lp_active

ilObjIndividualAssessment::$lp_active = null
protected

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

Referenced by isActiveLP().

◆ $members_storage

ilObjIndividualAssessment::$members_storage
protected

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

Referenced by membersStorage().

◆ $settings

ilObjIndividualAssessment::$settings
protected

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

Referenced by cloneObject(), getSettings(), and setSettings().

◆ $settings_storage

ilObjIndividualAssessment::$settings_storage
protected

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

Referenced by read().


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