ilIndividualAssessmentMembersStorageDB Class Reference

Store member infos to DB. More...

Inheritance diagram for ilIndividualAssessmentMembersStorageDB:

Collaboration diagram for ilIndividualAssessmentMembersStorageDB:

Public Member Functions
	__construct ($ilDB)
	loadMembers (ilObjIndividualAssessment $obj)
	Get ilIndividualAssessmentMembers-object containing meberinfo associated with $obj. Parameters ilObjIndividualAssessment $obj Returns ilIndividualAssessmentMembers More...
	loadMembersAsSingleObjects (ilObjIndividualAssessment $obj, string $filter=null, string $sort=null)
	Get ilIndividualAssessmentMember-object for each obj member associated with $obj. Parameters ilObjIndividualAssessment $obj Returns ilIndividualAssessmentMember[] More...
	loadMember (ilObjIndividualAssessment $obj, ilObjUser $usr)
	Get ilIndividualAssessmentMember-object containing meberinfo associated with $obj and $usr. Parameters ilObjIndividualAssessment $obj ilObjUser $usr Returns ilIndividualAssessmentMember More...
	updateMember (ilIndividualAssessmentMember $member)
	Create a new storage entry for member-object. Parameters ilIndividualAssessmentMember $member More...
	deleteMembers (ilObjIndividualAssessment $obj)
	Delete entries associated with members-object. Parameters ilObjIndividualAssessment $obj More...
	insertMembersRecord (ilObjIndividualAssessment $iass, array $record)
	Create a membership inside storage. Parameters ilObjIndividualAssessment $iass string|int[] $record More...
	removeMembersRecord (ilObjIndividualAssessment $iass, array $record)
	Remove a membership associated with a IndividualAssessment object inside storage. Parameters ilObjIndividualAssessment $iass string|int[] $record More...

Data Fields
const	MEMBERS_TABLE = "iass_members"

Protected Member Functions
	loadMemberQuery ()
	loadMembersQuery ($obj_id)
	getWhereFromFilter ($filter)
	getOrderByFromSort (string $sort)

Protected Attributes
	$db

Detailed Description

Store member infos to DB.

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

Stefan Hecken stefa.nosp@m.n.he.nosp@m.cken@.nosp@m.conc.nosp@m.epts-.nosp@m.and-.nosp@m.train.nosp@m.ing..nosp@m.de

Definition at line 14 of file class.ilIndividualAssessmentMembersStorageDB.php.

Constructor & Destructor Documentation

__construct()

ilIndividualAssessmentMembersStorageDB::__construct

(

$ilDB

)

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

References $ilDB.

    {
        $this->db = $ilDB;
    }

Member Function Documentation

deleteMembers()

ilIndividualAssessmentMembersStorageDB::deleteMembers

(

ilObjIndividualAssessment

$obj

)

Delete entries associated with members-object.

Parameters

ilObjIndividualAssessment

$obj

Implements ilIndividualAssessmentMembersStorage.

Definition at line 114 of file class.ilIndividualAssessmentMembersStorageDB.php.

References ilObject\getId().

    {
        $sql = "DELETE FROM " . self::MEMBERS_TABLE . " WHERE obj_id = " . $this->db->quote($obj->getId(), 'integer');
        $this->db->manipulate($sql);
    }

Here is the call graph for this function:

getOrderByFromSort()

ilIndividualAssessmentMembersStorageDB::getOrderByFromSort ( string  $sort )

protected

Definition at line 227 of file class.ilIndividualAssessmentMembersStorageDB.php.

Referenced by loadMembersAsSingleObjects().

                                                        : string
    {
        $vals = explode(":", $sort);

        return " ORDER BY " . $vals[0] . " " . $vals[1];
    }

Here is the caller graph for this function:

getWhereFromFilter()

ilIndividualAssessmentMembersStorageDB::getWhereFromFilter (   $filter )

protected

Parameters

int|string

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

References ilIndividualAssessmentMembers\LP_ASSESSMENT_NOT_COMPLETED, ilIndividualAssessmentMembers\LP_COMPLETED, ilIndividualAssessmentMembers\LP_FAILED, and ilIndividualAssessmentMembers\LP_IN_PROGRESS.

Referenced by loadMembersAsSingleObjects().

                                                   : string
    {
        switch ($filter) {
            case ilIndividualAssessmentMembers::LP_ASSESSMENT_NOT_COMPLETED:
                return "      AND finalized = 0 AND examiner_id IS NULL\n";
                break;
            case ilIndividualAssessmentMembers::LP_IN_PROGRESS:
                return "      AND finalized = 0 AND examiner_id IS NOT NULL\n";
                break;
            case ilIndividualAssessmentMembers::LP_COMPLETED:
                return "      AND finalized = 1 AND learning_progress = 2\n";
                break;
            case ilIndividualAssessmentMembers::LP_FAILED:
                return "      AND finalized = 1 AND learning_progress = 3\n";
                break;
        }
    }

Here is the caller graph for this function:

insertMembersRecord()

ilIndividualAssessmentMembersStorageDB::insertMembersRecord	(	ilObjIndividualAssessment	$iass,
		array	$record
	)

Create a membership inside storage.

Parameters

ilObjIndividualAssessment	$iass
	string|int[]	$record

Implements ilIndividualAssessmentMembersStorage.

Definition at line 172 of file class.ilIndividualAssessmentMembersStorageDB.php.

References $values, ilIndividualAssessmentMembers\FIELD_CHANGE_TIME, ilIndividualAssessmentMembers\FIELD_CHANGER_ID, ilIndividualAssessmentMembers\FIELD_EVENTTIME, ilIndividualAssessmentMembers\FIELD_EXAMINER_ID, ilIndividualAssessmentMembers\FIELD_FILE_NAME, ilIndividualAssessmentMembers\FIELD_FINALIZED, ilIndividualAssessmentMembers\FIELD_INTERNAL_NOTE, ilIndividualAssessmentMembers\FIELD_LEARNING_PROGRESS, ilIndividualAssessmentMembers\FIELD_NOTIFICATION_TS, ilIndividualAssessmentMembers\FIELD_NOTIFY, ilIndividualAssessmentMembers\FIELD_PLACE, ilIndividualAssessmentMembers\FIELD_RECORD, ilIndividualAssessmentMembers\FIELD_USER_VIEW_FILE, ilIndividualAssessmentMembers\FIELD_USR_ID, and ilObject\getId().

    {
        $values = array("obj_id" => array("integer", $iass->getId())
            , "usr_id" => array("integer", $record[ilIndividualAssessmentMembers::FIELD_USR_ID])
            , ilIndividualAssessmentMembers::FIELD_LEARNING_PROGRESS => array("text", $record[ilIndividualAssessmentMembers::FIELD_LEARNING_PROGRESS])
            , ilIndividualAssessmentMembers::FIELD_EXAMINER_ID => array("integer", $record[ilIndividualAssessmentMembers::FIELD_EXAMINER_ID])
            , ilIndividualAssessmentMembers::FIELD_RECORD => array("text", $record[ilIndividualAssessmentMembers::FIELD_RECORD])
            , ilIndividualAssessmentMembers::FIELD_INTERNAL_NOTE => array("text", $record[ilIndividualAssessmentMembers::FIELD_INTERNAL_NOTE])
            , ilIndividualAssessmentMembers::FIELD_PLACE => array("text", $record[ilIndividualAssessmentMembers::FIELD_PLACE])
            , ilIndividualAssessmentMembers::FIELD_EVENTTIME => array("integer", $record[ilIndividualAssessmentMembers::FIELD_EVENTTIME])
            , ilIndividualAssessmentMembers::FIELD_NOTIFY => array("integer", $record[ilIndividualAssessmentMembers::FIELD_NOTIFY])
            , ilIndividualAssessmentMembers::FIELD_FINALIZED => array("integer", 0)
            , ilIndividualAssessmentMembers::FIELD_NOTIFICATION_TS => array("integer", -1)
            , ilIndividualAssessmentMembers::FIELD_FILE_NAME => array("text", $record[ilIndividualAssessmentMembers::FIELD_FILE_NAME])
            , ilIndividualAssessmentMembers::FIELD_USER_VIEW_FILE => array("integer", $record[ilIndividualAssessmentMembers::FIELD_USER_VIEW_FILE])
            , ilIndividualAssessmentMembers::FIELD_CHANGER_ID => array("integer", $record[ilIndividualAssessmentMembers::FIELD_CHANGER_ID])
            , ilIndividualAssessmentMembers::FIELD_CHANGE_TIME => array("text", $record[ilIndividualAssessmentMembers::FIELD_CHANGE_TIME])
        );

        $this->db->insert(self::MEMBERS_TABLE, $values);
    }

Here is the call graph for this function:

loadMember()

ilIndividualAssessmentMembersStorageDB::loadMember	(	ilObjIndividualAssessment	$obj,
		ilObjUser	$usr
	)

Get ilIndividualAssessmentMember-object containing meberinfo associated with $obj and $usr.

Parameters

ilObjIndividualAssessment	$obj
ilObjUser	$usr

Returns

ilIndividualAssessmentMember

Implements ilIndividualAssessmentMembersStorage.

Definition at line 67 of file class.ilIndividualAssessmentMembersStorageDB.php.

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

    {
        $obj_id = $obj->getId();
        $usr_id = $usr->getId();
        $sql = $this->loadMemberQuery();
        $sql .= "       WHERE obj_id = " . $this->db->quote($obj_id, 'integer') . "\n"
            . "         AND iassme.usr_id = " . $this->db->quote($usr_id, 'integer');

        $rec = $this->db->fetchAssoc($this->db->query($sql));
        if ($rec) {
            $member = new ilIndividualAssessmentMember($obj, $usr, $rec);
            return $member;
        } else {
            throw new ilIndividualAssessmentException("invalid usr-obj combination");
        }
    }

Here is the call graph for this function:

loadMemberQuery()

ilIndividualAssessmentMembersStorageDB::loadMemberQuery ( )

protected

Definition at line 120 of file class.ilIndividualAssessmentMembersStorageDB.php.

Referenced by loadMember(), and loadMembersAsSingleObjects().

    {
        return "SELECT "
            . "iassme.obj_id,"
            . "iassme.usr_id,"
            . "iassme.examiner_id,"
            . "iassme.record,"
            . "iassme.internal_note,"
            . "iassme.notify,"
            . "iassme.notification_ts,"
            . "iassme.learning_progress,"
            . "iassme.finalized,"
            . "iassme.place,"
            . "iassme.event_time,"
            . "iassme.user_view_file,"
            . "iassme.file_name,"
            . "iassme.changer_id,"
            . "iassme.change_time,"
            . "usr.lastname AS user_lastname,"
            . "ex.login AS examiner_login"
            . " FROM " . self::MEMBERS_TABLE . " iassme\n"
            . " JOIN usr_data usr ON iassme.usr_id = usr.usr_id\n"
            . " LEFT JOIN usr_data ex ON iassme.examiner_id = ex.usr_id\n"
        ;
    }

Here is the caller graph for this function:

loadMembers()

ilIndividualAssessmentMembersStorageDB::loadMembers

(

ilObjIndividualAssessment

$obj

)

Get ilIndividualAssessmentMembers-object containing meberinfo associated with $obj.

Parameters

ilObjIndividualAssessment

$obj

Returns

ilIndividualAssessmentMembers

Implements ilIndividualAssessmentMembersStorage.

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

References $res, ilObject\getId(), and loadMembersQuery().

    {
        $members = new ilIndividualAssessmentMembers($obj);
        $obj_id = $obj->getId();
        $sql = $this->loadMembersQuery($obj_id);
        $res = $this->db->query($sql);
        while ($rec = $this->db->fetchAssoc($res)) {
            $members = $members->withAdditionalRecord($rec);
        }
        return $members;
    }

Here is the call graph for this function:

loadMembersAsSingleObjects()

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

Get ilIndividualAssessmentMember-object for each obj member associated with $obj.

Parameters

ilObjIndividualAssessment

$obj

Returns

ilIndividualAssessmentMember[]

Implements ilIndividualAssessmentMembersStorage.

Definition at line 43 of file class.ilIndividualAssessmentMembersStorageDB.php.

References $res, ilObject\getId(), getOrderByFromSort(), getWhereFromFilter(), and loadMemberQuery().

    {
        $members = [];
        $sql = $this->loadMemberQuery();
        $sql .= "       WHERE obj_id = " . $this->db->quote($obj->getId(), 'integer');

        if (!is_null($filter)) {
            $sql .= $this->getWhereFromFilter($filter);
        }

        if (!is_null($sort)) {
            $sql .= $this->getOrderByFromSort($sort);
        }
        $res = $this->db->query($sql);
        while ($rec = $this->db->fetchAssoc($res)) {
            $usr = new ilObjUser($rec["usr_id"]);
            $members[] = new ilIndividualAssessmentMember($obj, $usr, $rec);
        }
        return $members;
    }

Here is the call graph for this function:

loadMembersQuery()

ilIndividualAssessmentMembersStorageDB::loadMembersQuery (   $obj_id )

protected

Definition at line 149 of file class.ilIndividualAssessmentMembersStorageDB.php.

References ilIndividualAssessmentMembers\FIELD_CHANGER_FIRSTNAME, ilIndividualAssessmentMembers\FIELD_CHANGER_LASTNAME, ilIndividualAssessmentMembers\FIELD_EXAMINER_FIRSTNAME, ilIndividualAssessmentMembers\FIELD_EXAMINER_LASTNAME, ilIndividualAssessmentMembers\FIELD_FILE_NAME, ilIndividualAssessmentMembers\FIELD_FIRSTNAME, ilIndividualAssessmentMembers\FIELD_LASTNAME, and ilIndividualAssessmentMembers\FIELD_LOGIN.

Referenced by loadMembers().

    {
        return "SELECT ex.firstname as " . ilIndividualAssessmentMembers::FIELD_EXAMINER_FIRSTNAME
                . "     , ex.lastname as " . ilIndividualAssessmentMembers::FIELD_EXAMINER_LASTNAME
                . "     , ud.firstname as " . ilIndividualAssessmentMembers::FIELD_CHANGER_FIRSTNAME
                . "     , ud.lastname as " . ilIndividualAssessmentMembers::FIELD_CHANGER_LASTNAME
                . "     ,usr.firstname as " . ilIndividualAssessmentMembers::FIELD_FIRSTNAME
                . "     ,usr.lastname as " . ilIndividualAssessmentMembers::FIELD_LASTNAME
                . "     ,usr.login as " . ilIndividualAssessmentMembers::FIELD_LOGIN
                . "        ,iassme." . ilIndividualAssessmentMembers::FIELD_FILE_NAME
                . "     ,iassme.obj_id, iassme.usr_id, iassme.examiner_id, iassme.record, iassme.internal_note, iassme.notify"
                . "     ,iassme.notification_ts, iassme.learning_progress, iassme.finalized,iassme.place"
                . "     ,iassme.event_time, iassme.changer_id, iassme.change_time\n"
                . " FROM iass_members iassme"
                . " JOIN usr_data usr ON iassme.usr_id = usr.usr_id"
                . " LEFT JOIN usr_data ex ON iassme.examiner_id = ex.usr_id"
                . " LEFT JOIN usr_data ud ON iassme.changer_id = ud.usr_id"
                . " WHERE obj_id = " . $this->db->quote($obj_id, 'integer');
    }

Here is the caller graph for this function:

removeMembersRecord()

ilIndividualAssessmentMembersStorageDB::removeMembersRecord	(	ilObjIndividualAssessment	$iass,
		array	$record
	)

Remove a membership associated with a IndividualAssessment object inside storage.

Parameters

ilObjIndividualAssessment	$iass
	string|int[]	$record

Implements ilIndividualAssessmentMembersStorage.

Definition at line 197 of file class.ilIndividualAssessmentMembersStorageDB.php.

References ilIndividualAssessmentMembers\FIELD_USR_ID, and ilObject\getId().

    {
        $sql = "DELETE FROM " . self::MEMBERS_TABLE . "\n"
                . " WHERE obj_id = " . $this->db->quote($iass->getId(), 'integer') . "\n"
                . "     AND usr_id = " . $this->db->quote($record[ilIndividualAssessmentMembers::FIELD_USR_ID], 'integer');

        $this->db->manipulate($sql);
    }

Here is the call graph for this function:

updateMember()

ilIndividualAssessmentMembersStorageDB::updateMember

(

ilIndividualAssessmentMember

$member

)

Create a new storage entry for member-object.

Parameters

ilIndividualAssessmentMember

$member

Implements ilIndividualAssessmentMembersStorage.

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

References $values, ilIndividualAssessmentMember\assessmentId(), ilIndividualAssessmentMember\changerId(), ilIndividualAssessmentMember\eventTime(), ilIndividualAssessmentMember\examinerId(), ilIndividualAssessmentMembers\FIELD_CHANGE_TIME, ilIndividualAssessmentMembers\FIELD_CHANGER_ID, ilIndividualAssessmentMembers\FIELD_EVENTTIME, ilIndividualAssessmentMembers\FIELD_EXAMINER_ID, ilIndividualAssessmentMembers\FIELD_FILE_NAME, ilIndividualAssessmentMembers\FIELD_FINALIZED, ilIndividualAssessmentMembers\FIELD_INTERNAL_NOTE, ilIndividualAssessmentMembers\FIELD_LEARNING_PROGRESS, ilIndividualAssessmentMembers\FIELD_NOTIFICATION_TS, ilIndividualAssessmentMembers\FIELD_NOTIFY, ilIndividualAssessmentMembers\FIELD_PLACE, ilIndividualAssessmentMembers\FIELD_RECORD, ilIndividualAssessmentMembers\FIELD_USER_VIEW_FILE, ilIndividualAssessmentMember\fileName(), ilIndividualAssessmentMember\finalized(), ilIndividualAssessmentMember\id(), IL_CAL_DATETIME, IL_CAL_UNIX, ilIndividualAssessmentMember\internalNote(), ilIndividualAssessmentMember\LPStatus(), ilIndividualAssessmentMember\notificationTS(), ilIndividualAssessmentMember\notify(), ilIndividualAssessmentMember\place(), ilIndividualAssessmentMember\record(), and ilIndividualAssessmentMember\viewFile().

    {
        $where = array("obj_id" => array("integer", $member->assessmentId())
             , "usr_id" => array("integer", $member->id())
        );

        $values = array(ilIndividualAssessmentMembers::FIELD_LEARNING_PROGRESS => array("text", $member->LPStatus())
                      , ilIndividualAssessmentMembers::FIELD_EXAMINER_ID => array("integer", $member->examinerId())
                      , ilIndividualAssessmentMembers::FIELD_RECORD => array("text", $member->record())
                      , ilIndividualAssessmentMembers::FIELD_INTERNAL_NOTE => array("text", $member->internalNote())
                      , ilIndividualAssessmentMembers::FIELD_PLACE => array("text", $member->place())
                      , ilIndividualAssessmentMembers::FIELD_EVENTTIME => array("integer", $member->eventTime()->get(IL_CAL_UNIX))
                      , ilIndividualAssessmentMembers::FIELD_NOTIFY => array("integer", $member->notify() ? 1 : 0)
                      , ilIndividualAssessmentMembers::FIELD_FINALIZED => array("integer", $member->finalized() ? 1 : 0)
                      , ilIndividualAssessmentMembers::FIELD_NOTIFICATION_TS => array("integer", $member->notificationTS())
                      , ilIndividualAssessmentMembers::FIELD_FILE_NAME => array("text", $member->fileName())
                      , ilIndividualAssessmentMembers::FIELD_USER_VIEW_FILE => array("integer", $member->viewFile() ? 1 : 0)
                      , ilIndividualAssessmentMembers::FIELD_CHANGER_ID => array("integer", $member->changerId())
                      , ilIndividualAssessmentMembers::FIELD_CHANGE_TIME => array("string", (new ilDateTime(time(), IL_CAL_UNIX))->get(IL_CAL_DATETIME))
                );

        $this->db->update(self::MEMBERS_TABLE, $values, $where);
    }

Here is the call graph for this function:

Field Documentation

$db

ilIndividualAssessmentMembersStorageDB::$db

protected

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

MEMBERS_TABLE

const ilIndividualAssessmentMembersStorageDB::MEMBERS_TABLE = "iass_members"

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

---

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

• Modules/IndividualAssessment/classes/Members/class.ilIndividualAssessmentMembersStorageDB.php