ilObjiLincClassroom Class Reference

Class ilObjiLincClassroom. More...

Inheritance diagram for ilObjiLincClassroom:

Collaboration diagram for ilObjiLincClassroom:

Public Member Functions
	ilObjiLincClassroom ($a_icla_id, $a_icrs_id)
	Constructor public.
	_lookupiCourseId ($a_ref_id)
	read ()
	private
	joinClass (&$a_user_obj, $a_ilinc_class_id)
	findUser (&$a_user_obj)
	update ($a_data="")
	update object data
	delete ()
	delete object and all related data
	getDocentList ()
	_getDocent ($a_ilinc_user_id)
	_setFullname ($a_title="", $a_firstname="", $a_lastname="")
	setDocentId ($a_ilinc_user_id)
	getDocentName ()
	getDocentId ()
	setStatus ($a_status)
	getStatus ()
	getErrorMsg ()
Public Member Functions inherited from ilObject
	ilObject ($a_id=0, $a_reference=true)
	Constructor public.
	withReferences ()
	determines wehter objects are referenced or not (got ref ids or not)
	read ($a_force_db=false)
	read object data from db into object
	getId ()
	get object id public
	setId ($a_id)
	set object id public
	setRefId ($a_id)
	set reference id public
	getRefId ()
	get reference id public
	getType ()
	get object type public
	setType ($a_type)
	set object type public
	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions
	getTitle ()
	get object title public
	getUntranslatedTitle ()
	get untranslated object title public
	setTitle ($a_title)
	set object title
	getDescription ()
	get object description
	setDescription ($a_desc)
	set object description
	getLongDescription ()
	get object long description (stored in object_description)
	getImportId ()
	get import id
	setImportId ($a_import_id)
	set import id
	_lookupObjIdByImportId ($a_import_id)
	getOwner ()
	get object owner
	getOwnerName ()
	_lookupOwnerName ($a_owner_id)
	lookup owner name for owner id
	setOwner ($a_owner)
	set object owner
	getCreateDate ()
	get create date public
	getLastUpdateDate ()
	get last update date public
	setObjDataRecord ($a_record)
	set object_data record (note: this method should only be called from the ilObjectFactory class)
	create ()
	create
	update ()
	update object in db
	MDUpdateListener ($a_element)
	Meta data update listener.
	createMetaData ()
	create meta data entry
	updateMetaData ()
	update meta data entry
	deleteMetaData ()
	delete meta data entry
	updateOwner ()
	update owner of object in db
	_getIdForImportId ($a_import_id)
	get current object id for import id (static)
	_getAllReferences ($a_id)
	get all reference ids of object
	_lookupTitle ($a_id)
	lookup object title
	_lookupDescription ($a_id)
	lookup object description
	_lookupLastUpdate ($a_id, $a_as_string=false)
	lookup last update
	_getLastUpdateOfObjects ($a_objs)
	Get last update for a set of media objects.
	_lookupObjId ($a_id)
	_setDeletedDate ($a_ref_id)
	only called in ilTree::saveSubTree
	_resetDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes
	_writeTitle ($a_obj_id, $a_title)
	write title to db (static)
	_writeDescription ($a_obj_id, $a_desc)
	write description to db (static)
	_writeImportId ($a_obj_id, $a_import_id)
	write import id to db (static)
	_lookupType ($a_id, $a_reference=false)
	lookup object type
	_isInTrash ($a_ref_id)
	checks wether object is in trash
	_hasUntrashedReference ($a_obj_id)
	checks wether an object has at least one reference that is not in trash
	_lookupObjectId ($a_ref_id)
	lookup object id
	_getObjectsDataForType ($a_type, $a_omit_trash=false)
	get all objects of a certain type
	putInTree ($a_parent_ref)
	maybe this method should be in tree object!?
	setPermissions ($a_parent_ref)
	set permissions of object
	createReference ()
	creates reference for object
	countReferences ()
	count references of object
	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) public
	createRoleFolder ()
	creates a local role folder
	notify ($a_event, $a_ref_id, $a_parent_non_rbac_id, $a_node_id, $a_params=0)
	notifys an object about an event occured Based on the event passed, each object may decide how it reacts.
	setRegisterMode ($a_bool)
	isUserRegistered ($a_user_id=0)
	requireRegistration ()
	getXMLZip ()
	getHTMLDirectory ()
	cloneObject ($a_target_id, $a_copy_id=0)
	Clone object permissions, put in tree ...
	appendCopyInfo ($a_target_id, $a_copy_id)
	Prepend Copy info if object with same name exists in that container.
	cloneDependencies ($a_target_id, $a_copy_id)
	Clone object dependencies.
	cloneMetaData ($target_obj)
	Copy meta data.

Additional Inherited Members
Static Public Member Functions inherited from ilObject
static	_getIdsForTitle ($title, $type= '')
	_exists ($a_id, $a_reference=false)
	checks if an object exists in object_data
static	_getObjectsByType ($a_obj_type="")
	Get objects by type.
static	_prepareCloneSelection ($a_ref_ids, $new_type)
	Prepare copy wizard object selection.
static	_getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
Data Fields inherited from ilObject
	$ilias
	$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
	$obj_data_record
	object_data record

Detailed Description

Class ilObjiLincClassroom.

Author

Sascha Hofmann sasch.nosp@m.ahof.nosp@m.mann@.nosp@m.gmx..nosp@m.de

Version

Id:

class.ilObjiLincClassroom.php 15689 2008-01-08 15:55:14Z akill

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

Member Function Documentation

ilObjiLincClassroom::_getDocent

(

$a_ilinc_user_id

)

Definition at line 242 of file class.ilObjiLincClassroom.php.

References ilObject\$lng, _setFullname(), and DB_FETCHMODE_OBJECT.

Referenced by getDocentName(), and ilObjiLincClassroomListGUI\getProperties().

        {
                global $ilDB, $lng;
                
                $fullname = false;
                
                $q = "SELECT title,firstname,lastname FROM usr_data WHERE ilinc_id = ".$ilDB->quote($a_ilinc_user_id)." LIMIT 1";
                $r = $ilDB->query($q);
                
                while ($row = $r->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $fullname = ilObjiLincClassroom::_setFullname($row->title,$row->firstname,$row->lastname);
                }
                
                return $fullname;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilObjiLincClassroom::_lookupiCourseId

(

$a_ref_id

)

Definition at line 72 of file class.ilObjiLincClassroom.php.

References DB_FETCHMODE_ASSOC.

Referenced by getDocentList(), and ilObjiLincClassroomGUI\save().

        {
                global $ilDB;

                $q = "SELECT course_id FROM ilinc_data ".
                         "LEFT JOIN object_reference ON object_reference.obj_id=ilinc_data.obj_id ".
                         "WHERE object_reference.ref_id = ".$ilDB->quote($a_ref_id);
                $obj_set = $ilDB->query($q);
                $obj_rec = $obj_set->fetchRow(DB_FETCHMODE_ASSOC);

                return $obj_rec["course_id"];
        }

Here is the caller graph for this function:

ilObjiLincClassroom::_setFullname	(		$a_title = "",
			$a_firstname = "",
			$a_lastname = ""
	)

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

Referenced by _getDocent().

        {
                $fullname = "";

                if ($a_title)
                {
                        $fullname = $a_title." ";
                }

                if ($a_firstname)
                {
                        $fullname .= $a_firstname." ";
                }

                if ($a_lastname)
                {
                        return $fullname.$a_lastname;
                }
        }

Here is the caller graph for this function:

ilObjiLincClassroom::delete

(

)

delete object and all related data

public

Returns

boolean true if all object data were removed; false if only a references were removed

Reimplemented from ilObject.

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

        {               
                $this->ilincAPI->removeClass($this->id);
                $response = $this->ilincAPI->sendRequest();

                if ($response->isError())
                {
                        if (!$response->getErrorMsg())
                        {
                                $this->error_msg = "err_delete_classroom";
                        }
                        else
                        {
                                $this->error_msg = $response->getErrorMsg();
                        }
                        
                        return false;
                }
                
                return true;
        }

ilObjiLincClassroom::findUser

(

&

$a_user_obj

)

Definition at line 144 of file class.ilObjiLincClassroom.php.

References exit.

        {
                $this->ilincAPI->findUser($a_user_obj);
                $response = $this->ilincAPI->sendRequest();
                
                var_dump($response->data);
                exit;
        }

ilObjiLincClassroom::getDocentId

(

)

Definition at line 294 of file class.ilObjiLincClassroom.php.

Referenced by update().

        {
                return $this->docent_id;
        }

Here is the caller graph for this function:

ilObjiLincClassroom::getDocentList

(

)

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

References _lookupiCourseId().

        {
                $ilinc_crs_id = ilObjiLincClassroom::_lookupiCourseId($this->parent);
                
                $this->ilincAPI->findRegisteredUsersByRole($ilinc_crs_id,true);
                $response = $this->ilincAPI->sendRequest();
                        
                if (is_array($response->data['users']))
                {
                                return $response->data['users'];
                }
                
                return array();
        }

Here is the call graph for this function:

ilObjiLincClassroom::getDocentName

(

)

Definition at line 284 of file class.ilObjiLincClassroom.php.

References _getDocent().

        {
                if (!$this->docent_name)
                {
                        $this->docent_name = $this->_getDocent($this->docent_id);
                }
                
                return $this->docent_name;
        }

Here is the call graph for this function:

ilObjiLincClassroom::getErrorMsg

(

)

Definition at line 316 of file class.ilObjiLincClassroom.php.

        {
                $err_msg = $this->error_msg;
                $this->error_msg = "";

                return $err_msg;
        }

ilObjiLincClassroom::getStatus

(

)

Definition at line 311 of file class.ilObjiLincClassroom.php.

Referenced by update().

        {
                return $this->status;
        }

Here is the caller graph for this function:

ilObjiLincClassroom::ilObjiLincClassroom	(		$a_icla_id,
			$a_icrs_id
	)

Constructor public.

Parameters

integer	ilinc class id
boolean	ilias ref id of ilinc course object

Definition at line 44 of file class.ilObjiLincClassroom.php.

References $ilErr, ilObject\$ilias, ilObject\$lng, and read().

        {
                global $ilErr,$ilias,$lng;
                
                $this->type = "icla";
                $this->id = $a_icla_id;         
                $this->parent = $a_icrs_id;
                $this->ilincAPI = new ilnetucateXMLAPI();

                $this->ilErr =& $ilErr;
                $this->ilias =& $ilias;
                $this->lng =& $lng;

                $this->max_title = MAXLENGTH_OBJ_TITLE;
                $this->max_desc = MAXLENGTH_OBJ_DESC;
                $this->add_dots = true;

                $this->referenced = false;
                $this->call_by_reference = false;

                if (!empty($this->id))
                {
                        $this->read();
                }
                
                return $this;
        }

Here is the call graph for this function:

ilObjiLincClassroom::joinClass	(	&	$a_user_obj,
			$a_ilinc_class_id
	)

Definition at line 116 of file class.ilObjiLincClassroom.php.

        {
                
                include_once ('./Modules/ILinc/classes/class.ilObjiLincUser.php');
                $ilinc_user = new ilObjiLincUser($a_user_obj);
                
                $this->ilincAPI->joinClass($ilinc_user,$a_ilinc_class_id);
                $response = $this->ilincAPI->sendRequest("joinClass");
                
                if ($response->isError())
                {
                        if (!$response->getErrorMsg())
                        {
                                $this->error_msg = "err_join_classroom";
                        }
                        else
                        {
                                $this->error_msg = $response->getErrorMsg();
                        }
                        
                        return false;
                }
                
                // return URL to join class room
                return trim($response->data['url']['cdata']);
        }

ilObjiLincClassroom::read

(

)

private

Definition at line 89 of file class.ilObjiLincClassroom.php.

References ilObject\setDescription(), setDocentId(), setStatus(), and ilObject\setTitle().

Referenced by ilObjiLincClassroom().

        {
                $this->ilincAPI->findClass($this->id);
                $response = $this->ilincAPI->sendRequest();

                if ($response->isError())
                {
                        if (!$response->getErrorMsg())
                        {
                                $this->error_msg = "err_read_class";
                        }
                        else
                        {
                                $this->error_msg = $response->getErrorMsg();
                        }
                        
                        return false;
                }
                
                //var_dump($response->data['classes']);
                
                $this->setTitle($response->data['classes'][$this->id]['name']);
                $this->setDescription($response->data['classes'][$this->id]['description']);
                $this->setDocentId($response->data['classes'][$this->id]['instructoruserid']);
                $this->setStatus($response->data['classes'][$this->id]['alwaysopen']);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilObjiLincClassroom::setDocentId

(

$a_ilinc_user_id

)

Definition at line 279 of file class.ilObjiLincClassroom.php.

Referenced by read().

        {
                $this->docent_id = $a_ilinc_user_id;
        }

Here is the caller graph for this function:

ilObjiLincClassroom::setStatus

(

$a_status

)

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

Referenced by read().

        {
                if ($a_status == "Wahr" or $a_status == "1" or $a_status == true)
                {
                        $this->status = "1";
                }
                else
                {
                        $this->status = "0";
                }
        }

Here is the caller graph for this function:

ilObjiLincClassroom::update

(

$a_data = ""

)

update object data

public

Returns

boolean

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

References $data, $result, ilObject\getDescription(), getDocentId(), getStatus(), and ilObject\getTitle().

        {
                $data = array(
                                                "name" => $this->getTitle(),
                                                "description" => $this->getDescription(), 
                                                "instructoruserid" => $this->getDocentId(), 
                                                "alwaysopen" => $this->getStatus()
                                        );
                                
                if (!is_array($a_data))
                {
                        $a_data = array();
                }
                
                $result = array_merge($data,$a_data);

                $this->ilincAPI->editClass($this->id,$result);

                $response = $this->ilincAPI->sendRequest("editClass");

                if ($response->isError())
                {
                        if (!$response->getErrorMsg())
                        {
                                $this->error_msg = "err_edit_classroom";
                        }
                        else
                        {
                                $this->error_msg = $response->getErrorMsg();
                        }
                        
                        return false;
                }
                
                $this->result_msg = $response->getResultMsg();

                return true;
        }

Here is the call graph for this function:

---

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

• Modules/ILinc/classes/class.ilObjiLincClassroom.php