This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilObjIndividualAssessment:

Collaboration diagram for ilObjIndividualAssessment:

Public Member Functions
	__construct (int $id=0, bool $call_by_reference=true)

	create ()
	note: title, description and type should be set when this function is called More...

	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 ()
	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!! Returns bool true if object was removed completely; false if only a references was removed More...

	update ()

	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 set up default local roles you MUST overwrite this method in derived object classes (see ilObjForum for an example). More...

	accessHandler ()
	Get the access handler of this. More...

	cloneObject (int $target_id, int $copy_id=0, bool $omit_tree=false)

	getFileStorage ()
	Get the file storage system. More...

	isActiveLP ()
	Check whether the LP is activated for current object. More...

	getParentContainerIdByType (int $id, array $types)
	Bubbles up the tree. More...

	getMembersGUI ()

	getSettingsGUI ()

Public Member Functions inherited from ilObject
	__construct (int $id=0, bool $reference=true)

	withReferences ()
	determines whether objects are referenced or not (got ref ids or not) More...

	processAutoRating ()

	read ()

	getId ()

	setId (int $id)

	setRefId (int $ref_id)

	getRefId ()

	getType ()

	setType (string $type)

	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions More...

	getTitle ()

	getUntranslatedTitle ()
	Get untranslated object title WebDAV needs to access the untranslated title of an object. More...

	setTitle (string $title)

	getDescription ()

	setDescription (string $desc)

	getLongDescription ()
	get object long description (stored in object_description) More...

	getImportId ()

	setImportId (string $import_id)

	setOfflineStatus (bool $status)

	getOfflineStatus ()

	supportsOfflineHandling ()

	getOwner ()

	getOwnerName ()
	get full name of object owner More...

	setOwner (int $usr_id)

	getCreateDate ()
	Get create date in YYYY-MM-DD HH-MM-SS format. More...

	getLastUpdateDate ()
	Get last update date in YYYY-MM-DD HH-MM-SS format. More...

	create ()
	note: title, description and type should be set when this function is called More...

	update ()

	MDUpdateListener (string $element)
	Metadata update listener. More...

	createMetaData ()

	updateMetaData ()

	deleteMetaData ()

	updateOwner ()
	update owner of object in db More...

	putInTree (int $parent_ref_id)
	maybe this method should be in tree object!? More...

	setPermissions (int $parent_ref_id)

	setParentRolePermissions (int $parent_ref_id)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g. More...

	createReference ()
	creates reference for object More...

	countReferences ()

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

	applyDidacticTemplate (int $tpl_id)

	getXMLZip ()

	getHTMLDirectory ()

	appendCopyInfo (int $target_id, int $copy_id)
	Prepend Copy info if object with same name exists in that container. More...

	cloneDependencies (int $target_id, int $copy_id)
	Clone object dependencies. More...

	cloneMetaData (ilObject $target_obj)
	Copy meta data. More...

	selfOrParentWithRatingEnabled ()

	getPossibleSubObjects (bool $filter=true)
	get all possible sub objects of this type the object can decide which types of sub objects are possible jut in time overwrite if the decision distinguish from standard model More...

Protected Member Functions
	getDic ()

Protected Member Functions inherited from ilObject
	doMDUpdateListener (string $a_element)

	beforeMDUpdateListener (string $a_element)

	doCreateMetaData ()

	beforeCreateMetaData ()

	doUpdateMetaData ()

	beforeUpdateMetaData ()

	doDeleteMetaData ()

	beforeDeleteMetaData ()

	handleAutoRating ()

	hasAutoRating ()

Protected Attributes
bool	$lp_active = null

ilIndividualAssessmentSettings	$settings

ilIndividualAssessmentSettingsStorageDB	$settings_storage

ilIndividualAssessmentMembersStorageDB	$members_storage

ilIndividualAssessmentAccessHandler	$access_handler

ilAccessHandler	$il_access_handler

Pimple Container	$dic = null

ilIndividualAssessmentInfoSettings	$info_settings = null

ilIndividualAssessmentFileStorage	$file_storage = null

Protected Attributes inherited from ilObject
ilLogger	$obj_log

ILIAS	$ilias

ilObjectDefinition	$obj_definition

ilDBInterface	$db

ilLogger	$log

ilErrorHandling	$error

ilTree	$tree

ilAppEventHandler	$app_event_handler

ilRbacAdmin	$rbac_admin

ilRbacReview	$rbac_review

ilObjUser	$user

ilLanguage	$lng

int	$id

bool	$referenced

bool	$call_by_reference

int	$max_title = self::TITLE_LENGTH

int	$max_desc = self::DESC_LENGTH

bool	$add_dots = true

int	$ref_id = null

string	$type = ""

string	$title = ""

bool	$offline = false

string	$desc = ""

string	$long_desc = ""

int	$owner = 0

string	$create_date = ""

string	$last_update = ""

string	$import_id = ""

bool	$register = false

Additional Inherited Members
Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId (string $import_id)
	Get (latest) object id for an import id. More...

static	_lookupImportId (int $obj_id)

static	_lookupOwnerName (int $owner_id)
	Lookup owner name for owner id. More...

static	_getIdForImportId (string $import_id)

static	_getAllReferences (int $id)
	get all reference ids for object ID More...

static	_lookupTitle (int $obj_id)

static	lookupOfflineStatus (int $obj_id)
	Lookup offline status using objectDataCache. More...

static	_lookupOwner (int $obj_id)
	Lookup owner user ID for object ID. More...

static	_getIdsForTitle (string $title, string $type='', bool $partial_match=false)

static	_lookupDescription (int $obj_id)

static	_lookupLastUpdate (int $obj_id, bool $formatted=false)

static	_getLastUpdateOfObjects (array $obj_ids)

static	_lookupObjId (int $ref_id)

static	_setDeletedDate (int $ref_id, int $deleted_by)

static	setDeletedDates (array $ref_ids, int $user_id)

static	_resetDeletedDate (int $ref_id)

static	_lookupDeletedDate (int $ref_id)

static	_writeTitle (int $obj_id, string $title)
	write title to db (static) More...

static	_writeDescription (int $obj_id, string $desc)
	write description to db (static) More...

static	_writeImportId (int $obj_id, string $import_id)
	write import id to db (static) More...

static	_lookupType (int $id, bool $reference=false)

static	_isInTrash (int $ref_id)

static	_hasUntrashedReference (int $obj_id)
	checks whether an object has at least one reference that is not in trash More...

static	_lookupObjectId (int $ref_id)

static	_getObjectsDataForType (string $type, bool $omit_trash=false)
	get all objects of a certain type More...

static	_exists (int $id, bool $reference=false, ?string $type=null)
	checks if an object exists in object_data More...

static	_getObjectsByType (string $obj_type="", int $owner=null)

static	_prepareCloneSelection (array $ref_ids, string $new_type, bool $show_path=true)
	Prepare copy wizard object selection. More...

static	_getIcon (int $obj_id=0, string $size="big", string $type="", bool $offline=false)
	Get icon for repository item. More...

static	collectDeletionDependencies (array &$deps, int $ref_id, int $obj_id, string $type, int $depth=0)
	Collect deletion dependencies. More...

static	getDeletionDependencies (int $obj_id)
	Get deletion dependencies. More...

static	getLongDescriptions (array $obj_ids)

static	getAllOwnedRepositoryObjects (int $user_id)

static	fixMissingTitles ($type, array &$obj_title_map)
	Try to fix missing object titles. More...

static	_lookupCreationDate (int $obj_id)

static	_getObjectTypeIdByTitle (string $type, \ilDBInterface $ilDB=null)

Data Fields inherited from ilObject
const	TITLE_LENGTH = 255

const	DESC_LENGTH = 128

const	LONG_DESC_LENGTH = 4000

const	TABLE_OBJECT_DATA = "object_data"

array	$objectList

string	$untranslatedTitle

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning 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 carries a LPStatus, which is set Individually.

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

Constructor & Destructor Documentation

◆ __construct()

ilObjIndividualAssessment::__construct	(	int	$id = `0`,
		bool	$reference = `true`
	)

Parameters

int	$id	reference_id or object_id
bool	$reference	bool treat the id as reference_id (true) or object_id (false)

Reimplemented from ilObject.

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

    {
        global $DIC;
        $this->type = 'iass';
        $this->il_access_handler = $DIC["ilAccess"];
 
        parent::__construct($id, $call_by_reference);
 
        $this->settings_storage = new ilIndividualAssessmentSettingsStorageDB($DIC['ilDB']);
        $this->members_storage = new ilIndividualAssessmentMembersStorageDB($DIC['ilDB']);
        $this->access_handler = new ilIndividualAssessmentAccessHandler(
            $this,
            $DIC['ilAccess'],
            $DIC['rbacadmin'],
            $DIC['rbacreview'],
            $DIC['ilUser']
        );
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ accessHandler()

ilObjIndividualAssessment::accessHandler ( )

Get the access handler of this.

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

                                   : IndividualAssessmentAccessHandler
    {
        return $this->access_handler;
    }

References $access_handler.

◆ cloneObject()

ilObjIndividualAssessment::cloneObject	(	int	$target_id,
		int	$copy_id = `0`,
		bool	$omit_tree = `false`
	)

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

                                                                                          : ?ilObject
    {
        $new_obj = parent::cloneObject($target_id, $copy_id, $omit_tree);
        $settings = $this->getSettings();
        $info_settings = $this->getInfoSettings();
        $new_settings = new ilIndividualAssessmentSettings(
            $new_obj->getId(),
            $new_obj->getTitle(),
            $new_obj->getDescription(),
            $settings->getContent(),
            $settings->getRecordTemplate(),
            $settings->isEventTimePlaceRequired(),
            $settings->isFileRequired()
        );
        $new_obj->settings = $new_settings;
 
        $new_info_settings = new ilIndividualAssessmentInfoSettings(
            $new_obj->getId(),
            $info_settings->getContact(),
            $info_settings->getResponsibility(),
            $info_settings->getPhone(),
            $info_settings->getMails(),
            $info_settings->getConsultationHours()
        );
        $new_obj->settings = $new_settings;
        $new_obj->info_settings = $new_info_settings;
        $new_obj->settings_storage->updateSettings($new_settings);
        $new_obj->settings_storage->updateInfoSettings($new_info_settings);
 
        $fstorage = $this->getFileStorage();
        if (count($fstorage->readDir()) > 0) {
            $n_fstorage = $new_obj->getFileStorage();
            $n_fstorage->create();
            $fstorage->_copyDirectory($fstorage->getAbsolutePath(), $n_fstorage->getAbsolutePath());
        }
        return $new_obj;
    }

Here is the call graph for this function:

◆ create()

ilObjIndividualAssessment::create ( )

note: title, description and type should be set when this function is called

Reimplemented from ilObject.

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

                            : int
    {
        $id = parent::create();
        $this->createMetaData();
 
        $this->settings = new ilIndividualAssessmentSettings(
            $this->getId(),
            '',
            '',
            '',
            '',
            false,
            false
        );
        $this->settings_storage->createSettings($this->settings);
        return $id;
    }

References ilObject\$id, ilObject\createMetaData(), ilObject\getId(), and ILIAS\Repository\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!!

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

Reimplemented from ilObject.

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

                            : bool
    {
        $this->deleteMetaData();
        $this->settings_storage->deleteSettings($this);
        $this->members_storage->deleteMembers($this);
        return parent::delete();
    }

References ilObject\deleteMetaData().

Here is the call graph for this function:

◆ getDic()

ilObjIndividualAssessment::getDic ( )

protected

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

                               : Pimple\Container
    {
        if (is_null($this->dic)) {
            global $DIC;
            $this->dic = $this->getObjectDIC(
                $this,
                $DIC
            );
        }
        return $this->dic;
    }

References $DIC, and $dic.

Referenced by getMembersGUI(), and getSettingsGUI().

Here is the caller graph for this function:

◆ getFileStorage()

ilObjIndividualAssessment::getFileStorage ( )

Get the file storage system.

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

                                    : ilIndividualAssessmentFileStorage
    {
        if ($this->file_storage === null) {
            $this->file_storage = ilIndividualAssessmentFileStorage::getInstance($this->getId());
        }
        return $this->file_storage;
    }

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

Referenced by cloneObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getInfoSettings()

ilObjIndividualAssessment::getInfoSettings ( )

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

                                     : ilIndividualAssessmentInfoSettings
    {
        if (!$this->info_settings) {
            $this->info_settings = $this->settings_storage->loadInfoSettings($this);
        }
        return $this->info_settings;
    }

References $info_settings.

Referenced by cloneObject(), and updateInfo().

Here is the caller graph for this function:

◆ getMembersGUI()

ilObjIndividualAssessment::getMembersGUI ( )

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

                                   : ilIndividualAssessmentMembersGUI
    {
        return $this->getDic()['ilIndividualAssessmentMembersGUI'];
    }

References getDic().

Here is the call graph for this function:

◆ getParentContainerIdByType()

ilObjIndividualAssessment::getParentContainerIdByType	(	int	$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	$id	start at this id
string[]	$types	search for these strings

Returns: int the obj_id or 0 if root is reached

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

                                                                     : int
    {
        global $DIC;
 
        $tree = $DIC['tree'];
        $node = $tree->getParentNodeData($id);
 
        while ($node['type'] !== "root") {
            if (in_array($node['type'], $types)) {
                return (int) $node['ref_id'];
            }
            $node = $tree->getParentNodeData((int) $node['ref_id']);
        }
        return 0;
    }

References $DIC, ilObject\$id, ilObject\$tree, and ilTree\getParentNodeData().

Here is the call graph for this function:

◆ getSettings()

ilObjIndividualAssessment::getSettings ( )

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

                                 : ilIndividualAssessmentSettings
    {
        if (!$this->settings) {
            $this->settings = $this->settings_storage->loadSettings($this);
        }
        return $this->settings;
    }

References $settings, and ILIAS\Repository\settings().

Referenced by cloneObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSettingsGUI()

ilObjIndividualAssessment::getSettingsGUI ( )

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

                                    : ilIndividualAssessmentSettingsGUI
    {
        return $this->getDic()['ilIndividualAssessmentSettingsGUI'];
    }

References getDic().

Here is the call 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 set up default local roles you MUST overwrite this method in derived object classes (see ilObjForum for an example).

Reimplemented from ilObject.

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

                                      : void
    {
        $this->access_handler->initDefaultRolesForObject($this);
    }

◆ isActiveLP()

ilObjIndividualAssessment::isActiveLP ( )

Check whether the LP is activated for current object.

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

                                : bool
    {
        if ($this->lp_active === null) {
            $this->lp_active = ilIndividualAssessmentLPInterface::isActiveLP($this->getId());
        }
        return $this->lp_active;
    }

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.

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

                                 : ilIndividualAssessmentMembers
    {
        return $this->members_storage->loadMembers($this);
    }

Referenced by ilIndividualAssessmentMembersGUI\addUsers(), and ilIndividualAssessmentMembersGUI\removeUser().

Here is the caller graph for this function:

◆ loadMembersAsSingleObjects()

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

Get the members as single object associated with this.

Returns: ilIndividualAssessmentMember[]

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

                                                                                          : array
    {
        return $this->members_storage->loadMembersAsSingleObjects($this, $filter, $sort);
    }

◆ loadVisibleMembers()

ilObjIndividualAssessment::loadVisibleMembers ( )

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

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

                                        : ilIndividualAssessmentMembers
    {
        return $this->members_storage->loadMembers($this)
                ->withAccessHandling($this->il_access_handler);
    }

References ilIndividualAssessmentMembers\withAccessHandling().

Here is the call graph for this function:

◆ membersStorage()

ilObjIndividualAssessment::membersStorage ( )

Get the member storage object used by this.

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

                                    : ilIndividualAssessmentMembersStorage
    {
        return $this->members_storage;
    }

References $members_storage.

◆ read()

ilObjIndividualAssessment::read ( )

Reimplemented from ilObject.

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

                          : void
    {
        parent::read();
        global $DIC;
        $settings_storage = new ilIndividualAssessmentSettingsStorageDB($DIC['ilDB']);
        $this->settings = $settings_storage->loadSettings($this);
        $this->info_settings = $settings_storage->loadInfoSettings($this);
    }

References $DIC, $settings_storage, ilIndividualAssessmentSettingsStorageDB\loadInfoSettings(), ilIndividualAssessmentSettingsStorageDB\loadSettings(), and ILIAS\Repository\settings().

Here is the call graph for this function:

◆ setInfoSettings()

ilObjIndividualAssessment::setInfoSettings ( ilIndividualAssessmentInfoSettings $info )

Set info settings.

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

                                                                             : void
    {
        $this->info_settings = $info;
    }

◆ setSettings()

ilObjIndividualAssessment::setSettings ( ilIndividualAssessmentSettings $settings )

Set the settings.

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

                                                                         : void
    {
        $this->settings = $settings;
        $this->setTitle($settings->getTitle());
        $this->setDescription($settings->getDescription());
    }

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

Here is the call graph for this function:

◆ update()

ilObjIndividualAssessment::update ( )

Reimplemented from ilObject.

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

                            : bool
    {
        parent::update();
        $this->updateMetaData();
 
        $this->settings_storage->updateSettings($this->settings);
        return true;
    }

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

Here is the call graph for this function:

◆ updateInfo()

ilObjIndividualAssessment::updateInfo ( )

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

                                : void
    {
        $this->settings_storage->updateInfoSettings($this->getInfoSettings());
    }

References getInfoSettings().

Here is the call graph for this function:

◆ updateMembers()

ilObjIndividualAssessment::updateMembers ( ilIndividualAssessmentMembers $members )

Update the members object associated with this.

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

                                                                         : void
    {
        $members->updateStorageAndRBAC($this->members_storage, $this->access_handler);
    }