ilECSCourseMemberAssignment Class Reference

Storage of ecs course assignments. More...

Collaboration diagram for ilECSCourseMemberAssignment:

Public Member Functions
	__construct ($a_id=0)
	Constructor. More...
	getId ()
	setServer ($a_server)
	Set server. More...
	getServer ()
	Get server. More...
	setMid ($a_mid)
	getMid ()
	setCmsId ($a_id)
	getCmsId ()
	setCmsSubId ($a_id)
	getCmsSubId ()
	setObjId ($a_id)
	getObjId ()
	setUid ($a_id)
	getUid ()
	setStatus ($a_status)
	getStatus ()
	save ()
	Save new entry type $ilDB. More...
	update ()
	Update assignemt type $ilDB. More...
	delete ()
	Delete entry. More...

Static Public Member Functions
static	lookupMissingAssignmentsOfUser ($a_usr_id)
	Lookup missing assignments; type $ilDB. More...
static	deleteByObjId ($a_obj_id)
	Delete by obj_id. More...
static	deleteByServerId ($a_server_id)
	Delete by server id type $ilDB. More...
static	lookupUserIds ($a_cms_id, $a_cms_sub_id, $a_obj_id)
	Lookup user ids type $ilDB. More...
static	lookupAssignment ($a_cms_id, $a_cms_sub_id, $a_obj_id, $a_usr_id)
	Lookup assignment of user type $ilDB. More...

Data Fields
const	STATUS_ASSIGNED = 0
const	STATUS_LOCAL_DELETED = 1

Protected Member Functions
	read ()
	Read from db. More...

Private Attributes
	$id
	$server
	$mid
	$cms_id
	$cms_sub_id = 0
	$obj_id
	$uid
	$status = 0

Detailed Description

Storage of ecs course assignments.

Author

Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Definition at line 9 of file class.ilECSCourseMemberAssignment.php.

Constructor & Destructor Documentation

__construct()

ilECSCourseMemberAssignment::__construct

(

$a_id = 0

)

Constructor.

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

References read().

    {
        $this->id = $a_id;
        
        $this->read();
    }

Here is the call graph for this function:

Member Function Documentation

delete()

ilECSCourseMemberAssignment::delete

(

)

Delete entry.

Definition at line 310 of file class.ilECSCourseMemberAssignment.php.

References $DIC, $ilDB, $query, and getId().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $query = 'DELETE FROM ecs_course_assignments ' .
                'WHERE id = ' . $ilDB->quote($this->getId(), 'integer');
        $ilDB->manipulate($query);
        return true;
    }

Here is the call graph for this function:

deleteByObjId()

static ilECSCourseMemberAssignment::deleteByObjId (   $a_obj_id )

static

Delete by obj_id.

Definition at line 62 of file class.ilECSCourseMemberAssignment.php.

References $DIC, $ilDB, and $query.

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $query = 'DELETE FROM ecs_course_assignments ' .
                'WHERE obj_id = ' . $ilDB->quote($a_obj_id, 'integer');
        $ilDB->manipulate($query);
        return true;
    }

deleteByServerId()

static ilECSCourseMemberAssignment::deleteByServerId (   $a_server_id )

static

Delete by server id type $ilDB.

Parameters

type

$a_server_id

Returns

boolean

Definition at line 80 of file class.ilECSCourseMemberAssignment.php.

References $DIC, $ilDB, and $query.

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $query = 'DELETE FROM ecs_course_assignments ' .
                'WHERE sid = ' . $ilDB->quote($a_server_id, 'integer');
        $ilDB->manipulate($query);
        return true;
    }

getCmsId()

ilECSCourseMemberAssignment::getCmsId

(

)

Definition at line 198 of file class.ilECSCourseMemberAssignment.php.

References $cms_id.

Referenced by save(), and update().

    {
        return $this->cms_id;
    }

Here is the caller graph for this function:

getCmsSubId()

ilECSCourseMemberAssignment::getCmsSubId

(

)

Definition at line 208 of file class.ilECSCourseMemberAssignment.php.

References $cms_sub_id.

Referenced by save(), and update().

    {
        return $this->cms_sub_id;
    }

Here is the caller graph for this function:

getId()

ilECSCourseMemberAssignment::getId

(

)

Definition at line 160 of file class.ilECSCourseMemberAssignment.php.

References $id.

Referenced by delete(), read(), save(), and update().

    {
        return $this->id;
    }

Here is the caller graph for this function:

getMid()

ilECSCourseMemberAssignment::getMid

(

)

Definition at line 188 of file class.ilECSCourseMemberAssignment.php.

References $mid.

Referenced by save(), and update().

    {
        return $this->mid;
    }

Here is the caller graph for this function:

getObjId()

ilECSCourseMemberAssignment::getObjId

(

)

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

References $obj_id.

Referenced by save(), and update().

    {
        return $this->obj_id;
    }

Here is the caller graph for this function:

getServer()

ilECSCourseMemberAssignment::getServer

(

)

Get server.

Returns

int

Definition at line 178 of file class.ilECSCourseMemberAssignment.php.

References $server.

Referenced by save(), and update().

    {
        return $this->server;
    }

Here is the caller graph for this function:

getStatus()

ilECSCourseMemberAssignment::getStatus

(

)

Definition at line 238 of file class.ilECSCourseMemberAssignment.php.

References $status.

Referenced by save(), and update().

    {
        return $this->status;
    }

Here is the caller graph for this function:

getUid()

ilECSCourseMemberAssignment::getUid

(

)

Definition at line 228 of file class.ilECSCourseMemberAssignment.php.

References $uid.

Referenced by save(), and update().

    {
        return $this->uid;
    }

Here is the caller graph for this function:

lookupAssignment()

static ilECSCourseMemberAssignment::lookupAssignment (   $a_cms_id,   $a_cms_sub_id,   $a_obj_id,   $a_usr_id  )

static

Lookup assignment of user type $ilDB.

Parameters

type	$a_cms_id
type	$a_obj_id
type	$a_usr_id

Returns

|null

Definition at line 134 of file class.ilECSCourseMemberAssignment.php.

References $DIC, $ilDB, $query, $res, $row, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilECSCmsCourseMemberCommandQueueHandler\refreshAssignmentStatus().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $cms_sub_id_query = '';
        if (is_null($a_cms_sub_id)) {
            $cms_sub_id_query = 'AND cms_sub_id IS NULL ';
        } else {
            $cms_sub_id_query = 'AND cms_sub_id = ' . $ilDB->quote($a_cms_sub_id, 'integer') . ' ';
        }
        
        $query = 'SELECT id FROM ecs_course_assignments ' .
                'WHERE cms_id = ' . $ilDB->quote($a_cms_id, 'integer') . ' ' .
                $cms_sub_id_query .
                'AND obj_id = ' . $ilDB->quote($a_obj_id, 'integer') . ' ' .
                'AND usr_id = ' . $ilDB->quote($a_usr_id, 'text');
        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            return new ilECSCourseMemberAssignment($row->id);
        }
        return null;
    }

Here is the caller graph for this function:

lookupMissingAssignmentsOfUser()

static ilECSCourseMemberAssignment::lookupMissingAssignmentsOfUser (   $a_usr_id )

static

Lookup missing assignments; type $ilDB.

Parameters

string

account

Returns

ilECSCourseMemberAssignment[]

Definition at line 40 of file class.ilECSCourseMemberAssignment.php.

References $DIC, $ilDB, $query, $res, $row, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilECSAppEventListener\handleMembership().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $query = 'SELECT id FROM ecs_course_assignments ' .
                'WHERE usr_id = ' . $ilDB->quote($a_usr_id, 'text');
        $res = $ilDB->query($query);
        
        $obj_ids = array();
        
        $assignments = array();
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $assignments[] = new self($row->id);
        }
        return $assignments;
    }

Here is the caller graph for this function:

lookupUserIds()

static ilECSCourseMemberAssignment::lookupUserIds (   $a_cms_id,   $a_cms_sub_id,   $a_obj_id  )

static

Lookup user ids type $ilDB.

Parameters

type	$a_cms_id
type	$a_obj_id

Returns

type

Definition at line 99 of file class.ilECSCourseMemberAssignment.php.

References $DIC, $ilDB, $query, $res, $row, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilECSCmsCourseMemberCommandQueueHandler\refreshAssignmentStatus().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $cms_sub_id_query = '';
        
        if (is_null($a_cms_sub_id)) {
            $cms_sub_id_query = 'AND cms_sub_id IS NULL ';
        } else {
            $cms_sub_id_query = 'AND cms_sub_id = ' . $ilDB->quote($a_cms_sub_id, 'integer') . ' ';
        }
        
        $query = 'SELECT usr_id FROM ecs_course_assignments ' .
                'WHERE cms_id = ' . $ilDB->quote($a_cms_id, 'integer') . ' ' .
                $cms_sub_id_query .
                'AND obj_id = ' . $ilDB->quote($a_obj_id, 'integer');
        $res = $ilDB->query($query);
        
        $usr_ids = array();
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $usr_ids[] = $row->usr_id;
        }
        return $usr_ids;
    }

Here is the caller graph for this function:

read()

ilECSCourseMemberAssignment::read ( )

protected

Read from db.

Returns

bool

Definition at line 328 of file class.ilECSCourseMemberAssignment.php.

References $DIC, $ilDB, $query, $res, $row, ilDBConstants\FETCHMODE_OBJECT, getId(), setCmsId(), setCmsSubId(), setMid(), setObjId(), setServer(), setStatus(), and setUid().

Referenced by __construct().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        if (!$this->getId()) {
            return false;
        }
        
        $query = 'SELECT * FROM ecs_course_assignments ' .
                'WHERE id = ' . $ilDB->quote($this->getId(), 'integer');
        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->setServer($row->sid);
            $this->setMid($row->mid);
            $this->setCmsId($row->cms_id);
            $this->setCmsSubId($row->cms_sub_id);
            $this->setObjId($row->obj_id);
            $this->setUid($row->usr_id);
            $this->setStatus($row->status);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

save()

ilECSCourseMemberAssignment::save

(

)

Save new entry type $ilDB.

Definition at line 247 of file class.ilECSCourseMemberAssignment.php.

References $DIC, $ilDB, $query, getCmsId(), getCmsSubId(), getId(), getMid(), getObjId(), getServer(), getStatus(), and getUid().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $this->id = $ilDB->nextId('ecs_course_assignments');
        
        
        $assignment = self::lookupAssignment(
            $this->getCmsId(),
            $this->getCmsSubId(),
            $this->getObjId(),
            $this->getUid()
        );
        if ($assignment instanceof ilECSCourseMemberAssignment) {
            $assignment->update();
            return true;
        }
        
        $query = 'INSERT INTO ecs_course_assignments ' .
                '(id,sid,mid,cms_id,cms_sub_id,obj_id,usr_id,status) ' .
                'VALUES( ' .
                $ilDB->quote($this->getId(), 'integer') . ', ' .
                $ilDB->quote($this->getServer(), 'integer') . ', ' .
                $ilDB->quote($this->getMid(), 'integer') . ', ' .
                $ilDB->quote($this->getCmsId(), 'integer') . ', ' .
                $ilDB->quote($this->getCmsSubId(), 'integer') . ', ' .
                $ilDB->quote($this->getObjId(), 'integer') . ', ' .
                $ilDB->quote($this->getUid(), 'text') . ', ' .
                $ilDB->quote($this->getStatus(), 'integer') . ' ' .
                ')';
        $ilDB->manipulate($query);
    }

Here is the call graph for this function:

setCmsId()

ilECSCourseMemberAssignment::setCmsId

(

$a_id

)

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

Referenced by read().

    {
        $this->cms_id = $a_id;
    }

Here is the caller graph for this function:

setCmsSubId()

ilECSCourseMemberAssignment::setCmsSubId

(

$a_id

)

Definition at line 203 of file class.ilECSCourseMemberAssignment.php.

Referenced by read().

    {
        $this->cms_sub_id = $a_id;
    }

Here is the caller graph for this function:

setMid()

ilECSCourseMemberAssignment::setMid

(

$a_mid

)

Definition at line 183 of file class.ilECSCourseMemberAssignment.php.

Referenced by read().

    {
        $this->mid = $a_mid;
    }

Here is the caller graph for this function:

setObjId()

ilECSCourseMemberAssignment::setObjId

(

$a_id

)

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

Referenced by read().

    {
        $this->obj_id = $a_id;
    }

Here is the caller graph for this function:

setServer()

ilECSCourseMemberAssignment::setServer

(

$a_server

)

Set server.

Parameters

int

server_id

Definition at line 169 of file class.ilECSCourseMemberAssignment.php.

Referenced by read().

    {
        $this->server = $a_server;
    }

Here is the caller graph for this function:

setStatus()

ilECSCourseMemberAssignment::setStatus

(

$a_status

)

Definition at line 233 of file class.ilECSCourseMemberAssignment.php.

Referenced by read().

    {
        $this->status = $a_status;
    }

Here is the caller graph for this function:

setUid()

ilECSCourseMemberAssignment::setUid

(

$a_id

)

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

Referenced by read().

    {
        $this->uid = $a_id;
    }

Here is the caller graph for this function:

update()

ilECSCourseMemberAssignment::update

(

)

Update assignemt type $ilDB.

Returns

boolean

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

References $DIC, $ilDB, $query, getCmsId(), getCmsSubId(), getId(), getMid(), getObjId(), getServer(), getStatus(), and getUid().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $query = 'UPDATE ecs_course_assignments ' .
                'SET ' .
                'sid = ' . $ilDB->quote($this->getServer(), 'integer') . ', ' .
                'mid = ' . $ilDB->quote($this->getMid(), 'integer') . ', ' .
                'cms_id = ' . $ilDB->quote($this->getCmsId(), 'integer') . ', ' .
                'cms_sub_id = ' . $ilDB->quote($this->getCmsSubId(), 'integer') . ', ' .
                'obj_id = ' . $ilDB->quote($this->getObjId(), 'integer') . ', ' .
                'usr_id = ' . $ilDB->quote($this->getUid(), 'text') . ', ' .
                'status = ' . $ilDB->quote($this->getStatus(), 'integer') . ' ' .
                'WHERE id = ' . $ilDB->quote($this->getId(), 'integer');
        $ilDB->manipulate($query);
        return true;
    }

Here is the call graph for this function:

Field Documentation

$cms_id

ilECSCourseMemberAssignment::$cms_id

private

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

Referenced by getCmsId().

$cms_sub_id

ilECSCourseMemberAssignment::$cms_sub_id = 0

private

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

Referenced by getCmsSubId().

$id

ilECSCourseMemberAssignment::$id

private

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

Referenced by getId().

$mid

ilECSCourseMemberAssignment::$mid

private

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

Referenced by getMid().

$obj_id

ilECSCourseMemberAssignment::$obj_id

private

Definition at line 19 of file class.ilECSCourseMemberAssignment.php.

Referenced by getObjId().

$server

ilECSCourseMemberAssignment::$server

private

Definition at line 15 of file class.ilECSCourseMemberAssignment.php.

Referenced by getServer().

$status

ilECSCourseMemberAssignment::$status = 0

private

Definition at line 21 of file class.ilECSCourseMemberAssignment.php.

Referenced by getStatus().

$uid

ilECSCourseMemberAssignment::$uid

private

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

Referenced by getUid().

STATUS_ASSIGNED

const ilECSCourseMemberAssignment::STATUS_ASSIGNED = 0

Definition at line 11 of file class.ilECSCourseMemberAssignment.php.

STATUS_LOCAL_DELETED

const ilECSCourseMemberAssignment::STATUS_LOCAL_DELETED = 1

Definition at line 12 of file class.ilECSCourseMemberAssignment.php.

---

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

• Services/WebServices/ECS/classes/Course/class.ilECSCourseMemberAssignment.php