Storage of ecs course assignments. More...

Collaboration diagram for ilECSCourseMemberAssignment:

Public Member Functions
	__construct (int $a_id=0)
	Constructor. More...

	getId ()

	setServer (int $a_server)
	Set server. More...

	getServer ()
	Get server. More...

	setMid (int $a_mid)

	getMid ()

	setCmsId (int $a_id)

	getCmsId ()

	setCmsSubId (?int $a_id)

	getCmsSubId ()

	setObjId (int $a_id)

	getObjId ()

	setUid (string $a_id)

	getUid ()

	setStatus (bool $a_status)

	getStatus ()

	save ()
	Save new entry. More...

	update ()
	Update assignemt. More...

	delete ()
	Delete entry. More...

Static Public Member Functions
static	lookupMissingAssignmentsOfUser (string $a_usr_id)
	Lookup missing assignments;. More...

static	deleteByObjId (int $a_obj_id)
	Delete by obj_id. More...

static	deleteByServerId (int $a_server_id)
	Delete by server id. More...

static	lookupUserIds (int $a_cms_id, ?int $a_cms_sub_id, int $a_obj_id)
	Lookup user ids. More...

static	lookupAssignment (int $a_cms_id, ?int $a_cms_sub_id, int $a_obj_id, string $a_usr_id)
	Lookup assignment of user. More...

Data Fields
const	STATUS_ASSIGNED = 0

const	STATUS_LOCAL_DELETED = 1

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

Private Member Functions
	getArrayForDatabase ()

Private Attributes
ilDBInterface	$db

int	$id

int	$server

int	$mid

int	$cms_id

int	$cms_sub_id = null

int	$obj_id

string	$uid

bool	$status = false

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

Constructor & Destructor Documentation

◆ __construct()

ilECSCourseMemberAssignment::__construct ( int $a_id = 0 )

Constructor.

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

References $DIC, and read().

     {
         global $DIC;
 
         $this->db = $DIC->database();
 
         $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 294 of file class.ilECSCourseMemberAssignment.php.

References getId().

                             : bool
     {
         $query = 'DELETE FROM ecs_course_assignments ' .
             'WHERE id = ' . $this->db->quote($this->getId(), 'integer');
         $this->db->manipulate($query);
         return true;
     }

Here is the call graph for this function:

◆ deleteByObjId()

static ilECSCourseMemberAssignment::deleteByObjId ( int $a_obj_id )

static

Delete by obj_id.

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

References $DIC, and $ilDB.

                                                        : bool
     {
         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 ( int $a_server_id )

static

Delete by server id.

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

References $DIC, and $ilDB.

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

◆ getArrayForDatabase()

ilECSCourseMemberAssignment::getArrayForDatabase ( )

private

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

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

Referenced by save(), and update().

                                           : array
     {
         return [
             'id' => ['integer', $this->getId()],
             'sid' => ['integer', $this->getServer()],
             'mid' => ['integer', $this->getMid()],
             'cms_id' => ['integer', $this->getCmsId()],
             'cms_sub_id' => ['integer', $this->getCmsSubId()],
             'obj_id' => ['integer', $this->getObjId()],
             'usr_id' => ['text', $this->getUid()],
             'status' => ['integer', $this->getStatus()],
         ];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCmsId()

ilECSCourseMemberAssignment::getCmsId ( )

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

References $cms_id.

Referenced by getArrayForDatabase(), and save().

                               : int
     {
         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 getArrayForDatabase(), and save().

                                  : ?int
     {
         return $this->cms_sub_id;
     }

Here is the caller graph for this function:

◆ getId()

ilECSCourseMemberAssignment::getId ( )

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

References $id.

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

                            : int
     {
         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 getArrayForDatabase().

                             : int
     {
         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 getArrayForDatabase(), and save().

                               : int
     {
         return $this->obj_id;
     }

Here is the caller graph for this function:

◆ getServer()

ilECSCourseMemberAssignment::getServer ( )

Get server.

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

References $server.

Referenced by getArrayForDatabase().

                                : int
     {
         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 getArrayForDatabase().

                                : bool
     {
         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 getArrayForDatabase(), and save().

                             : string
     {
         return $this->uid;
     }

Here is the caller graph for this function:

◆ lookupAssignment()

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

static

Lookup assignment of user.

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

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

Referenced by ilECSCmsCourseMemberCommandQueueHandler\refreshAssignmentStatus().

                                                                                                                : ?ilECSCourseMemberAssignment
     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         if (is_null($a_cms_sub_id)) {
             $cms_sub_id_query = 'AND (cms_sub_id IS NULL OR cms_sub_id = 0) ';
         } 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);
         if ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             return new ilECSCourseMemberAssignment((int) $row->id);
         }
         return null;
     }

Here is the caller graph for this function:

◆ lookupMissingAssignmentsOfUser()

static ilECSCourseMemberAssignment::lookupMissingAssignmentsOfUser ( string $a_usr_id )

static

Lookup missing assignments;.

Parameters

string $a_usr_id account

Returns: ilECSCourseMemberAssignment[]

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

References $DIC, $ilDB, $res, ilDBConstants\FETCHMODE_OBJECT, and ILIAS\Repository\int().

Referenced by ilECSAppEventListener\handleMembership().

                                                                            : array
     {
         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);
 
         $assignments = array();
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $assignments[] = new self((int) $row->id);
         }
         return $assignments;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ lookupUserIds()

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

static

Lookup user ids.

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

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

Referenced by ilECSCmsCourseMemberCommandQueueHandler\refreshAssignmentStatus().

                                                                                           : array
     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         if (is_null($a_cms_sub_id)) {
             $cms_sub_id_query = 'AND (cms_sub_id IS NULL OR cms_sub_id = 0) ';
         } 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 = [];
         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.

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

References $r, getId(), setCmsId(), setCmsSubId(), setMid(), setObjId(), setServer(), setStatus(), and setUid().

Referenced by __construct().

                              : bool
     {
         if (!$this->getId()) {
             return false;
         }
         $r = $this->db->queryF(
             "SELECT sid,mid,cms_id,cms_sub_id,obj_id,usr_id,status FROM ecs_course_assignments WHERE id = %d",
             ['integer'],
             [$this->getId()]
         );
         $row = $this->db->fetchObject($r);
         $this->setServer((int) $row->sid);
         $this->setMid((int) $row->mid);
         $this->setCmsId((int) $row->cms_id);
         $this->setCmsSubId((int) $row->cms_sub_id);
         $this->setObjId((int) $row->obj_id);
         $this->setUid($row->usr_id);
         $this->setStatus((bool) $row->status);
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ save()

ilECSCourseMemberAssignment::save ( )

Save new entry.

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

References getArrayForDatabase(), getCmsId(), getCmsSubId(), getObjId(), and getUid().

                           : bool
     {
         $this->id = $this->db->nextId('ecs_course_assignments');
 
         $assignment = self::lookupAssignment(
             $this->getCmsId(),
             $this->getCmsSubId(),
             $this->getObjId(),
             $this->getUid()
         );
         if ($assignment instanceof self) {
             $assignment->update();
             return true;
         }
         $this->db->insert('ecs_course_assignments', $this->getArrayForDatabase());
         return true;
     }

Here is the call graph for this function:

◆ setCmsId()

ilECSCourseMemberAssignment::setCmsId ( int $a_id )

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

Referenced by read().

                                        : void
     {
         $this->cms_id = $a_id;
     }

Here is the caller graph for this function:

◆ setCmsSubId()

ilECSCourseMemberAssignment::setCmsSubId ( ?int $a_id )

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

Referenced by read().

                                            : void
     {
         $this->cms_sub_id = $a_id;
     }

Here is the caller graph for this function:

◆ setMid()

ilECSCourseMemberAssignment::setMid ( int $a_mid )

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

Referenced by read().

                                       : void
     {
         $this->mid = $a_mid;
     }

Here is the caller graph for this function:

◆ setObjId()

ilECSCourseMemberAssignment::setObjId ( int $a_id )

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

Referenced by read().

                                        : void
     {
         $this->obj_id = $a_id;
     }

Here is the caller graph for this function:

◆ setServer()

ilECSCourseMemberAssignment::setServer ( int $a_server )

Set server.

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

Referenced by read().

                                             : void
     {
         $this->server = $a_server;
     }

Here is the caller graph for this function:

◆ setStatus()

ilECSCourseMemberAssignment::setStatus ( bool $a_status )

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

Referenced by read().

                                              : void
     {
         $this->status = $a_status;
     }

Here is the caller graph for this function:

◆ setUid()

ilECSCourseMemberAssignment::setUid ( string $a_id )

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

Referenced by read().

                                         : void
     {
         $this->uid = $a_id;
     }

Here is the caller graph for this function:

◆ update()

ilECSCourseMemberAssignment::update ( )

Update assignemt.

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

References getArrayForDatabase(), and getId().

                             : bool
     {
         $this->db->update('ecs_course_assignments', $this->getArrayForDatabase(), [
             'id' => [
                 'integer',
                 $this->getId(),
             ],
         ]);
         return true;
     }

Here is the call graph for this function:

Field Documentation

◆ $cms_id

int ilECSCourseMemberAssignment::$cms_id

private

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

Referenced by getCmsId().

◆ $cms_sub_id

int ilECSCourseMemberAssignment::$cms_sub_id = null

private

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

Referenced by getCmsSubId().

◆ $db

ilDBInterface ilECSCourseMemberAssignment::$db

private

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

◆ $id

int ilECSCourseMemberAssignment::$id

private

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

Referenced by getId().

◆ $mid

int ilECSCourseMemberAssignment::$mid

private

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

Referenced by getMid().

◆ $obj_id

int ilECSCourseMemberAssignment::$obj_id

private

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

Referenced by getObjId().

◆ $server

int ilECSCourseMemberAssignment::$server

private

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

Referenced by getServer().

◆ $status

bool ilECSCourseMemberAssignment::$status = false

private

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

Referenced by getStatus().

◆ $uid

string ilECSCourseMemberAssignment::$uid

private

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

Referenced by getUid().

◆ STATUS_ASSIGNED

const ilECSCourseMemberAssignment::STATUS_ASSIGNED = 0

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

◆ STATUS_LOCAL_DELETED

const ilECSCourseMemberAssignment::STATUS_LOCAL_DELETED = 1

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

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

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

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ delete()

◆ deleteByObjId()

◆ deleteByServerId()

◆ getArrayForDatabase()

◆ getCmsId()

◆ getCmsSubId()

◆ getId()

◆ getMid()

◆ getObjId()

◆ getServer()

◆ getStatus()

◆ getUid()

◆ lookupAssignment()

◆ lookupMissingAssignmentsOfUser()

◆ lookupUserIds()

◆ read()

◆ save()

◆ setCmsId()

◆ setCmsSubId()

◆ setMid()

◆ setObjId()

◆ setServer()

◆ setStatus()

◆ setUid()

◆ update()

Field Documentation

◆ $cms_id

◆ $cms_sub_id

◆ $db

◆ $id

◆ $mid

◆ $obj_id

◆ $server

◆ $status

◆ $uid

◆ STATUS_ASSIGNED

◆ STATUS_LOCAL_DELETED