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 ()

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 ()

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)

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

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 @access public More...

getLastUpdateDate ()

get last update date @access 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...

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 ()

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@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	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_reference = `true`
	)

Constructor @access public.

Parameters

integer	reference_id or object_id
boolean	treat the id as reference_id (true) or object_id (false)

Reimplemented from ilObject.

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

    {
        global $DIC;
        $this->type = 'iass';
        $this->il_access_handler = $DIC["ilAccess"];
        parent::__construct($a_id, $a_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 $DIC, 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.

Returns: IndividualAssessmentAccessHandler

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

    {
        return $this->access_handler;
    }

References $access_handler.

◆ cloneObject()

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

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

    {
        $new_obj = parent::cloneObject($a_target_id, $a_copy_id, $a_omit_tree);
        $settings = $this->getSettings();
        $info_settings = $this->getInfoSettings();
        $new_settings = new ilIndividualAssessmentSettings(
            (int) $new_obj->getId(),
            (int) $new_obj->getTitle(),
            (int) $new_obj->getDescription(),
            $settings->getContent(),
            $settings->getRecordTemplate(),
            $settings->isEventTimePlaceRequired(),
            $settings->isFileRequired()
        );
        $new_obj->settings = $new_settings;
 
        $new_info_settings = new ilIndividualAssessmentInfoSettings(
            (int) $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;
    }

References $settings, getFileStorage(), 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 69 of file class.ilObjIndividualAssessment.php.

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

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

Here is the call graph for this function:

◆ delete()

ilObjIndividualAssessment::delete ( )

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

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

◆ getDic()

ilObjIndividualAssessment::getDic ( )

protected

Definition at line 318 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.

Returns: ilIndividualAssessmentFileStorage

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

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

References 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 114 of file class.ilObjIndividualAssessment.php.

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

Referenced by cloneObject().

Here is the caller graph for this function:

◆ getMembersGUI()

ilObjIndividualAssessment::getMembersGUI ( )

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

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

References getDic().

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.

@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 302 of file class.ilObjIndividualAssessment.php.

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

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

◆ getSettings()

ilObjIndividualAssessment::getSettings ( )

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

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

References $settings, and 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 335 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 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 208 of file class.ilObjIndividualAssessment.php.

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

◆ isActiveLP()

ilObjIndividualAssessment::isActiveLP ( )

Check wether the LP is activated for current object.

Returns: bool

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

    {
        if ($this->lp_active === null) {
            require_once 'Modules/IndividualAssessment/classes/LearningProgress/class.ilIndividualAssessmentLPInterface.php';
            $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.

Returns: ilIndividualAssessmentMembers

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

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

◆ loadMembersAsSingleObjects()

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

Get the members as single object associated with this.

Returns: ilIndividualAssessmentMember[]

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

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

◆ loadVisibleMembers()

ilObjIndividualAssessment::loadVisibleMembers ( )

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

Returns: ilIndividualAssessmentMembers

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

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

◆ membersStorage()

ilObjIndividualAssessment::membersStorage ( )

Get the member storage object used by this.

Returns: ilIndividualAssessmentMembersStorage

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

    {
        return $this->members_storage;
    }

References $members_storage.

◆ read()

ilObjIndividualAssessment::read ( )

read object data from db into object

Parameters

boolean @access public

Reimplemented from ilObject.

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

    {
        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, and settings().

Here is the call graph for this function:

◆ setInfoSettings()

ilObjIndividualAssessment::setInfoSettings ( ilIndividualAssessmentInfoSettings $info )

Set info settings.

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

    {
        $this->info_settings = $info;
    }

◆ setSettings()

ilObjIndividualAssessment::setSettings ( ilIndividualAssessmentSettings $settings )

Set the settings.

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

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

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

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 184 of file class.ilObjIndividualAssessment.php.

    {
        parent::update();
        $this->settings_storage->updateSettings($this->settings);
    }

References settings().

Here is the call graph for this function:

◆ updateInfo()

ilObjIndividualAssessment::updateInfo ( )

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

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

◆ updateMembers()

ilObjIndividualAssessment::updateMembers ( ilIndividualAssessmentMembers $members )

Update the members object associated with this.

Parameters

ilIndividualAssessmentMembers $members

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

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

References ilIndividualAssessmentMembers\updateStorageAndRBAC().

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:

Modules/IndividualAssessment/classes/class.ilObjIndividualAssessment.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ accessHandler()

◆ cloneObject()

◆ create()

◆ delete()

◆ getDic()

◆ getFileStorage()

◆ getInfoSettings()

◆ getMembersGUI()

◆ getParentContainerIdByType()

◆ getSettings()

◆ getSettingsGUI()

◆ initDefaultRoles()

◆ isActiveLP()

◆ loadMembers()

◆ loadMembersAsSingleObjects()

◆ loadVisibleMembers()

◆ membersStorage()

◆ read()

◆ setInfoSettings()

◆ setSettings()

◆ update()

◆ updateInfo()

◆ updateMembers()

Field Documentation

◆ $access_handler

◆ $dic

◆ $il_access_handler

◆ $lp_active

◆ $members_storage

◆ $settings

◆ $settings_storage