Public Member Functions | Static Public Member Functions

ilObjiLincCourse Class Reference

Inheritance diagram for ilObjiLincCourse:
Collaboration diagram for ilObjiLincCourse:

Public Member Functions

 ilObjiLincCourse ($a_id=0, $a_call_by_reference=true)
 Constructor public.
 read ()
 private
 getiLincId ()
 getErrorMsg ()
 getAKClassValue1 ()
 getAKClassValue2 ()
 setAKClassValue1 ($a_str)
 setAKClassValue2 ($a_str)
 update ()
 update object data
 addCourse ()
 create course on iLinc server
 ilClone ($a_parent_ref)
 copy all entries of your object.
 delete ()
 delete object and all related data
 storeiLincId ($a_icrs_id)
 saveActivationStatus ($a_activated)
 saveAKClassValues ($a_akclassvalue1, $a_akclassvalue2)
 initDefaultRoles ()
 init default roles settings
 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 happend, each object may decide how it reacts.
 addMember (&$a_user_obj, $a_mem_role, $a_instructor=false)
 add Member to iLic course public
 join ($a_user_id, $a_mem_role="")
 join icrs, assigns user to role private
 leave ($a_user_id)
 deassign member from group role private
 getMemberRoles ($a_user_id)
 get group member status public
 getMemberIds ()
 get all group Member ids regardless of role public
 getMemberData ($a_mem_ids, $active=1)
 get all group Members regardless of group role.
 getLocalRoles ($a_translate=false)
 get ALL local roles of group, also those created and defined afterwards only fetch data once from database.
 getMemberRolesTitle ($a_user_id)
 get group member status public
 getDefaultMemberRole ()
 returns object id of created default member role public
 getDefaultAdminRole ()
 returns object id of created default adminstrator role public
 getClassrooms ()
 updateClassrooms ()
 userExists (&$a_user_obj)
 addUser (&$a_user_obj)
 isMember ($a_user_id="")
 isDocent ($a_user_obj="")
 registerUser (&$a_user_obj, $a_instructor=false)
 registerUsers ($a_user_arr)
 unregisterUser ($a_user_obj)
 unregisterUsers ($a_ilinc_user_ids)
 userLogin (&$a_user_obj)
 uploadPicture (&$a_user_obj, $a_lang)
 getAdminIds ($a_grpId="")
 get Group Admin Id public
 removeMember (&$a_user_obj)
 removes Member from group public
 isAdmin ($a_user_id)
 is Admin public
 getDefaultRoles ($a_grp_id="")
 get default group roles, returns the defaultlike create roles il_grp_member, il_grp_admin public
 getiLincMemberIds ($a_instructorflag=false)
 checkiLincMemberStatus ($a_ilinc_user_id, $a_docent_ids, $a_student_ids)
 _isActivated ($a_course_obj_id)
 _getAKClassValues ($a_course_obj_id)
 _isMember ($a_user_id, $a_ref_id)
 __setCourseStatus ()
 _goto ($a_target)

Static Public Member Functions

 _getLinkToObject ($a_id)
 STATIC METHOD create a link to the object.

Detailed Description

Definition at line 38 of file class.ilObjiLincCourse.php.


Member Function Documentation

ilObjiLincCourse::__setCourseStatus (  ) 

Definition at line 1183 of file class.ilObjiLincCourse.php.

Referenced by initDefaultRoles().

        {
                // empty
        }

Here is the caller graph for this function:

ilObjiLincCourse::_getAKClassValues ( a_course_obj_id  ) 

Definition at line 1155 of file class.ilObjiLincCourse.php.

References ilObject::$ilias, $q, and $row.

Referenced by ilObjiLincClassroomGUI::create(), ilObjiLincClassroomGUI::displayEditForm(), ilObjiLincCourseListGUI::getProperties(), and ilObjiLincClassroomGUI::save().

        {
                global $ilDB,$ilias;

                $q = "SELECT akclassvalue1, akclassvalue2 FROM ilinc_data WHERE obj_id=".$ilDB->quote($a_course_obj_id);
                $r = $ilDB->query($q);
                
                $row = $r->fetchRow(DB_FETCHMODE_OBJECT);

                return $akclassvalues = array($row->akclassvalue1,$row->akclassvalue2);
        }

Here is the caller graph for this function:

ilObjiLincCourse::_getLinkToObject ( a_id  )  [static]

STATIC METHOD create a link to the object.

Parameters:
int uniq id
Returns:
array array('link','target') public

Definition at line 1211 of file class.ilObjiLincCourse.php.

        {
                return array("repository.php?ref_id=".$a_id."&set_mode=flat&cmdClass=ilobjilinccoursegui","");
        }

ilObjiLincCourse::_goto ( a_target  ) 

Definition at line 1188 of file class.ilObjiLincCourse.php.

References $_GET, $ilErr, and ilObject::$lng.

        {
                global $ilAccess, $ilErr, $lng;

                if ($ilAccess->checkAccess("read", "", $a_target))
                {
                        $_GET["cmd"] = "frameset";
                        $_GET["ref_id"] = $a_target;
                }
                else
                {
                        $ilErr->raiseError($lng->txt("msg_no_perm_read"), $ilErr->FATAL);
                }
        }

ilObjiLincCourse::_isActivated ( a_course_obj_id  ) 

Definition at line 1138 of file class.ilObjiLincCourse.php.

References ilObject::$ilias, $q, $row, and ilUtil::yn2tf().

Referenced by ilObjiLincCourseAccess::_checkAccess(), and ilObjiLincCourseListGUI::getProperties().

        {
                global $ilDB,$ilias;

                if (!$ilias->getSetting("ilinc_active"))
                {
                        return false;
                }
                
                $q = "SELECT activation_offline FROM ilinc_data WHERE obj_id=".$ilDB->quote($a_course_obj_id);
                $r = $ilDB->query($q);
                
                $row = $r->fetchRow(DB_FETCHMODE_OBJECT);

                return ilUtil::yn2tf($row->activation_offline);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilObjiLincCourse::_isMember ( a_user_id,
a_ref_id 
)

Definition at line 1167 of file class.ilObjiLincCourse.php.

References $rbacreview.

Referenced by ilObjiLincCourseAccess::_checkAccess(), and ilObjiLincClassroomAccess::_checkAccess().

        {
                global $rbacreview;
                
                $rolf = $rbacreview->getRoleFolderOfObject($a_ref_id);
                $local_roles = $rbacreview->getRolesOfRoleFolder($rolf["ref_id"],false);
                $user_roles = $rbacreview->assignedRoles($a_user_id);
                
                if (!array_intersect($local_roles,$user_roles))
                {
                        return false;
                }
                
                return true;
        }

Here is the caller graph for this function:

ilObjiLincCourse::addCourse (  ) 

create course on iLinc server

public

Returns:
boolean

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

References $_POST.

        {
                $this->ilincAPI->addCourse($_POST["Fobject"]);
                $response = $this->ilincAPI->sendRequest();
                
                if ($response->isError())
                {
                        $this->error_msg = $response->getErrorMsg();
                        return false;
                }
                
                $this->ilinc_id = $response->getFirstID();
                
                return true;
        }

ilObjiLincCourse::addMember ( &$  a_user_obj,
a_mem_role,
a_instructor = false 
)

add Member to iLic course public

Parameters:
integer user_id
integer member role_id of local group_role
boolean register member on iLinc server as student(false) or docent(true)

Definition at line 356 of file class.ilObjiLincCourse.php.

References $rbacadmin, addUser(), join(), registerUser(), and userExists().

        {
                global $rbacadmin;
//echo "0";
                if (!isset($a_user_obj) && !isset($a_mem_role))
                {
                        $this->error_msg = get_class($this)."::addMember(): Missing parameters !";
                        return false;
                }
//echo "1";
                // check if user is registered at iLinc server
                if (!$this->userExists($a_user_obj))
                {
                        // if not, add user on iLinc server
                        if ($this->addUser($a_user_obj) == false)
                        {
                                // error_msg already set
                                return false;
                        }
                }
//echo "2";
                // assign membership to icourse on iLinc server
                if (!$this->registerUser($a_user_obj,$a_instructor))
                {
                        // error_msg already set
                        return false;
                }
//echo "3";
                // finally assign user to member role in ILIAS
                $this->join($a_user_obj->getId(),$a_mem_role);
//echo "4";
                return true;
        }

Here is the call graph for this function:

ilObjiLincCourse::addUser ( &$  a_user_obj  ) 

Definition at line 735 of file class.ilObjiLincCourse.php.

Referenced by addMember().

        {
                include_once ('class.ilObjiLincUser.php');
                $ilinc_user = new ilObjiLincUser($a_user_obj);
                
                return $ilinc_user->add();
        }

Here is the caller graph for this function:

ilObjiLincCourse::checkiLincMemberStatus ( a_ilinc_user_id,
a_docent_ids,
a_student_ids 
)

Definition at line 1123 of file class.ilObjiLincCourse.php.

        {
                if (in_array($a_ilinc_user_id,$a_docent_ids))
                {
                        return ILINC_MEMBER_DOCENT;
                }
                
                if (in_array($a_ilinc_user_id,$a_student_ids))
                {
                        return ILINC_MEMBER_STUDENT;
                }
                        
                return ILINC_MEMBER_NOTSET;
        }

ilObjiLincCourse::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 214 of file class.ilObjiLincCourse.php.

References $q, and getiLincId().

        {               
                global $ilDB;

                // always call parent delete function first!!
                if (!parent::delete())
                {
                        return false;
                }
                
                //put here your module specific stuff
                $q = "DELETE FROM ilinc_data WHERE course_id = ".$ilDB->quote($this->getiLincId());
                $ilDB->query($q);
                
                // TODO: delete data in ilinc_registration table
                
                // remove course from ilinc server
                $this->ilincAPI->removeCourse($this->getiLincId());
                $response = $this->ilincAPI->sendRequest();

                return true;
        }

Here is the call graph for this function:

ilObjiLincCourse::getAdminIds ( a_grpId = ""  ) 

get Group Admin Id public

Parameters:
integer group id
returns userids that are assigned to a group administrator! role

Definition at line 959 of file class.ilObjiLincCourse.php.

References $rbacreview, getDefaultRoles(), and ilObject::getRefId().

Referenced by removeMember().

        {
                global $rbacreview;

                if (!empty($a_grpId))
                {
                        $grp_id = $a_grpId;
                }
                else
                {
                        $grp_id = $this->getRefId();
                }

                $usr_arr = array();
                $roles = $this->getDefaultRoles($this->getRefId());

                foreach ($rbacreview->assignedUsers($this->getDefaultAdminRole()) as $member_id)
                {
                        array_push($usr_arr,$member_id);
                }

                return $usr_arr;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilObjiLincCourse::getAKClassValue1 (  ) 

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

        {
                return $this->akclassvalue1;
        }

ilObjiLincCourse::getAKClassValue2 (  ) 

Definition at line 104 of file class.ilObjiLincCourse.php.

        {
                return $this->akclassvalue2;
        }

ilObjiLincCourse::getClassrooms (  ) 

Definition at line 613 of file class.ilObjiLincCourse.php.

References $data, $ilErr, and getiLincId().

        {
                global $ilErr;
                
                if (!$this->ilias->getSetting("ilinc_active"))
                {
                        $this->error_msg = "ilinc_server_not_active";
                        return false;
                }

                $this->ilincAPI->findCourseClasses($this->getiLincId());
                $response = $this->ilincAPI->sendRequest();

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

                if (!$response->data['classes'])
                {

                        $this->error_msg = $response->data['result']['cdata'];
                        return false;
                }

                foreach ($response->data['classes'] as $class_id => $data)
                {
                        $this->ilincAPI->findClass($class_id);
                        $response = $this->ilincAPI->sendRequest("findClass");

                        if ($response->data['classes'])
                        {
                                $full_class_data[$class_id] = $response->data['classes'][$class_id];
                        }
                }
                
                return $full_class_data;
        }

Here is the call graph for this function:

ilObjiLincCourse::getDefaultAdminRole (  ) 

returns object id of created default adminstrator role public

Definition at line 606 of file class.ilObjiLincCourse.php.

References getLocalRoles().

        {
                $local_icrs_Roles = $this->getLocalRoles();

                return $local_icrs_Roles["il_icrs_admin_".$this->getRefId()];
        }

Here is the call graph for this function:

ilObjiLincCourse::getDefaultMemberRole (  ) 

returns object id of created default member role public

Definition at line 595 of file class.ilObjiLincCourse.php.

References getLocalRoles().

        {
                $local_icrs_Roles = $this->getLocalRoles();

                return $local_icrs_Roles["il_icrs_member_".$this->getRefId()];
        }

Here is the call graph for this function:

ilObjiLincCourse::getDefaultRoles ( a_grp_id = ""  ) 

get default group roles, returns the defaultlike create roles il_grp_member, il_grp_admin public

Parameters:
returns the obj_ids of group specific roles(il_grp_member,il_grp_admin)

Definition at line 1048 of file class.ilObjiLincCourse.php.

References $rbacadmin, $rbacreview, $role_id, and ilObject::getRefId().

Referenced by getAdminIds(), and isAdmin().

        {
                global $rbacadmin, $rbacreview;

                if (strlen($a_grp_id) > 0)
                {
                        $grp_id = $a_grp_id;
                }
                else
                {
                        $grp_id = $this->getRefId();
                }

                $rolf      = $rbacreview->getRoleFolderOfObject($grp_id);
                $role_arr  = $rbacreview->getRolesOfRoleFolder($rolf["ref_id"]);

                foreach ($role_arr as $role_id)
                {
                        $role_Obj =& $this->ilias->obj_factory->getInstanceByObjId($role_id);

                        $grp_Member ="il_icrs_member_".$grp_id;
                        $grp_Admin  ="il_icrs_admin_".$grp_id;

                        if (strcmp($role_Obj->getTitle(), $grp_Member) == 0 )
                        {
                                $arr_grpDefaultRoles["icrs_member_role"] = $role_Obj->getId();
                        }

                        if (strcmp($role_Obj->getTitle(), $grp_Admin) == 0)
                        {
                                $arr_grpDefaultRoles["icrs_admin_role"] = $role_Obj->getId();
                        }
                }

                return $arr_grpDefaultRoles;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilObjiLincCourse::getErrorMsg (  ) 

Definition at line 91 of file class.ilObjiLincCourse.php.

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

                return $err_msg;
        }

ilObjiLincCourse::getiLincId (  ) 

Definition at line 86 of file class.ilObjiLincCourse.php.

Referenced by delete(), getClassrooms(), getiLincMemberIds(), registerUser(), registerUsers(), unregisterUser(), unregisterUsers(), update(), and updateClassrooms().

        {
                return $this->ilinc_id;
        }

Here is the caller graph for this function:

ilObjiLincCourse::getiLincMemberIds ( a_instructorflag = false  ) 

Definition at line 1086 of file class.ilObjiLincCourse.php.

References getiLincId().

Referenced by isDocent().

        {
                if ($a_instructorflag == true)
                {
                        if (!empty($this->docent_ids))
                        {
                                return $this->docent_ids;
                        }
                }
                else
                {
                        if (!empty($this->student_ids))
                        {
                                return $this->student_ids;
                        }
                }
                
                $this->ilincAPI->findRegisteredUsersByRole($this->getiLincId(),$a_instructorflag);
                $response = $this->ilincAPI->sendRequest();
                        
                if (is_array($response->data['users']))
                {
                        if ($a_instructorflag == true)
                        {
                                $this->docent_ids = array_keys($response->data['users']);
                        }
                        else
                        {
                                $this->student_ids = array_keys($response->data['users']);
                        }

                        return array_keys($response->data['users']);
                }
                
                return array();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilObjiLincCourse::getLocalRoles ( a_translate = false  ) 

get ALL local roles of group, also those created and defined afterwards only fetch data once from database.

info is stored in object variable public

Returns:
return array [title|id] of roles...

Definition at line 526 of file class.ilObjiLincCourse.php.

References $rbacadmin, $rbacreview, $role_id, ilObjRole::_getTranslation(), and ilObject::getRefId().

Referenced by getDefaultAdminRole(), getDefaultMemberRole(), getMemberIds(), getMemberRoles(), and getMemberRolesTitle().

        {
                global $rbacadmin,$rbacreview;
                
                if (empty($this->local_roles))
                {
                        $this->local_roles = array();
                        $rolf      = $rbacreview->getRoleFolderOfObject($this->getRefId());
                        $role_arr  = $rbacreview->getRolesOfRoleFolder($rolf["ref_id"]);

                        foreach ($role_arr as $role_id)
                        {
                                if ($rbacreview->isAssignable($role_id,$rolf["ref_id"]) == true)
                                {
                                        $role_Obj =& $this->ilias->obj_factory->getInstanceByObjId($role_id);
                                        
                                        if ($a_translate)
                                        {
                                                $role_name = ilObjRole::_getTranslation($role_Obj->getTitle());
                                        }
                                        else
                                        {
                                                $role_name = $role_Obj->getTitle();
                                        }
                                        
                                        $this->local_roles[$role_name] = $role_Obj->getId();
                                }
                        }
                }
                
                return $this->local_roles;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilObjiLincCourse::getMemberData ( a_mem_ids,
active = 1 
)

get all group Members regardless of group role.

fetch all users data in one shot to improve performance public

Parameters:
array of user ids
Returns:
return array of userdata

Definition at line 492 of file class.ilObjiLincCourse.php.

References $ilBench, $q, $rbacadmin, $rbacreview, and $row.

        {
                global $rbacadmin, $rbacreview, $ilBench, $ilDB;

                $usr_arr= array();
                
                $q = "SELECT login,firstname,lastname,title,usr_id,ilinc_id ".
                         "FROM usr_data ".
                         "WHERE usr_id IN (".implode(',',$a_mem_ids).")";
                         
                if (is_numeric($active) && $active > -1)
                        $q .= "AND active = ".$ilDB->quote($active);                     
                
                $r = $ilDB->query($q);
                
                while($row = $r->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $mem_arr[] = array("id" => $row->usr_id,
                                                                "login" => $row->login,
                                                                "firstname" => $row->firstname,
                                                                "lastname" => $row->lastname,
                                                                "ilinc_id" => $row->ilinc_id
                                                                );
                }

                return $mem_arr ? $mem_arr : array();
        }

ilObjiLincCourse::getMemberIds (  ) 

get all group Member ids regardless of role public

Returns:
return array of users (obj_ids) that are assigned to the groupspecific roles (grp_member,grp_admin)

Definition at line 464 of file class.ilObjiLincCourse.php.

References $rbacadmin, $rbacreview, and getLocalRoles().

Referenced by isMember(), and removeMember().

        {
                global $rbacadmin, $rbacreview;

                $usr_arr= array();

                $rol  = $this->getLocalRoles();

                foreach ($rol as $value)
                {
                        foreach ($rbacreview->assignedUsers($value) as $member_id)
                        {
                                array_push($usr_arr,$member_id);
                        }
                }

                $mem_arr = array_unique($usr_arr);
                
                return $mem_arr ? $mem_arr : array();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilObjiLincCourse::getMemberRoles ( a_user_id  ) 

get group member status public

Parameters:
integer user_id
Returns:
returns array of obj_ids of assigned local roles

Definition at line 447 of file class.ilObjiLincCourse.php.

References $rbacadmin, $rbacreview, and getLocalRoles().

Referenced by leave().

        {
                global $rbacadmin, $rbacreview;

                $arr_assignedRoles = array();

                $arr_assignedRoles = array_intersect($rbacreview->assignedRoles($a_user_id),$this->getLocalRoles());

                return $arr_assignedRoles;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilObjiLincCourse::getMemberRolesTitle ( a_user_id  ) 

get group member status public

Parameters:
integer user_id
Returns:
returns string of role titles

Definition at line 565 of file class.ilObjiLincCourse.php.

References $ilBench, $q, $row, ilObjRole::_getTranslation(), and getLocalRoles().

        {
                global $ilDB,$ilBench;
                
                include_once ('classes/class.ilObjRole.php');

                $str_member_roles ="";

                $q = "SELECT title ".
                         "FROM object_data ".
                         "LEFT JOIN rbac_ua ON object_data.obj_id=rbac_ua.rol_id ".
                         "WHERE object_data.type = 'role' ".
                         "AND rbac_ua.usr_id = ".$ilDB->quote($a_user_id)." ".
                         "AND rbac_ua.rol_id IN (".implode(',',$this->getLocalRoles()).")";

                $r = $ilDB->query($q);

                while($row = $r->fetchRow(DB_FETCHMODE_ASSOC))
                {
                        // display human readable role names for autogenerated roles
                        $str_member_roles .= ilObjRole::_getTranslation($row["title"]).", ";
                }

                return substr($str_member_roles,0,-2);
        }

Here is the call graph for this function:

ilObjiLincCourse::ilClone ( a_parent_ref  ) 

copy all entries of your object.

public

Parameters:
integer ref_id of parent object
Returns:
integer new ref id

Reimplemented from ilObject.

Definition at line 185 of file class.ilObjiLincCourse.php.

References $rbacadmin.

        {               
                global $rbacadmin;

                // always call parent clone function first!!
                $new_ref_id = parent::ilClone($a_parent_ref);
                
                // get object instance of cloned object
                //$newObj =& $this->ilias->obj_factory->getInstanceByRefId($new_ref_id);

                // create a local role folder & default roles
                //$roles = $newObj->initDefaultRoles();

                // ...finally assign role to creator of object
                //$rbacadmin->assignUser($roles[0], $newObj->getOwner(), "n");          

                // always destroy objects in clone method because clone() is recursive and creates instances for each object in subtree!
                //unset($newObj);

                // ... and finally always return new reference ID!!
                return $new_ref_id;
        }

ilObjiLincCourse::ilObjiLincCourse ( a_id = 0,
a_call_by_reference = true 
)

Constructor public.

Parameters:
integer reference_id or object_id
boolean treat the id as reference_id (true) or object_id (false)

Definition at line 46 of file class.ilObjiLincCourse.php.

References ilObject::ilObject(), and ilObject::setRegisterMode().

        {
                $this->type = "icrs";
                $this->ilObject($a_id,$a_call_by_reference);
                $this->setRegisterMode(false);
                $this->ilincAPI = new ilnetucateXMLAPI();
                
                $this->docent_ids = array();
                $this->student_ids = array();
        }

Here is the call graph for this function:

ilObjiLincCourse::initDefaultRoles (  ) 

init default roles settings

public

Returns:
array object IDs of created local roles.

Reimplemented from ilObject.

Definition at line 275 of file class.ilObjiLincCourse.php.

References $ops, $q, $rbacadmin, $rbacreview, __setCourseStatus(), ilObject::createRoleFolder(), ilObject::getId(), and ilObject::getRefId().

        {
                global $rbacadmin, $rbacreview;

                // create a local role folder
                $rfoldObj =& $this->createRoleFolder();

                // ADMIN ROLE
                // create role and assign role to rolefolder...
                $roleObj = $rfoldObj->createRole("il_icrs_admin_".$this->getRefId(),"LearnLinc admin of seminar obj_no.".$this->getId());
                $this->m_roleAdminId = $roleObj->getId();

                //set permission template of new local role
                $q = "SELECT obj_id FROM object_data WHERE type='rolt' AND title='il_icrs_admin'";
                $r = $this->ilias->db->getRow($q, DB_FETCHMODE_OBJECT);
                $rbacadmin->copyRolePermission($r->obj_id,ROLE_FOLDER_ID,$rfoldObj->getRefId(),$roleObj->getId());

                // set object permissions of icrs object
                $ops = $rbacreview->getOperationsOfRole($roleObj->getId(),"icrs",$rfoldObj->getRefId());
                $rbacadmin->grantPermission($roleObj->getId(),$ops,$this->getRefId());

                // set object permissions of role folder object
                //$ops = $rbacreview->getOperationsOfRole($roleObj->getId(),"rolf",$rfoldObj->getRefId());
                //$rbacadmin->grantPermission($roleObj->getId(),$ops,$rfoldObj->getRefId());

                // MEMBER ROLE
                // create role and assign role to rolefolder...
                $roleObj = $rfoldObj->createRole("il_icrs_member_".$this->getRefId(),"LearnLinc admin of seminar obj_no.".$this->getId());
                $this->m_roleMemberId = $roleObj->getId();

                //set permission template of new local role
                $q = "SELECT obj_id FROM object_data WHERE type='rolt' AND title='il_icrs_member'";
                $r = $this->ilias->db->getRow($q, DB_FETCHMODE_OBJECT);
                $rbacadmin->copyRolePermission($r->obj_id,ROLE_FOLDER_ID,$rfoldObj->getRefId(),$roleObj->getId());
                
                // set object permissions of icrs object
                $ops = $rbacreview->getOperationsOfRole($roleObj->getId(),"icrs",$rfoldObj->getRefId());
                $rbacadmin->grantPermission($roleObj->getId(),$ops,$this->getRefId());

                // set object permissions of role folder object
                //$ops = $rbacreview->getOperationsOfRole($roleObj->getId(),"rolf",$rfoldObj->getRefId());
                //$rbacadmin->grantPermission($roleObj->getId(),$ops,$rfoldObj->getRefId());

                unset($rfoldObj);
                unset($roleObj);

                $roles[] = $this->m_roleAdminId;
                $roles[] = $this->m_roleMemberId;
                
                // Break inheritance and initialize permission settings using intersection method with a non_member_template 
                // not implemented for ilinc. maybe never will...
                $this->__setCourseStatus();
                
                return $roles ? $roles : array();
        }

Here is the call graph for this function:

ilObjiLincCourse::isAdmin ( a_user_id  ) 

is Admin public

Parameters:
integer user_id
boolean,true if user is group administrator

Definition at line 1027 of file class.ilObjiLincCourse.php.

References $rbacreview, and getDefaultRoles().

Referenced by removeMember().

        {
                global $rbacreview;

                $icrs_roles = $this->getDefaultRoles();

                if (in_array($a_user_id,$rbacreview->assignedUsers($icrs_roles["icrs_admin_role"])))
                {
                        return true;
                }
                else
                {
                        return false;
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilObjiLincCourse::isDocent ( a_user_obj = ""  ) 

Definition at line 760 of file class.ilObjiLincCourse.php.

References getiLincMemberIds().

        {
                if (!$a_user_obj)
                {
                        $a_user_obj =& $this->ilias->account;
                }
                
                $docents = $this->getiLincMemberIds(true);
                
                include_once ('class.ilObjiLincUser.php');
                $ilinc_user = new ilObjiLincUser($a_user_obj);
                
                if (in_array($ilinc_user->id,$docents))
                {
                        return true;
                }
                
                return false;
        }

Here is the call graph for this function:

ilObjiLincCourse::isMember ( a_user_id = ""  ) 

Definition at line 743 of file class.ilObjiLincCourse.php.

References getMemberIds().

Referenced by removeMember().

        {
                if (strlen($a_user_id) == 0)
                {
                        $a_user_id = $this->ilias->account->getId();
                }

                $arr_members = $this->getMemberIds();

                if (in_array($a_user_id, $arr_members))
                {
                        return true;
                }
                
                return false;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilObjiLincCourse::join ( a_user_id,
a_mem_role = "" 
)

join icrs, assigns user to role private

Parameters:
integer member status = obj_id of local_group_role

Definition at line 395 of file class.ilObjiLincCourse.php.

References $rbacadmin, and ilObjUser::updateActiveRoles().

Referenced by addMember().

        {
                global $rbacadmin;

                if (is_array($a_mem_role))
                {
                        foreach ($a_mem_role as $role)
                        {
                                $rbacadmin->assignUser($role,$a_user_id, false);
                        }
                }
                else
                {
                        $rbacadmin->assignUser($a_mem_role,$a_user_id, false);
                }

                ilObjUser::updateActiveRoles($a_user_id);
                return true;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilObjiLincCourse::leave ( a_user_id  ) 

deassign member from group role private

Definition at line 419 of file class.ilObjiLincCourse.php.

References $rbacadmin, getMemberRoles(), and ilObjUser::updateActiveRoles().

Referenced by removeMember().

        {
                global $rbacadmin;

                $arr_groupRoles = $this->getMemberRoles($a_user_id);

                if (is_array($arr_groupRoles))
                {
                        foreach ($arr_groupRoles as $groupRole)
                        {
                                $rbacadmin->deassignUser($groupRole, $a_user_id);
                        }
                }
                else
                {
                        $rbacadmin->deassignUser($arr_groupRoles, $a_user_id);
                }

                ilObjUser::updateActiveRoles($a_user_id);
                return true;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilObjiLincCourse::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 happend, each object may decide how it reacts.

If you are not required to handle any events related to your module, just delete this method. (For an example how this method is used, look at ilObjGroup)

public

Parameters:
string event
integer reference id of object where the event occured
array passes optional parameters if required
Returns:
boolean

Reimplemented from ilObject.

Definition at line 344 of file class.ilObjiLincCourse.php.

        {
                return true;
        }

ilObjiLincCourse::read (  ) 

private

Definition at line 61 of file class.ilObjiLincCourse.php.

References $data, $ilErr, $q, and ilUtil::yn2tf().

        {
                global $ilDB, $ilErr;

                parent::read();
                
                $q = "SELECT * FROM ilinc_data ".
                         "WHERE obj_id= ".$ilDB->quote($this->id);
                $r = $ilDB->query($q);

                if ($r->numRows() > 0)
                {
                        $data = $r->fetchRow(DB_FETCHMODE_OBJECT);

                        $this->ilinc_id = $data->course_id;
                        $this->activated = ilUtil::yn2tf($data->activation_offline);
                        $this->akclassvalue1 = $data->akclassvalue1;
                        $this->akclassvalue2 = $data->akclassvalue2;
                }
                else
                {
                         $ilErr->raiseError("<b>Error: There is no dataset with id ".$this->id."!</b><br />class: ".get_class($this)."<br />Script: ".__FILE__."<br />Line: ".__LINE__, $ilErr->FATAL);
                }
        }

Here is the call graph for this function:

ilObjiLincCourse::registerUser ( &$  a_user_obj,
a_instructor = false 
)

Definition at line 780 of file class.ilObjiLincCourse.php.

References $user, and getiLincId().

Referenced by addMember().

        {
                if ($a_instructor === true)
                {
                        $a_instructor = "True";
                }
                else
                {
                        $a_instructor = "False";
                }
                
                include_once ('class.ilObjiLincUser.php');
                $ilinc_user = new ilObjiLincUser($a_user_obj);
                
                $user[] = array('id' => $ilinc_user->id, 'instructor' => $a_instructor);
                $this->ilincAPI->registerUser($this->getiLincId(),$user);
                $response = $this->ilincAPI->sendRequest("registerUser");
                
                if ($response->isError())
                {
                        if (!$response->getErrorMsg())
                        {
                                $this->error_msg = "err_register_user";
                        }
                        else
                        {
                                $this->error_msg = $response->getErrorMsg();
                        }
                        
                        return false;
                }
                
                return true;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilObjiLincCourse::registerUsers ( a_user_arr  ) 

Definition at line 815 of file class.ilObjiLincCourse.php.

References $user_id, and getiLincId().

        {
                foreach ($a_user_arr as $user_id => $instructorflag)
                {
                        $flag = "False";
                        
                        if ($instructorflag == ILINC_MEMBER_DOCENT)
                        {
                                $flag = "True";
                        }
                        
                        $ilinc_users[] = array('id' => $user_id,'instructor' => $flag);
                }
                
                $this->ilincAPI->registerUser($this->getiLincId(),$ilinc_users);
                $response = $this->ilincAPI->sendRequest("registerUser");

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

Here is the call graph for this function:

ilObjiLincCourse::removeMember ( &$  a_user_obj  ) 

removes Member from group public

Definition at line 987 of file class.ilObjiLincCourse.php.

References getAdminIds(), getMemberIds(), isAdmin(), isMember(), leave(), and unregisterUser().

        {
                if (!isset($a_user_obj))
                {
                        $this->error_msg = get_class($this)."::removeMember(): Missing parameters !";
                        return false;
                }
                
                if (!$this->isMember($a_user_obj->getId()))
                {
                        return true;
                }

                if (count($this->getMemberIds()) > 1)
                {
                        if ($this->isAdmin($a_user_obj->getId()) && count($this->getAdminIds()) < 2)
                        {
                                $this->error_msg = "ilinc_err_administrator_required";
                                return false;
                        }
                }
                
                // unregister from course on iLinc server
                if (!$this->unregisterUser($a_user_obj))
                {
                        // error_msg already set
                        return false;
                }

                $this->leave($a_user_obj->getId());

                return true;
        }

Here is the call graph for this function:

ilObjiLincCourse::saveActivationStatus ( a_activated  ) 

Definition at line 249 of file class.ilObjiLincCourse.php.

References $q, and ilObject::getId().

        {
                global $ilDB;

                $q = "UPDATE ilinc_data SET activation_offline = ".$ilDB->quote($a_activated)." WHERE obj_id = ".$ilDB->quote($this->getId());
                $r = $ilDB->query($q);
        }

Here is the call graph for this function:

ilObjiLincCourse::saveAKClassValues ( a_akclassvalue1,
a_akclassvalue2 
)

Definition at line 258 of file class.ilObjiLincCourse.php.

References $q, and ilObject::getId().

        {
                global $ilDB;

                $q = "UPDATE ilinc_data SET ".
                         "akclassvalue1 = ".$ilDB->quote($a_akclassvalue1).", ".
                         "akclassvalue2 = ".$ilDB->quote($a_akclassvalue2)." ".
                         "WHERE obj_id = ".$ilDB->quote($this->getId());
                $r = $ilDB->query($q);
        }

Here is the call graph for this function:

ilObjiLincCourse::setAKClassValue1 ( a_str  ) 

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

        {
                $this->akclassvalue1 = $a_str;
        }

ilObjiLincCourse::setAKClassValue2 ( a_str  ) 

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

        {
                $this->akclassvalue2 = $a_str;
        }

ilObjiLincCourse::storeiLincId ( a_icrs_id  ) 

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

References $q.

        {
                global $ilDB;

                $q = "INSERT INTO ilinc_data (obj_id,type,course_id,activation_offline) VALUES (".$ilDB->quote($this->id).",'icrs',".$ilDB->quote($a_icrs_id).",".$ilDB->quote($this->activated).")";
                $ilDB->query($q);
                
                $this->ilinc_id = $a_icrs_id;
        }

ilObjiLincCourse::unregisterUser ( a_user_obj  ) 

Definition at line 850 of file class.ilObjiLincCourse.php.

References getiLincId().

Referenced by removeMember().

        {
                include_once ('class.ilObjiLincUser.php');
                $ilinc_user = new ilObjiLincUser($a_user_obj);
                
                // do not send request if user is not registered at iLinc server at all
                if ($ilinc_user->id == '0')
                {
                        return true;
                }
                
                $this->ilincAPI->unregisterUser($this->getiLincId(),array($ilinc_user->id));
                $response = $this->ilincAPI->sendRequest();

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

Here is the call graph for this function:

Here is the caller graph for this function:

ilObjiLincCourse::unregisterUsers ( a_ilinc_user_ids  ) 

Definition at line 881 of file class.ilObjiLincCourse.php.

References getiLincId().

        {
                $this->ilincAPI->unregisterUser($this->getiLincId(),$a_ilinc_user_ids);
                $response = $this->ilincAPI->sendRequest();
                
                if ($response->isError())
                {
                        if (!$response->getErrorMsg())
                        {
                                $this->error_msg = "err_unregister_users";
                        }
                        else
                        {
                                $this->error_msg = $response->getErrorMsg();
                        }
                        
                        return false;
                }
                
                return true;
        }

Here is the call graph for this function:

ilObjiLincCourse::update (  ) 

update object data

public

Returns:
boolean

Reimplemented from ilObject.

Definition at line 125 of file class.ilObjiLincCourse.php.

References $_POST, $q, ilObject::getId(), and getiLincId().

        {
                global $ilDB;

                $this->ilincAPI->editCourse($this->getiLincId(),$_POST["Fobject"]);
                $response = $this->ilincAPI->sendRequest();
                
                if ($response->isError())
                {
                        $this->error_msg = $response->getErrorMsg();
                        return false;
                }
                
                // TODO: alter akclassvalues of classes here

                if (!parent::update())
                {                       
                        $this->error_msg = "database_error";
                        return false;
                }
                
                $q = "UPDATE ilinc_data SET ".
                         "activation_offline = ".$ilDB->quote($this->activated).", ".
                         "akclassvalue1 = ".$ilDB->quote($this->akclassvalue1).", ".
                         "akclassvalue2 = ".$ilDB->quote($this->akclassvalue2)." ".
                         "WHERE obj_id = ".$ilDB->quote($this->getId());
                $r = $ilDB->query($q);
                
                return true;
        }

Here is the call graph for this function:

ilObjiLincCourse::updateClassrooms (  ) 

Definition at line 661 of file class.ilObjiLincCourse.php.

References $_POST, $data, $ilErr, and getiLincId().

        {
                global $ilErr;

                $this->ilincAPI->findCourseClasses($this->getiLincId());
                $response = $this->ilincAPI->sendRequest();

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

                if (!$response->data['classes'])
                {

                        $this->error_msg = $response->data['result']['cdata'];
                        return false;
                }
                
                if (array_key_exists('akclassvalue1',$_POST["Fobject"]))
                {
                        $data["akclassvalue1"] = $_POST["Fobject"]["akclassvalue1"];
                }
                
                if (array_key_exists('akclassvalue2',$_POST["Fobject"]))
                {
                        $data["akclassvalue2"] = $_POST["Fobject"]["akclassvalue2"];
                }
                
                foreach ($response->data['classes'] as $class_id => $data2)
                {
                        include_once("class.ilObjiLincClassroom.php");
                        $icla_obj = new ilObjiLincClassroom($class_id,$this->ref_id);
                        
                        if (!$icla_obj->update($data))
                        {
                                $this->error_msg = $icla_obj->getErrorMsg();
                                
                                return false;
                        }
                        
                        unset($icla_obj);
                }
                
                return true;
        }

Here is the call graph for this function:

ilObjiLincCourse::uploadPicture ( &$  a_user_obj,
a_lang 
)

Definition at line 930 of file class.ilObjiLincCourse.php.

        {
                $this->ilincAPI->uploadPicture($a_user_obj,$a_lang);
                $response = $this->ilincAPI->sendRequest("uploadPicture");

                if ($response->isError())
                {
                        if (!$response->getErrorMsg())
                        {
                                $this->error_msg = "err_upload_picture";
                        }
                        else
                        {
                                $this->error_msg = $response->getErrorMsg();
                        }
                        
                        return false;
                }
                
                // return URL to user's personal page
                return $response->data['url']['cdata'];
        }

ilObjiLincCourse::userExists ( &$  a_user_obj  ) 

Definition at line 719 of file class.ilObjiLincCourse.php.

Referenced by addMember().

        {
                //$data = $a_user_obj->getiLincData();

                include_once ('class.ilObjiLincUser.php');
                $ilinc_user = new ilObjiLincUser($a_user_obj);
                
                if (!$ilinc_user->id and !$ilinc_user->login)
                {
                        return false;
                }
                
                return true;
        }

Here is the caller graph for this function:

ilObjiLincCourse::userLogin ( &$  a_user_obj  ) 

Definition at line 903 of file class.ilObjiLincCourse.php.

        {
                include_once ('class.ilObjiLincUser.php');
                $ilinc_user = new ilObjiLincUser($a_user_obj);
                
                $this->ilincAPI->userLogin($ilinc_user);
                $response = $this->ilincAPI->sendRequest("userLogin");

                if ($response->isError())
                {
                        if (!$response->getErrorMsg())
                        {
                                $this->error_msg = "err_user_login";
                        }
                        else
                        {
                                $this->error_msg = $response->getErrorMsg();
                        }
                        
                        return false;
                }
                
                // return URL to join class room
                return $response->data['url']['cdata'];
        }


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