ilECSCourseMemberAssignment Class Reference

Storage of ecs course assignments. More...

Collaboration diagram for ilECSCourseMemberAssignment:

Public Member Functions
	__construct ($a_id=0)
	Constructor.
	getId ()
	setServer ($a_server)
	Set server.
	getServer ()
	Get server.
	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.
	update ()
	Update assignemt type $ilDB.
	delete ()
	Delete entry.

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

Data Fields
const	STATUS_ASSIGNED = 0
const	STATUS_LOCAL_DELETED = 1

Protected Member Functions
	read ()
	Read from db.

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

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

ilECSCourseMemberAssignment::delete

(

)

Delete entry.

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

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

        {
                global $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:

static ilECSCourseMemberAssignment::deleteByObjId (   $a_obj_id )

static

Delete by obj_id.

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

References $ilDB, and $query.

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

static ilECSCourseMemberAssignment::deleteByServerId (   $a_server_id )

static

Delete by server id type $ilDB.

Parameters

type

$a_server_id

Returns

boolean

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

References $ilDB, and $query.

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

ilECSCourseMemberAssignment::getCmsId

(

)

Definition at line 174 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:

ilECSCourseMemberAssignment::getCmsSubId

(

)

Definition at line 184 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:

ilECSCourseMemberAssignment::getId

(

)

Definition at line 136 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:

ilECSCourseMemberAssignment::getMid

(

)

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

References $mid.

Referenced by save(), and update().

        {
                return $this->mid;
        }

Here is the caller graph for this function:

ilECSCourseMemberAssignment::getObjId

(

)

Definition at line 194 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:

ilECSCourseMemberAssignment::getServer

(

)

Get server.

Returns

int

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

References $server.

Referenced by save(), and update().

        {
                return $this->server;
        }

Here is the caller graph for this function:

ilECSCourseMemberAssignment::getStatus

(

)

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

References $status.

Referenced by save(), and update().

        {
                return $this->status;
        }

Here is the caller graph for this function:

ilECSCourseMemberAssignment::getUid

(

)

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

References $uid.

Referenced by save(), and update().

        {
                return $this->uid;
        }

Here is the caller graph for this function:

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 118 of file class.ilECSCourseMemberAssignment.php.

References $ilDB, $query, $res, $row, and DB_FETCHMODE_OBJECT.

Referenced by ilECSCmsCourseMemberCommandQueueHandler\refreshAssignmentStatus(), and save().

        {
                global $ilDB;
                
                $query = 'SELECT id FROM ecs_course_assignments '.
                                'WHERE cms_id = '.$ilDB->quote($a_cms_id,'integer').' '.
                                'AND cms_sub_id = '.$ilDB->quote($a_cms_sub_id,'integer').' '.
                                '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(DB_FETCHMODE_OBJECT))
                {
                        return new ilECSCourseMemberAssignment($row->id);
                }
                return null;
        }

Here is the caller graph for this function:

static ilECSCourseMemberAssignment::lookupMissingAssignmentsOfUser (   $a_usr_id )

static

Lookup missing assignments; type $ilDB.

Parameters

type

$a_usr_id

Returns

type

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

References $ilDB, $query, $res, $row, and DB_FETCHMODE_OBJECT.

Referenced by ilECSAppEventListener\handleMembership().

        {
                global $ilDB;
                
                $query = 'SELECT obj_id FROM ecs_course_assignments '.
                                'WHERE usr_id = '.$ilDB->quote($a_usr_id,'text');
                $res = $ilDB->query($query);
                
                $obj_ids = array();
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $obj_ids[] = $row->obj_id;
                }
                return $obj_ids;
        }

Here is the caller graph for this function:

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 92 of file class.ilECSCourseMemberAssignment.php.

References $ilDB, $query, $res, $row, and DB_FETCHMODE_OBJECT.

Referenced by ilECSCmsCourseMemberCommandQueueHandler\refreshAssignmentStatus().

        {
                global $ilDB;
                
                $query = 'SELECT usr_id FROM ecs_course_assignments '.
                                'WHERE cms_id = '.$ilDB->quote($a_cms_id,'integer').' '.
                                'AND cms_sub_id = '.$ilDB->quote($a_cms_sub_id).' '.
                                'AND obj_id = '.$ilDB->quote($a_obj_id,'integer');
                $res = $ilDB->query($query);
                
                $usr_ids = array();
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $usr_ids[] = $row->usr_id;
                }
                return $usr_ids;
        }

Here is the caller graph for this function:

ilECSCourseMemberAssignment::read ( )

protected

Read from db.

Returns

bool

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

References $ilDB, $query, $res, $row, DB_FETCHMODE_OBJECT, getId(), setCmsId(), setCmsSubId(), setMid(), setObjId(), setServer(), setStatus(), and setUid().

Referenced by __construct().

        {
                global $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(DB_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:

ilECSCourseMemberAssignment::save

(

)

Save new entry type $ilDB.

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

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

        {
                global $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:

ilECSCourseMemberAssignment::setCmsId

(

$a_id

)

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

Referenced by read().

        {
                $this->cms_id = $a_id;
        }

Here is the caller graph for this function:

ilECSCourseMemberAssignment::setCmsSubId

(

$a_id

)

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

Referenced by read().

        {
                $this->cms_sub_id = $a_id;
        }

Here is the caller graph for this function:

ilECSCourseMemberAssignment::setMid

(

$a_mid

)

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

Referenced by read().

        {
                $this->mid = $a_mid;
        }

Here is the caller graph for this function:

ilECSCourseMemberAssignment::setObjId

(

$a_id

)

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

Referenced by read().

        {
                $this->obj_id = $a_id;
        }

Here is the caller graph for this function:

ilECSCourseMemberAssignment::setServer

(

$a_server

)

Set server.

Parameters

int

server_id

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

Referenced by read().

        {
                $this->server = $a_server;
        }

Here is the caller graph for this function:

ilECSCourseMemberAssignment::setStatus

(

$a_status

)

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

Referenced by read().

        {
                $this->status = $a_status;
        }

Here is the caller graph for this function:

ilECSCourseMemberAssignment::setUid

(

$a_id

)

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

Referenced by read().

        {
                $this->uid = $a_id;
        }

Here is the caller graph for this function:

ilECSCourseMemberAssignment::update

(

)

Update assignemt type $ilDB.

Returns

boolean

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

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

        {
                global $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

ilECSCourseMemberAssignment::$cms_id

private

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

Referenced by getCmsId().

ilECSCourseMemberAssignment::$cms_sub_id = 0

private

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

Referenced by getCmsSubId().

ilECSCourseMemberAssignment::$id

private

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

Referenced by getId().

ilECSCourseMemberAssignment::$mid

private

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

Referenced by getMid().

ilECSCourseMemberAssignment::$obj_id

private

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

Referenced by getObjId().

ilECSCourseMemberAssignment::$server

private

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

Referenced by getServer().

ilECSCourseMemberAssignment::$status = 0

private

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

Referenced by getStatus().

ilECSCourseMemberAssignment::$uid

private

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

Referenced by getUid().

const ilECSCourseMemberAssignment::STATUS_ASSIGNED = 0

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

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