chamilo / chamilo-lms

app/Migrations/AbstractMigrationChamilo.php

Doc Comments +1 added lines, -1 removed lines

@@ -124,7 +124,7 @@
     }
 
     /**
-     * @param $variable
+     * @param string $variable
      * @return mixed
      */
     public function getConfigurationValue($variable)

main/admin/group_list.php

Doc Comments +1 added lines, -2 removed lines

@@ -204,7 +204,6 @@ 
  * lock = the user can no longer use this account
  * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
  * @param int $active the current state of the account
- * @param int $user_id The user id
  * @param string $url_params
  * @return string Some HTML-code with the lock/unlock button
  */
@@ -236,7 +235,7 @@ 
  * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
  * @param int $status, do we want to lock the user ($status=lock) or unlock it ($status=unlock)
  * @param int $user_id The user id
- * @return language variable
+ * @return string|null variable
  */
 function lock_unlock_user($status, $user_id) {
     $user_table = Database :: get_main_table(TABLE_MAIN_USER);

Indentation -1 removed lines

@@ -16,7 +16,6 @@
  * @author Patrick Cool
  * @author René Haentjens, added CSV file import (October 2004)
  * @package chamilo.link
-
  */
 
 // Including libraries

main/admin/settings.lib.php

Doc Comments +3 added lines, -3 removed lines

@@ -907,7 +907,7 @@ 
  * display the edit and delete icons in the sortable table
  *
  * @param integer $id the id of the template
- * @return html code for the link to edit and delete the template
+ * @return string code for the link to edit and delete the template
  *
  * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University, Belgium
  * @version August 2008
@@ -923,7 +923,7 @@ 
  * Display the image of the template in the sortable table
  *
  * @param string $image the image
- * @return html code for the image
+ * @return string code for the image
  *
  * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University, Belgium
  * @version August 2008
@@ -1120,7 +1120,7 @@ 
 /**
  * Returns an array containing the list of options used to populate the gradebook_number_decimals variable
  * This function is called through a call_user_func() in the generate_settings_form function.
- * @return array List of gradebook_number_decimals options
+ * @return string[] List of gradebook_number_decimals options
  *
  * @author Guillaume Viguier <guillaume.viguier@beeznest.com>
  */

main/admin/sub_language_add.php

Doc Comments +1 added lines, -1 removed lines

@@ -28,7 +28,7 @@
  * @param   string  ISO code (fr_FR, ...)
  * @param   int     Whether the sublanguage is published (0=unpublished, 1=published)
  * @param   int     ID del idioma padre
- * @return  int     New sub language ID or false on error
+ * @return  false|string     New sub language ID or false on error
  */
 function add_sub_language ($original_name,$english_name,$isocode,$sublanguage_available,$parent_id) {
     $tbl_admin_languages    = Database :: get_main_table(TABLE_MAIN_LANGUAGE);

Indentation +144 added lines, -144 removed lines

@@ -62,43 +62,43 @@ 
  *       inside the add_sub_language function.
  */
 function check_if_language_exist ($original_name, $english_name, $isocode, $sublanguage_available) {
-	$tbl_admin_languages 	= Database :: get_main_table(TABLE_MAIN_LANGUAGE);
-	$sql_original_name='SELECT count(*) AS count_original_name FROM '.$tbl_admin_languages.' WHERE original_name="'.Database::escape_string($original_name).'" ';
-	$sql_english_name='SELECT count(*) AS count_english_name FROM '.$tbl_admin_languages.' WHERE english_name="'.Database::escape_string($english_name).'" ';
-	//$sql_isocode='SELECT count(*) AS count_isocode FROM '.$tbl_admin_languages.' WHERE isocode="'.Database::escape_string($isocode).'" ';
-	$rs_original_name=Database::query($sql_original_name);
-	$rs_english_name=Database::query($sql_english_name);
-	//$rs_isocode=Database::query($sql_isocode);
-	$count_original_name=Database::result($rs_original_name,0,'count_original_name');
-	$count_english_name=Database::result($rs_english_name,0,'count_english_name');
-	//$count_isocode=Database::result($rs_isocode,0,'count_isocode');
-	$has_error=false;
-	$message_information=array();
+    $tbl_admin_languages 	= Database :: get_main_table(TABLE_MAIN_LANGUAGE);
+    $sql_original_name='SELECT count(*) AS count_original_name FROM '.$tbl_admin_languages.' WHERE original_name="'.Database::escape_string($original_name).'" ';
+    $sql_english_name='SELECT count(*) AS count_english_name FROM '.$tbl_admin_languages.' WHERE english_name="'.Database::escape_string($english_name).'" ';
+    //$sql_isocode='SELECT count(*) AS count_isocode FROM '.$tbl_admin_languages.' WHERE isocode="'.Database::escape_string($isocode).'" ';
+    $rs_original_name=Database::query($sql_original_name);
+    $rs_english_name=Database::query($sql_english_name);
+    //$rs_isocode=Database::query($sql_isocode);
+    $count_original_name=Database::result($rs_original_name,0,'count_original_name');
+    $count_english_name=Database::result($rs_english_name,0,'count_english_name');
+    //$count_isocode=Database::result($rs_isocode,0,'count_isocode');
+    $has_error=false;
+    $message_information=array();
 
-	if ($count_original_name==1) {
-		$has_error=true;
-		$message_information['original_name']=true;
-	}
-	if ($count_english_name==1) {
-		$has_error=true;
-		$message_information['english_name']=true;
-	}
+    if ($count_original_name==1) {
+        $has_error=true;
+        $message_information['original_name']=true;
+    }
+    if ($count_english_name==1) {
+        $has_error=true;
+        $message_information['english_name']=true;
+    }
 
-	$iso_list = api_get_platform_isocodes();
-	$iso_list = array_values($iso_list);
+    $iso_list = api_get_platform_isocodes();
+    $iso_list = array_values($iso_list);
 
-	if (!in_array($isocode, $iso_list)) {
-		$has_error=true;
-		$message_information['isocode']=true;
-	}
-	if ($has_error===true) {
-		$message_information['execute_add']=false;
-	}
-	if ($has_error===false) {
-		$message_information['execute_add']=true;
-	}
+    if (!in_array($isocode, $iso_list)) {
+        $has_error=true;
+        $message_information['isocode']=true;
+    }
+    if ($has_error===true) {
+        $message_information['execute_add']=false;
+    }
+    if ($has_error===false) {
+        $message_information['execute_add']=true;
+    }
 
-	return $message_information;
+    return $message_information;
 }
 
 /**
@@ -109,50 +109,50 @@ 
  * @todo    deprecate this function and use the static method directly
  */
 function check_if_exist_language_by_id ($language_id) {
-	return SubLanguageManager::check_if_exist_language_by_id($language_id);
+    return SubLanguageManager::check_if_exist_language_by_id($language_id);
 }
 /**
- * Check if the given language is a parent of any sub-language
- * @param   int     Language ID of the presumed parent
- * @return  bool    True if this language has children, false otherwise
- */
+     * Check if the given language is a parent of any sub-language
+     * @param   int     Language ID of the presumed parent
+     * @return  bool    True if this language has children, false otherwise
+     */
 function ckeck_if_is_parent_of_sub_language ($parent_id) {
-	$sql='SELECT count(*) AS count FROM language WHERE parent_id= '.intval($parent_id).'';
-	$rs=Database::query($sql);
-	if (Database::num_rows($rs)>0 && Database::result($rs,0,'count')==1) {
-		return true;
-	} else {
-		return false;
-	}
+    $sql='SELECT count(*) AS count FROM language WHERE parent_id= '.intval($parent_id).'';
+    $rs=Database::query($sql);
+    if (Database::num_rows($rs)>0 && Database::result($rs,0,'count')==1) {
+        return true;
+    } else {
+        return false;
+    }
 }
 /**
- * Get all information of sub-language
- * @param   int     Parent language ID
- * @param   int     Child language ID
- * @return  array
- */
+     * Get all information of sub-language
+     * @param   int     Parent language ID
+     * @param   int     Child language ID
+     * @return  array
+     */
 function allow_get_all_information_of_sub_language ($parent_id,$sub_language_id) {
-	return SubLanguageManager::get_all_information_of_sub_language($parent_id,$sub_language_id);
+    return SubLanguageManager::get_all_information_of_sub_language($parent_id,$sub_language_id);
 }
 /*end declare functions*/
 
 //add data
 
 if (isset($_GET['sub_language_id']) && $_GET['sub_language_id']==strval(intval($_GET['sub_language_id']))) {
-	$language_name=SubLanguageManager::get_name_of_language_by_id($_GET['sub_language_id']);
-		if (check_if_exist_language_by_id ($_GET['sub_language_id'])===true) {
-			$sub_language_id=$_GET['sub_language_id'];
-			$sub_language_id_exist=true;
-		} else {
-			$sub_language_id_exist=false;
-		}
+    $language_name=SubLanguageManager::get_name_of_language_by_id($_GET['sub_language_id']);
+        if (check_if_exist_language_by_id ($_GET['sub_language_id'])===true) {
+            $sub_language_id=$_GET['sub_language_id'];
+            $sub_language_id_exist=true;
+        } else {
+            $sub_language_id_exist=false;
+        }
 
 }
 $language_details = array();
 $language_name='';
 if (isset($_GET['id']) && $_GET['id']==strval(intval($_GET['id']))) {
         $language_details = SubLanguageManager::get_all_information_of_language($_GET['id']);
-	$language_name = $language_details['original_name'];
+    $language_name = $language_details['original_name'];
         if (check_if_exist_language_by_id ($_GET['id'])===true) {
             $parent_id=$_GET['id'];
             $language_id_exist=true;
@@ -160,67 +160,67 @@ 
             $language_id_exist=false;
         }
 } else {
-	$language_id_exist=false;
+    $language_id_exist=false;
 }
 
 //removed and register
 
 if ((isset($_GET['id']) && $_GET['id']==strval(intval($_GET['id']))) && (isset($_GET['sub_language_id']) && $_GET['sub_language_id']==strval(intval($_GET['sub_language_id'])))) {
-	if (check_if_exist_language_by_id($_GET['id'])===true && check_if_exist_language_by_id($_GET['sub_language_id'])===true) {
-	 	$get_all_information=allow_get_all_information_of_sub_language ($_GET['id'],$_GET['sub_language_id']);
-		$original_name=$get_all_information['original_name'];
-		$english_name=$get_all_information['english_name'];
-		$isocode=$get_all_information['isocode'];
+    if (check_if_exist_language_by_id($_GET['id'])===true && check_if_exist_language_by_id($_GET['sub_language_id'])===true) {
+            $get_all_information=allow_get_all_information_of_sub_language ($_GET['id'],$_GET['sub_language_id']);
+        $original_name=$get_all_information['original_name'];
+        $english_name=$get_all_information['english_name'];
+        $isocode=$get_all_information['isocode'];
 
-	}
+    }
 }
 
 $language_name=get_lang('CreateSubLanguageForLanguage').' ( '.strtolower($language_name).' )';
 
 if (ckeck_if_is_parent_of_sub_language($parent_id)===true && isset($_GET['action']) && $_GET['action']=='deletesublanguage') {
-	$language_name=get_lang('DeleteSubLanguage');
+    $language_name=get_lang('DeleteSubLanguage');
 }
 
 $msg = '';
 
 if (isset($_POST['SubmitAddNewLanguage'])) {
-	$original_name=$_POST['original_name'];
-	$english_name=$_POST['english_name'];
-	$isocode=$_POST['isocode'];
-	$english_name=str_replace(' ','_',$english_name);
-	$isocode=str_replace(' ','_',$isocode);
+    $original_name=$_POST['original_name'];
+    $english_name=$_POST['english_name'];
+    $isocode=$_POST['isocode'];
+    $english_name=str_replace(' ','_',$english_name);
+    $isocode=str_replace(' ','_',$isocode);
 
-	$sublanguage_available=$_POST['sub_language_is_visible'];
-	$check_information=array();
-	$check_information=check_if_language_exist($original_name,$english_name,$isocode,$sublanguage_available);
-	foreach ($check_information as $index_information => $value_information) {
-		$allow_insert_info=false;
-		if ($index_information=='original_name') {
-			$msg .= Display::return_message(get_lang('AlreadyExists').' "'.get_lang('OriginalName').'" '.'('.$original_name.')','error');
-		}
-		if ($index_information=='english_name') {
-			$msg .= Display::return_message(get_lang('AlreadyExists').' "'.get_lang('EnglishName').'" '.'('.$english_name.')','error');
-		}
-		if ($index_information=='isocode') {
-			$msg .= Display::return_message(get_lang('CodeDoesNotExists').': '.$isocode.'','error');
-		}
-		if ($index_information=='execute_add' && $value_information===true) {
-			$allow_insert_info=true;
-		}
-	}
+    $sublanguage_available=$_POST['sub_language_is_visible'];
+    $check_information=array();
+    $check_information=check_if_language_exist($original_name,$english_name,$isocode,$sublanguage_available);
+    foreach ($check_information as $index_information => $value_information) {
+        $allow_insert_info=false;
+        if ($index_information=='original_name') {
+            $msg .= Display::return_message(get_lang('AlreadyExists').' "'.get_lang('OriginalName').'" '.'('.$original_name.')','error');
+        }
+        if ($index_information=='english_name') {
+            $msg .= Display::return_message(get_lang('AlreadyExists').' "'.get_lang('EnglishName').'" '.'('.$english_name.')','error');
+        }
+        if ($index_information=='isocode') {
+            $msg .= Display::return_message(get_lang('CodeDoesNotExists').': '.$isocode.'','error');
+        }
+        if ($index_information=='execute_add' && $value_information===true) {
+            $allow_insert_info=true;
+        }
+    }
 
-	if (strlen($original_name)>0 && strlen($english_name)>0 && strlen($isocode)>0) {
-		if ($allow_insert_info===true && $language_id_exist===true) {
-			$english_name=str_replace(' ','_',$english_name);
+    if (strlen($original_name)>0 && strlen($english_name)>0 && strlen($isocode)>0) {
+        if ($allow_insert_info===true && $language_id_exist===true) {
+            $english_name=str_replace(' ','_',$english_name);
                         //Fixes BT#1636
                         $english_name=api_strtolower($english_name);
 
-			$isocode=str_replace(' ','_',$isocode);
-			$str_info='<br/>'.get_lang('OriginalName').' : '.$original_name.'<br/>'.get_lang('EnglishName').' : '.$english_name.'<br/>'.get_lang('PlatformCharsetTitle').' : '.$isocode;
+            $isocode=str_replace(' ','_',$isocode);
+            $str_info='<br/>'.get_lang('OriginalName').' : '.$original_name.'<br/>'.get_lang('EnglishName').' : '.$english_name.'<br/>'.get_lang('PlatformCharsetTitle').' : '.$isocode;
 
-			$mkdir_result=SubLanguageManager::add_language_directory($english_name);
-			if ($mkdir_result) {
-			  	$sl_id = add_sub_language($original_name,$english_name,$isocode,$sublanguage_available,$parent_id);
+            $mkdir_result=SubLanguageManager::add_language_directory($english_name);
+            if ($mkdir_result) {
+                    $sl_id = add_sub_language($original_name,$english_name,$isocode,$sublanguage_available,$parent_id);
                                 if ($sl_id === false) {
                                     SubLanguageManager::remove_language_directory($english_name);
                                     $msg .= Display::return_message(get_lang('LanguageDirectoryNotWriteableContactAdmin'),'error');
@@ -232,17 +232,17 @@ 
                                     require 'sub_language.php';
                                     exit();
                                 }
-			} else {
-			    $msg .= Display::return_message(get_lang('LanguageDirectoryNotWriteableContactAdmin'),'error');
-			}
-		} else {
-			if ($language_id_exist===false) {
-				$msg .= Display::return_message(get_lang('LanguageParentNotExist'),'error');
-			}
-		}
-	} else {
+            } else {
+                $msg .= Display::return_message(get_lang('LanguageDirectoryNotWriteableContactAdmin'),'error');
+            }
+        } else {
+            if ($language_id_exist===false) {
+                $msg .= Display::return_message(get_lang('LanguageParentNotExist'),'error');
+            }
+        }
+    } else {
             $msg .= Display::return_message(get_lang('FormHasErrorsPleaseComplete'),'error');
-	}
+    }
 }
 
 Display :: display_header($language_name);
@@ -250,51 +250,51 @@ 
 echo $msg;
 
 if (isset($_POST['SubmitAddDeleteLanguage'])) {
-	$rs = SubLanguageManager::remove_sub_language($_GET['id'], $_GET['sub_language_id']);
-	if ($rs===true) {
-		Display::display_confirmation_message(get_lang('TheSubLanguageHasBeenRemoved'));
-	} else {
-		Display::display_error_message(get_lang('TheSubLanguageHasNotBeenRemoved'));
-	}
+    $rs = SubLanguageManager::remove_sub_language($_GET['id'], $_GET['sub_language_id']);
+    if ($rs===true) {
+        Display::display_confirmation_message(get_lang('TheSubLanguageHasBeenRemoved'));
+    } else {
+        Display::display_error_message(get_lang('TheSubLanguageHasNotBeenRemoved'));
+    }
 }
 // ckeck_if_is_parent_of_sub_language($parent_id)===false
 //
 if (isset($_GET['action']) && $_GET['action']=='definenewsublanguage') {
-	$text = $language_name;
-	$form = new FormValidator('addsublanguage', 'post', 'sub_language_add.php?id='.Security::remove_XSS($_GET['id']).'&action=definenewsublanguage');
-	$class='add';
-	$form->addElement('header', '', $text);
-	$form->addElement('text', 'original_name', get_lang('OriginalName'),'class="input_titles"');
-	$form->addRule('original_name', get_lang('ThisFieldIsRequired'), 'required');
-	$form->addElement('text', 'english_name', get_lang('EnglishName'),'class="input_titles"');
-	$form->addRule('english_name', get_lang('ThisFieldIsRequired'), 'required');
-	$form->addElement('text', 'isocode', get_lang('ISOCode'), 'class="input_titles"');
-	$form->addRule('isocode', get_lang('ThisFieldIsRequired'), 'required');
-	$form->addElement('static', null, '&nbsp;', '<i>en, es, fr</i>');
-	$form->addElement('checkbox', 'sub_language_is_visible', '', get_lang('Visibility'));
-	$form->addButtonCreate(get_lang('CreateSubLanguage'), 'SubmitAddNewLanguage');
+    $text = $language_name;
+    $form = new FormValidator('addsublanguage', 'post', 'sub_language_add.php?id='.Security::remove_XSS($_GET['id']).'&action=definenewsublanguage');
+    $class='add';
+    $form->addElement('header', '', $text);
+    $form->addElement('text', 'original_name', get_lang('OriginalName'),'class="input_titles"');
+    $form->addRule('original_name', get_lang('ThisFieldIsRequired'), 'required');
+    $form->addElement('text', 'english_name', get_lang('EnglishName'),'class="input_titles"');
+    $form->addRule('english_name', get_lang('ThisFieldIsRequired'), 'required');
+    $form->addElement('text', 'isocode', get_lang('ISOCode'), 'class="input_titles"');
+    $form->addRule('isocode', get_lang('ThisFieldIsRequired'), 'required');
+    $form->addElement('static', null, '&nbsp;', '<i>en, es, fr</i>');
+    $form->addElement('checkbox', 'sub_language_is_visible', '', get_lang('Visibility'));
+    $form->addButtonCreate(get_lang('CreateSubLanguage'), 'SubmitAddNewLanguage');
         //$values['original_name'] = $language_details['original_name'].'...'; -> cannot be used because of quickform filtering (freeze)
         $values['english_name'] = $language_details['english_name'].'2';
         $values['isocode'] = $language_details['isocode'];
         $form->setDefaults($values);
-	$form->display();
+    $form->display();
 } else {
-	if (isset($_GET['action']) && $_GET['action']=='deletesublanguage') {
-		$text=$language_name;
-		$form = new FormValidator('deletesublanguage', 'post', 'sub_language_add.php?id='.Security::remove_XSS($_GET['id']).'&sub_language_id='.Security::remove_XSS($_GET['sub_language_id']));
-		$class='minus';
-		$form->addElement('header', '', $text);
-		$form->addElement('static', '', get_lang('OriginalName'),$original_name);
-		$form->addElement('static', '', get_lang('EnglishName'),$english_name);
-		$form->addElement('static', '', get_lang('PlatformCharsetTitle'),$isocode);
-		$form->addButtonCreate(get_lang('DeleteSubLanguage'), 'SubmitAddDeleteLanguage');
-		$form->display();
-	}
-	if (isset($_GET['action']) && $_GET['action']=='definenewsublanguage') {
-		Display::display_normal_message(get_lang('TheSubLanguageForThisLanguageHasBeenAdded'));
-	}
+    if (isset($_GET['action']) && $_GET['action']=='deletesublanguage') {
+        $text=$language_name;
+        $form = new FormValidator('deletesublanguage', 'post', 'sub_language_add.php?id='.Security::remove_XSS($_GET['id']).'&sub_language_id='.Security::remove_XSS($_GET['sub_language_id']));
+        $class='minus';
+        $form->addElement('header', '', $text);
+        $form->addElement('static', '', get_lang('OriginalName'),$original_name);
+        $form->addElement('static', '', get_lang('EnglishName'),$english_name);
+        $form->addElement('static', '', get_lang('PlatformCharsetTitle'),$isocode);
+        $form->addButtonCreate(get_lang('DeleteSubLanguage'), 'SubmitAddDeleteLanguage');
+        $form->display();
+    }
+    if (isset($_GET['action']) && $_GET['action']=='definenewsublanguage') {
+        Display::display_normal_message(get_lang('TheSubLanguageForThisLanguageHasBeenAdded'));
+    }
 }
 /**
- * Footer
- */
+     * Footer
+     */
 Display :: display_footer();

main/admin/user_list.php

Doc Comments +1 added lines, -1 removed lines

@@ -286,7 +286,7 @@
 *	This function defines globals.
 *   @param  int     $userId
  *
-*   @return bool    False on failure, redirection on success
+*   @return false|null    False on failure, redirection on success
 *	@author Evie Embrechts
 *   @author Yannick Warnier <yannick.warnier@dokeos.com>
 */

Indentation +131 added lines, -131 removed lines

@@ -239,8 +239,8 @@ 
         if (isset($keywordListValues['keyword_status']) &&
             $keywordListValues['keyword_status'] == PLATFORM_ADMIN
         ) {
-           $query_admin_table = " , $admin_table a ";
-           $keyword_admin = ' AND a.user_id = u.id ';
+            $query_admin_table = " , $admin_table a ";
+            $keyword_admin = ' AND a.user_id = u.id ';
             $keywordListValues['keyword_status'] = '%';
         }
 
@@ -306,13 +306,13 @@ 
     $firstname = $userInfo['firstname'];
     $lastname = $userInfo['lastname'];
 
-	if (api_is_western_name_order()) {
-		$message = sprintf(get_lang('AttemptingToLoginAs'),$firstname,$lastname, $userId);
-	} else {
-		$message = sprintf(get_lang('AttemptingToLoginAs'), $lastname, $firstname, $userId);
-	}
+    if (api_is_western_name_order()) {
+        $message = sprintf(get_lang('AttemptingToLoginAs'),$firstname,$lastname, $userId);
+    } else {
+        $message = sprintf(get_lang('AttemptingToLoginAs'), $lastname, $firstname, $userId);
+    }
 
-	if ($userId) {
+    if ($userId) {
 
         // Logout the current user
         LoginDelete(api_get_user_id());
@@ -347,7 +347,7 @@ 
         Display :: display_footer();
         exit;
 
-	}
+    }
 }
 
 /**
@@ -385,7 +385,7 @@ 
     }*/
 
     if (!in_array($direction, array('ASC','DESC'))) {
-    	$direction = 'ASC';
+        $direction = 'ASC';
     }
     $column = intval($column);
     $from 	= intval($from);
@@ -396,23 +396,23 @@ 
         $sql .= " WHERE u.creator_id = ".api_get_user_id();
     }
 
-	$sql .= " ORDER BY col$column $direction ";
-	$sql .= " LIMIT $from,$number_of_items";
+    $sql .= " ORDER BY col$column $direction ";
+    $sql .= " LIMIT $from,$number_of_items";
 
-	$res = Database::query($sql);
+    $res = Database::query($sql);
 
-	$users = array ();
+    $users = array ();
     $t = time();
-	while ($user = Database::fetch_row($res)) {
-		$userPicture = UserManager::getUserPicture($user[0], USER_IMAGE_SIZE_SMALL);
-		$photo = '<img src="'.$userPicture.'" width="22" height="22" alt="'.api_get_person_name($user[2], $user[3]).'" title="'.api_get_person_name($user[2], $user[3]).'" />';
+    while ($user = Database::fetch_row($res)) {
+        $userPicture = UserManager::getUserPicture($user[0], USER_IMAGE_SIZE_SMALL);
+        $photo = '<img src="'.$userPicture.'" width="22" height="22" alt="'.api_get_person_name($user[2], $user[3]).'" title="'.api_get_person_name($user[2], $user[3]).'" />';
 
         if ($user[7] == 1 && !empty($user[10])) {
             // check expiration date
             $expiration_time = convert_sql_date($user[10]);
             // if expiration date is passed, store a special value for active field
             if ($expiration_time < $t) {
-        	   $user[7] = '-1';
+                $user[7] = '-1';
             }
         }
 
@@ -430,9 +430,9 @@ 
             api_get_local_time($user[9]),
             $user[0]
         );
-	}
+    }
 
-	return $users;
+    return $users;
 }
 
 /**
@@ -441,7 +441,7 @@ 
 * @return string HTML-code with a mailto-link
 */
 function email_filter($email) {
-	return Display :: encrypted_mailto_link($email, $email);
+    return Display :: encrypted_mailto_link($email, $email);
 }
 
 /**
@@ -450,7 +450,7 @@ 
 * @return string HTML-code with a mailto-link
 */
 function user_filter($name, $params, $row) {
-	return '<a href="'.api_get_path(WEB_PATH).'whoisonline.php?origin=user_list&id='.$row[0].'">'.$name.'</a>';
+    return '<a href="'.api_get_path(WEB_PATH).'whoisonline.php?origin=user_list&id='.$row[0].'">'.$name.'</a>';
 }
 
 /**
@@ -461,84 +461,84 @@ 
  * @return string Some HTML-code with modify-buttons
  */
 function modify_filter($user_id, $url_params, $row) {
-	global $charset, $_admins_list;
-	$is_admin   = in_array($user_id,$_admins_list);
-	$statusname = api_get_status_langvars();
-	$user_is_anonymous = false;
+    global $charset, $_admins_list;
+    $is_admin   = in_array($user_id,$_admins_list);
+    $statusname = api_get_status_langvars();
+    $user_is_anonymous = false;
     $current_user_status_label = $row['7'];
 
-	if ($current_user_status_label == $statusname[ANONYMOUS]) {
-		$user_is_anonymous =true;
-	}
-	$result = '';
-	if (!$user_is_anonymous) {
-		$icon = Display::return_icon('course.png', get_lang('Courses'), array('onmouseout' => 'clear_course_list (\'div_'.$user_id.'\')'));
-		$result .= '<a href="javascript:void(0)" onclick="load_course_list(\'div_'.$user_id.'\','.$user_id.')" >
+    if ($current_user_status_label == $statusname[ANONYMOUS]) {
+        $user_is_anonymous =true;
+    }
+    $result = '';
+    if (!$user_is_anonymous) {
+        $icon = Display::return_icon('course.png', get_lang('Courses'), array('onmouseout' => 'clear_course_list (\'div_'.$user_id.'\')'));
+        $result .= '<a href="javascript:void(0)" onclick="load_course_list(\'div_'.$user_id.'\','.$user_id.')" >
 			        '.$icon.'
 					<div class="blackboard_hide" id="div_'.$user_id.'">&nbsp;&nbsp;</div>
 					</a>';
 
         $icon = Display::return_icon('session.png', get_lang('Sessions'), array('onmouseout' => 'clear_session_list (\'div_s_'.$user_id.'\')'));
-		$result .= '<a href="javascript:void(0)" onclick="load_session_list(\'div_s_'.$user_id.'\','.$user_id.')" >
+        $result .= '<a href="javascript:void(0)" onclick="load_session_list(\'div_s_'.$user_id.'\','.$user_id.')" >
 					'.$icon.'
 					<div class="blackboard_hide" id="div_s_'.$user_id.'">&nbsp;&nbsp;</div>
 					</a>';
-	} else {
-		$result .= Display::return_icon('course_na.png',get_lang('Courses')).'&nbsp;&nbsp;';
-		$result .= Display::return_icon('course_na.png',get_lang('Sessions')).'&nbsp;&nbsp;';
-	}
+    } else {
+        $result .= Display::return_icon('course_na.png',get_lang('Courses')).'&nbsp;&nbsp;';
+        $result .= Display::return_icon('course_na.png',get_lang('Sessions')).'&nbsp;&nbsp;';
+    }
 
-	if (api_is_platform_admin()) {
-		if (!$user_is_anonymous) {
-			$result .= '<a href="user_information.php?user_id='.$user_id.'">'.Display::return_icon('synthese_view.gif', get_lang('Info')).'</a>&nbsp;&nbsp;';
-		} else {
-			$result .= Display::return_icon('synthese_view_na.gif', get_lang('Info')).'&nbsp;&nbsp;';
-		}
-	}
+    if (api_is_platform_admin()) {
+        if (!$user_is_anonymous) {
+            $result .= '<a href="user_information.php?user_id='.$user_id.'">'.Display::return_icon('synthese_view.gif', get_lang('Info')).'</a>&nbsp;&nbsp;';
+        } else {
+            $result .= Display::return_icon('synthese_view_na.gif', get_lang('Info')).'&nbsp;&nbsp;';
+        }
+    }
 
     //only allow platform admins to login_as, or session admins only for students (not teachers nor other admins)
     if (api_is_platform_admin() || (api_is_session_admin() && $current_user_status_label == $statusname[STUDENT])) {
-    	if (!$user_is_anonymous) {
+        if (!$user_is_anonymous) {
             if (api_global_admin_can_edit_admin($user_id)) {
                 $result .= '<a href="user_list.php?action=login_as&user_id='.$user_id.'&sec_token='.$_SESSION['sec_token'].'">'.Display::return_icon('login_as.png', get_lang('LoginAs')).'</a>&nbsp;&nbsp;';
             } else {
                 $result .= Display::return_icon('login_as_na.png', get_lang('LoginAs')).'&nbsp;&nbsp;';
             }
-    	} else {
-    		$result .= Display::return_icon('login_as_na.png', get_lang('LoginAs')).'&nbsp;&nbsp;';
-    	}
+        } else {
+            $result .= Display::return_icon('login_as_na.png', get_lang('LoginAs')).'&nbsp;&nbsp;';
+        }
     } else {
-    	$result .= Display::return_icon('login_as_na.png', get_lang('LoginAs')).'&nbsp;&nbsp;';
+        $result .= Display::return_icon('login_as_na.png', get_lang('LoginAs')).'&nbsp;&nbsp;';
     }
 
-	if ($current_user_status_label != $statusname[STUDENT]) {
-		$result .= Display::return_icon('statistics_na.gif', get_lang('Reporting')).'&nbsp;&nbsp;';
-	} else {
-		$result .= '<a href="../mySpace/myStudents.php?student='.$user_id.'">'.Display::return_icon('statistics.gif', get_lang('Reporting')).'</a>&nbsp;&nbsp;';
-	}
+    if ($current_user_status_label != $statusname[STUDENT]) {
+        $result .= Display::return_icon('statistics_na.gif', get_lang('Reporting')).'&nbsp;&nbsp;';
+    } else {
+        $result .= '<a href="../mySpace/myStudents.php?student='.$user_id.'">'.Display::return_icon('statistics.gif', get_lang('Reporting')).'</a>&nbsp;&nbsp;';
+    }
 
-	if (api_is_platform_admin(true)) {
+    if (api_is_platform_admin(true)) {
         $editProfileUrl = Display::getProfileEditionLink($user_id, true);
 
         if (!$user_is_anonymous && api_global_admin_can_edit_admin($user_id, null, true)) {
             $result .= '<a href="' . $editProfileUrl . '">'.Display::return_icon('edit.png', get_lang('Edit'), array(), ICON_SIZE_SMALL).'</a>&nbsp;';
-		} else {
+        } else {
             $result .= Display::return_icon('edit_na.png', get_lang('Edit'), array(), ICON_SIZE_SMALL).'</a>&nbsp;';
-		}
-	}
+        }
+    }
 
-	if ($is_admin) {
-		$result .= Display::return_icon('admin_star.png', get_lang('IsAdministrator'),array('width'=> ICON_SIZE_SMALL, 'heigth'=> ICON_SIZE_SMALL));
-	} else {
-		$result .= Display::return_icon('admin_star_na.png', get_lang('IsNotAdministrator'));
-	}
+    if ($is_admin) {
+        $result .= Display::return_icon('admin_star.png', get_lang('IsAdministrator'),array('width'=> ICON_SIZE_SMALL, 'heigth'=> ICON_SIZE_SMALL));
+    } else {
+        $result .= Display::return_icon('admin_star_na.png', get_lang('IsNotAdministrator'));
+    }
 
-	// actions for assigning sessions, courses or users
-	if (api_is_session_admin()) {
-		/*if ($row[0] == api_get_user_id()) {
+    // actions for assigning sessions, courses or users
+    if (api_is_session_admin()) {
+        /*if ($row[0] == api_get_user_id()) {
 			$result .= '<a href="dashboard_add_sessions_to_user.php?user='.$user_id.'">'.Display::return_icon('view_more_stats.gif', get_lang('AssignSessions')).'</a>&nbsp;&nbsp;';
 		}*/
-	} else {
+    } else {
         if ($current_user_status_label == $statusname[SESSIONADMIN]) {
             $result .= Display::url(
                 Display::return_icon('view_more_stats.gif', get_lang('AssignSessions')),
@@ -568,7 +568,7 @@ 
                 );
             }
         }
-	}
+    }
 
     if (api_is_platform_admin()) {
         $result .= ' <a href="'.api_get_path(WEB_AJAX_PATH).'agenda.ajax.php?a=get_user_agenda&user_id='.$user_id.'&modal_size=lg" class="agenda_opener ajax">'.
@@ -586,7 +586,7 @@ 
             }
         }
     }
-	return $result;
+    return $result;
 }
 
 
@@ -619,10 +619,10 @@ 
     if ($action == 'edit') {
         $result = Display::return_icon($image.'.png', get_lang('AccountExpired'), array(), 16);
     } elseif ($row['0']<>$_user['user_id']) {
-    	// you cannot lock yourself out otherwise you could disable all the accounts including your own => everybody is locked out and nobody can change it anymore.
-		$result = Display::return_icon($image.'.png', get_lang(ucfirst($action)), array('onclick'=>'active_user(this);', 'id'=>'img_'.$row['0']), 16).'</a>';
-	}
-	return $result;
+        // you cannot lock yourself out otherwise you could disable all the accounts including your own => everybody is locked out and nobody can change it anymore.
+        $result = Display::return_icon($image.'.png', get_lang(ucfirst($action)), array('onclick'=>'active_user(this);', 'id'=>'img_'.$row['0']), 16).'</a>';
+    }
+    return $result;
 }
 
 /**
@@ -635,8 +635,8 @@ 
  * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University, Belgium
  */
 function status_filter($status) {
-	$statusname = api_get_status_langvars();
-	return $statusname[$status];
+    $statusname = api_get_status_langvars();
+    return $statusname[$status];
 }
 
 if (isset($_GET['keyword']) || isset($_GET['keyword_firstname'])) {
@@ -652,8 +652,8 @@ 
 
 if (!empty($action)) {
     $check = Security::check_token('get');
-	if ($check) {
-		switch ($action) {
+    if ($check) {
+        switch ($action) {
             case 'add_user_to_my_url':
                 $user_id = $_REQUEST["user_id"];
                 $result = UrlManager::add_user_to_url($user_id, $current_access_url_id);
@@ -663,7 +663,7 @@ 
                     $message  = Display::return_message($message, 'confirmation');
                 }
                 break;
-			case 'show_message' :
+            case 'show_message' :
                 if (!empty($_GET['warn'])) {
                     // to prevent too long messages
                     if ($_GET['warn'] == 'session_message') {
@@ -681,46 +681,46 @@ 
                     $message .= Display::return_message(stripslashes($_GET['message']), 'confirmation');
                 }
 
-				break;
-			case 'delete_user' :
-				if (api_is_platform_admin()) {
+                break;
+            case 'delete_user' :
+                if (api_is_platform_admin()) {
                     $user_to_delete = $_GET['user_id'];
                     $current_user_id = api_get_user_id();
 
-					if ($deleteUserAvailable && api_global_admin_can_edit_admin($_GET['user_id'])) {
-						if ($user_to_delete != $current_user_id && UserManager :: delete_user($_GET['user_id'])) {
-							$message = Display :: return_message(get_lang('UserDeleted'), 'confirmation');
-						} else {
-							$message = Display :: return_message(get_lang('CannotDeleteUserBecauseOwnsCourse'), 'error');
-						}
-					} else {
-						$message = Display :: return_message(get_lang('CannotDeleteUser'),'error');
-					}
-				}
-				break;
+                    if ($deleteUserAvailable && api_global_admin_can_edit_admin($_GET['user_id'])) {
+                        if ($user_to_delete != $current_user_id && UserManager :: delete_user($_GET['user_id'])) {
+                            $message = Display :: return_message(get_lang('UserDeleted'), 'confirmation');
+                        } else {
+                            $message = Display :: return_message(get_lang('CannotDeleteUserBecauseOwnsCourse'), 'error');
+                        }
+                    } else {
+                        $message = Display :: return_message(get_lang('CannotDeleteUser'),'error');
+                    }
+                }
+                break;
             case 'delete' :
-				if (api_is_platform_admin()) {
-					$number_of_selected_users = count($_POST['id']);
-					$number_of_deleted_users = 0;
-					if (is_array($_POST['id'])) {
-						foreach ($_POST['id'] as $index => $user_id) {
-							if($user_id != $_user['user_id']) {
-								if(UserManager :: delete_user($user_id)) {
-									$number_of_deleted_users++;
-								}
-							}
-						}
-					}
-					if ($number_of_selected_users == $number_of_deleted_users) {
+                if (api_is_platform_admin()) {
+                    $number_of_selected_users = count($_POST['id']);
+                    $number_of_deleted_users = 0;
+                    if (is_array($_POST['id'])) {
+                        foreach ($_POST['id'] as $index => $user_id) {
+                            if($user_id != $_user['user_id']) {
+                                if(UserManager :: delete_user($user_id)) {
+                                    $number_of_deleted_users++;
+                                }
+                            }
+                        }
+                    }
+                    if ($number_of_selected_users == $number_of_deleted_users) {
                         $message = Display :: return_message(get_lang('SelectedUsersDeleted'), 'confirmation');
-					} else {
+                    } else {
                         $message = Display :: return_message(get_lang('SomeUsersNotDeleted'), 'error');
-					}
-				}
-				break;
-		}
-		Security::clear_token();
-	}
+                    }
+                }
+                break;
+        }
+        Security::clear_token();
+    }
 }
 
 // Create a search-box
@@ -740,24 +740,24 @@ 
 
 $actions  = '';
 if (api_is_platform_admin()) {
-	$actions .= '<div style="float:right;">'.
-		 '<a href="'.api_get_path(WEB_CODE_PATH).'admin/user_add.php">'.
-         Display::return_icon('new_user.png',get_lang('AddUsers'),'',ICON_SIZE_MEDIUM).'</a>'.
-		 '</div>';
+    $actions .= '<div style="float:right;">'.
+            '<a href="'.api_get_path(WEB_CODE_PATH).'admin/user_add.php">'.
+            Display::return_icon('new_user.png',get_lang('AddUsers'),'',ICON_SIZE_MEDIUM).'</a>'.
+            '</div>';
 }
 $actions .= $form->return_form();
 
 if (isset ($_GET['keyword'])) {
-	$parameters = array ('keyword' => Security::remove_XSS($_GET['keyword']));
+    $parameters = array ('keyword' => Security::remove_XSS($_GET['keyword']));
 } elseif (isset ($_GET['keyword_firstname'])) {
-	$parameters['keyword_firstname'] 	= Security::remove_XSS($_GET['keyword_firstname']);
-	$parameters['keyword_lastname']	 	= Security::remove_XSS($_GET['keyword_lastname']);
-	$parameters['keyword_username']	 	= Security::remove_XSS($_GET['keyword_username']);
-	$parameters['keyword_email'] 	 	= Security::remove_XSS($_GET['keyword_email']);
-	$parameters['keyword_officialcode'] = Security::remove_XSS($_GET['keyword_officialcode']);
-	$parameters['keyword_status'] 		= Security::remove_XSS($_GET['keyword_status']);
-	$parameters['keyword_active'] 		= Security::remove_XSS($_GET['keyword_active']);
-	$parameters['keyword_inactive'] 	= Security::remove_XSS($_GET['keyword_inactive']);
+    $parameters['keyword_firstname'] 	= Security::remove_XSS($_GET['keyword_firstname']);
+    $parameters['keyword_lastname']	 	= Security::remove_XSS($_GET['keyword_lastname']);
+    $parameters['keyword_username']	 	= Security::remove_XSS($_GET['keyword_username']);
+    $parameters['keyword_email'] 	 	= Security::remove_XSS($_GET['keyword_email']);
+    $parameters['keyword_officialcode'] = Security::remove_XSS($_GET['keyword_officialcode']);
+    $parameters['keyword_status'] 		= Security::remove_XSS($_GET['keyword_status']);
+    $parameters['keyword_active'] 		= Security::remove_XSS($_GET['keyword_active']);
+    $parameters['keyword_inactive'] 	= Security::remove_XSS($_GET['keyword_inactive']);
 }
 // Create a sortable table with user-data
 $parameters['sec_token'] = Security::get_token();
@@ -768,7 +768,7 @@ 
 $res_admin = Database::query($sql_admin);
 $_admins_list = array();
 while ($row_admin = Database::fetch_row($res_admin)) {
-	$_admins_list[] = $row_admin[0];
+    $_admins_list[] = $row_admin[0];
 }
 
 // Display Advanced search form.
@@ -824,11 +824,11 @@ 
 $table->set_header(2, get_lang('OfficialCode'));
 
 if (api_is_western_name_order()) {
-	$table->set_header(3, get_lang('FirstName'));
-	$table->set_header(4, get_lang('LastName'));
+    $table->set_header(3, get_lang('FirstName'));
+    $table->set_header(4, get_lang('LastName'));
 } else {
-	$table->set_header(3, get_lang('LastName'));
-	$table->set_header(4, get_lang('FirstName'));
+    $table->set_header(3, get_lang('LastName'));
+    $table->set_header(4, get_lang('FirstName'));
 }
 $table->set_header(5, get_lang('LoginName'));
 $table->set_header(6, get_lang('Email'));

main/admin/user_update_import.php

Doc Comments +1 added lines, -1 removed lines

@@ -128,7 +128,7 @@
 /**
  * Update users from the imported data
  * @param   array   $users List of users
- * @return  void
+ * @return  false|null
  * @uses global variable $inserted_in_course, which returns the list of courses the user was inserted in
  */
 

Indentation +9 added lines, -9 removed lines

@@ -1,9 +1,9 @@ 
 <?php
 /* For licensing terms, see /license.txt */
 /**
- * This tool allows platform admins to add users by uploading a CSV or XML file
- * @package chamilo.admin
- */
+     * This tool allows platform admins to add users by uploading a CSV or XML file
+     * @package chamilo.admin
+     */
 
 /**
  * Validate the imported data.
@@ -60,8 +60,8 @@ 
                     $user['error'] = get_lang('UserNameNotAvailable');
                     $errors[] = $user;
                 }
-             }
-          }
+                }
+            }
 
         // 3. Check status.
         if (isset($user['Status']) && !api_status_exists($user['Status'])) {
@@ -242,10 +242,10 @@ 
     return $users;
 }
 /**
- * XML-parser: handle start of element
- * @param   string  $parser Deprecated?
- * @param   string  $data The data to be parsed
- */
+     * XML-parser: handle start of element
+     * @param   string  $parser Deprecated?
+     * @param   string  $data The data to be parsed
+     */
 function element_start($parser, $data)
 {
     $data = api_utf8_decode($data);

main/attendance/attendance_controller.php

Doc Comments +1 added lines, -1 removed lines

@@ -206,7 +206,7 @@
 
     /**
      * Restores an attendance entry and fallback to attendances rendering
-     * @param int	$attendanceId
+     * @param int	$attendance_id
      */
     public function attendance_restore($attendance_id)
     {

Indentation +5 added lines, -5 removed lines

@@ -636,11 +636,11 @@
             }
             $formToDisplay = $form->returnForm();
         } else {
-           if (!empty($sessionId)) {
-               $sessionInfo = api_get_session_info($sessionId);
-               $startDate = $sessionInfo['access_start_date'];
-               $endDate = $sessionInfo['access_end_date'];
-           }
+            if (!empty($sessionId)) {
+                $sessionInfo = api_get_session_info($sessionId);
+                $startDate = $sessionInfo['access_start_date'];
+                $endDate = $sessionInfo['access_end_date'];
+            }
         }
 
         $attendance = new Attendance();

main/auth/cas/authcas.php

Doc Comments +1 added lines, -1 removed lines

@@ -10,7 +10,7 @@
 require_once api_get_path(SYS_PATH).'main/auth/external_login/functions.inc.php';
 
 /**
-* @return true if cas is configured
+* @return boolean if cas is configured
 *
 **/
 function cas_configured() {

Indentation +56 added lines, -56 removed lines

@@ -14,7 +14,7 @@ 
 *
 **/
 function cas_configured() {
-	global $cas_auth_ver, $cas_auth_server, $cas_auth_port, $cas_auth_uri;
+    global $cas_auth_ver, $cas_auth_server, $cas_auth_port, $cas_auth_uri;
     $res = false;
     if (!empty($cas_auth_ver) && !empty($cas_auth_server) && !empty($cas_auth_port)) {
         $res = true;
@@ -32,23 +32,23 @@ 
 
 function cas_is_authenticated()
 {
-	global $cas_auth_ver, $cas_auth_server, $cas_auth_port, $cas_auth_uri;
-	global $PHPCAS_CLIENT;
-	global $logout;
+    global $cas_auth_ver, $cas_auth_server, $cas_auth_port, $cas_auth_uri;
+    global $PHPCAS_CLIENT;
+    global $logout;
 
     if (!cas_configured()) {
         return;
     }
 
-	if (!is_object($PHPCAS_CLIENT)) {
-		phpCAS::client($cas_auth_ver,$cas_auth_server,$cas_auth_port,$cas_auth_uri);
-		phpCAS::setNoCasServerValidation();
-	}
-	$auth = phpCAS::checkAuthentication();
+    if (!is_object($PHPCAS_CLIENT)) {
+        phpCAS::client($cas_auth_ver,$cas_auth_server,$cas_auth_port,$cas_auth_uri);
+        phpCAS::setNoCasServerValidation();
+    }
+    $auth = phpCAS::checkAuthentication();
 
-	if ($auth) {
-		$login= trim(phpCAS::getUser());
-		/*
+    if ($auth) {
+        $login= trim(phpCAS::getUser());
+        /*
 		   Get user  attributes. Here are the attributes for crdp platform
 		   sn => name
 		   ENTPersonMailInterne => mail
@@ -56,7 +56,7 @@ 
 		   ENTPersonProfils => profil
 		   givenName => first name
 		 */
-		/*$user=phpCAS::getAttributes();
+        /*$user=phpCAS::getAttributes();
 		$firstName = trim($user['givenName']);
 		$lastName = trim($user['sn']);
 		$login = trim($user['ENTPersonAlias']);
@@ -79,54 +79,54 @@ 
 			default:
 				$status=5; // Student
 		}*/
-		if (!$logout){
-		    // get user info from username
-		    $tab_user_info = api_get_user_info($login);
-
-		    // user found in the chamilo database
-		    if (is_array($tab_user_info)) {
-		        // if option is on we update user automatically from ldap server
-		        if (api_get_setting("update_user_info_cas_with_ldap") == "true") {
+        if (!$logout){
+            // get user info from username
+            $tab_user_info = api_get_user_info($login);
+
+            // user found in the chamilo database
+            if (is_array($tab_user_info)) {
+                // if option is on we update user automatically from ldap server
+                if (api_get_setting("update_user_info_cas_with_ldap") == "true") {
                     $ldapuser = extldap_authenticate($login, 'nopass', true);
                     if ($ldapuser !== false) {
                         $chamilo_user = extldap_get_chamilo_user($ldapuser);
                         $chamilo_user['user_id'] = $tab_user_info['user_id'];
                         $chamilo_user['status'] = $tab_user_info['status'];
-        				UserManager::update_user ($chamilo_user["user_id"], $chamilo_user["firstname"], $chamilo_user["lastname"], $login, null, null, $chamilo_user["email"], $chamilo_user["status"], '', '', '', '', 1, null, 0, null,'') ;
-		            }
-		        }
-		        return $login;
-		    }
-		    // user not found
-		    else {
-		        // if option is on we can ADD user automatically from ldap server or by modify own profil
-		        $user_added = false;
-		        switch (api_get_setting("cas_add_user_activate")) {
-		            case PLATFORM_AUTH_SOURCE :
-		                // user will have to modify firstname, lastname, email in chamilo profil edit
-		                $userdata = get_lang("EditInProfil");
-          				UserManager::create_user($userdata, $userdata, '5', $userdata, $login, 'casplaceholder', '','','','',CAS_AUTH_SOURCE);
-          				$user_added = $login;
-		                break;
-		            case LDAP_AUTH_SOURCE :
-		                // user info are read from ldap connexion
-	                    // get user info from ldap server
-	                    // user has already been authenticated by CAS
-	                    // If user not found in LDAP, user not created
-	                    $ldapuser = extldap_authenticate($login, 'nopass', true);
-	                    if ($ldapuser !== false) {
-	                        $chamilo_user = extldap_get_chamilo_user($ldapuser);
+                        UserManager::update_user ($chamilo_user["user_id"], $chamilo_user["firstname"], $chamilo_user["lastname"], $login, null, null, $chamilo_user["email"], $chamilo_user["status"], '', '', '', '', 1, null, 0, null,'') ;
+                    }
+                }
+                return $login;
+            }
+            // user not found
+            else {
+                // if option is on we can ADD user automatically from ldap server or by modify own profil
+                $user_added = false;
+                switch (api_get_setting("cas_add_user_activate")) {
+                    case PLATFORM_AUTH_SOURCE :
+                        // user will have to modify firstname, lastname, email in chamilo profil edit
+                        $userdata = get_lang("EditInProfil");
+                            UserManager::create_user($userdata, $userdata, '5', $userdata, $login, 'casplaceholder', '','','','',CAS_AUTH_SOURCE);
+                            $user_added = $login;
+                        break;
+                    case LDAP_AUTH_SOURCE :
+                        // user info are read from ldap connexion
+                        // get user info from ldap server
+                        // user has already been authenticated by CAS
+                        // If user not found in LDAP, user not created
+                        $ldapuser = extldap_authenticate($login, 'nopass', true);
+                        if ($ldapuser !== false) {
+                            $chamilo_user = extldap_get_chamilo_user($ldapuser);
                             $chamilo_user['username'] = $login;
                             $chamilo_user['auth_source'] = CAS_AUTH_SOURCE;
                             $chamilo_uid = external_add_user($chamilo_user);
-          				    $user_added = $login;
-          				}
-		                break;
-		            default : break;
-		        }
-		        return $user_added;
-		    }
-		}
+                                $user_added = $login;
+                            }
+                        break;
+                    default : break;
+                }
+                return $user_added;
+            }
+        }
 //		//If the user is in the dokeos database and we are ,not in a logout request, we upgrade his infomration by ldap
 //		if (! $logout){
 //			$user_table = Database::get_main_table(TABLE_MAIN_USER);
@@ -148,10 +148,10 @@ 
 //
 //			}
 //		}
-		return $login;
+        return $login;
     } else {
-		return false;
-	}
+        return false;
+    }
 }
 
 /**

main/auth/cas/lib/CAS.php

Doc Comments +4 added lines, -4 removed lines

@@ -516,7 +516,7 @@ 
 	/**

 	 * Logs a string in debug mode.

 	 *

-	 * @param $str the string to write

+	 * @param string $str the string to write

 	 *

 	 * @private

 	 */

@@ -537,7 +537,7 @@ 
 	 * This method is used by interface methods to print an error and where the function

 	 * was originally called from.

 	 *

-	 * @param $msg the message to print

+	 * @param string $msg the message to print

 	 *

 	 * @private

 	 */

@@ -664,7 +664,7 @@ 
 	/**

 	 * This method returns the phpCAS version.

 	 *

-	 * @return the phpCAS version.

+	 * @return string phpCAS version.

 	 */

 	function getVersion() {

 		return PHPCAS_VERSION;

@@ -1070,7 +1070,7 @@ 
 	 * @warning should not be called only after phpCAS::forceAuthentication()

 	 * or phpCAS::checkAuthentication().

 	 *

-	 * @return the login name of the authenticated user

+	 * @return string login name of the authenticated user

 	 */

 	function getUser() {

 		global $PHPCAS_CLIENT, $PHPCAS_AUTH_CHECK_CALL;

Indentation +1139 added lines, -1139 removed lines

@@ -33,14 +33,14 @@ 
 // hack by Vangelis Haniotakis to handle the absence of $_SERVER['REQUEST_URI'] in IIS

 //

 if (!$_SERVER['REQUEST_URI']) {

-	$_SERVER['REQUEST_URI'] = $_SERVER['SCRIPT_NAME'] . '?' . $_SERVER['QUERY_STRING'];

+    $_SERVER['REQUEST_URI'] = $_SERVER['SCRIPT_NAME'] . '?' . $_SERVER['QUERY_STRING'];

 }

 

 //

 // another one by Vangelis Haniotakis also to make phpCAS work with PHP5

 //

 if (version_compare(PHP_VERSION, '5', '>=')) {

-	require_once (dirname(__FILE__) . '/CAS/domxml-php4-to-php5.php');

+    require_once (dirname(__FILE__) . '/CAS/domxml-php4-to-php5.php');

 }

 

 /**

@@ -282,10 +282,10 @@ 
  * @hideinitializer

  */

 $GLOBALS['PHPCAS_INIT_CALL'] = array (

-	'done' => FALSE,

-	'file' => '?',

-	'line' => -1,

-	'method' => '?'

+    'done' => FALSE,

+    'file' => '?',

+    'line' => -1,

+    'method' => '?'

 );

 

 /**

@@ -295,11 +295,11 @@ 
  * @hideinitializer

  */

 $GLOBALS['PHPCAS_AUTH_CHECK_CALL'] = array (

-	'done' => FALSE,

-	'file' => '?',

-	'line' => -1,

-	'method' => '?',

-	'result' => FALSE

+    'done' => FALSE,

+    'file' => '?',

+    'line' => -1,

+    'method' => '?',

+    'result' => FALSE

 );

 

 /**

@@ -308,9 +308,9 @@ 
  * @hideinitializer

  */

 $GLOBALS['PHPCAS_DEBUG'] = array (

-	'filename' => '/tmp/cas.log',

-	'indent' => 0,

-	'unique_id' => ''

+    'filename' => '/tmp/cas.log',

+    'indent' => 0,

+    'unique_id' => ''

 );

 

 /** @} */

@@ -340,1141 +340,1141 @@ 
 

 class phpCAS {

 

-	// ########################################################################

-	//  INITIALIZATION

-	// ########################################################################

-

-	/**

-	 * @addtogroup publicInit

-	 * @{

-	 */

-

-	/**

-	 * phpCAS client initializer.

-	 * @note Only one of the phpCAS::client() and phpCAS::proxy functions should be

-	 * called, only once, and before all other methods (except phpCAS::getVersion()

-	 * and phpCAS::setDebug()).

-	 *

-	 * @param $server_version the version of the CAS server

-	 * @param $server_hostname the hostname of the CAS server

-	 * @param $server_port the port the CAS server is running on

-	 * @param $server_uri the URI the CAS server is responding on

-	 * @param $start_session Have phpCAS start PHP sessions (default true)

-	 *

-	 * @return a newly created CASClient object

-	 */

-	function client($server_version, $server_hostname, $server_port, $server_uri, $start_session = true) {

-		global $PHPCAS_CLIENT, $PHPCAS_INIT_CALL;

-

-		phpCAS :: traceBegin();

-		if (is_object($PHPCAS_CLIENT)) {

-			phpCAS :: error($PHPCAS_INIT_CALL['method'] . '() has already been called (at ' . $PHPCAS_INIT_CALL['file'] . ':' . $PHPCAS_INIT_CALL['line'] . ')');

-		}

-		if (gettype($server_version) != 'string') {

-			phpCAS :: error('type mismatched for parameter $server_version (should be `string\')');

-		}

-		if (gettype($server_hostname) != 'string') {

-			phpCAS :: error('type mismatched for parameter $server_hostname (should be `string\')');

-		}

-		if (gettype($server_port) != 'integer') {

-			phpCAS :: error('type mismatched for parameter $server_port (should be `integer\')');

-		}

-		if (gettype($server_uri) != 'string') {

-			phpCAS :: error('type mismatched for parameter $server_uri (should be `string\')');

-		}

-

-		// store where the initializer is called from

-		$dbg = phpCAS :: backtrace();

-		$PHPCAS_INIT_CALL = array (

-			'done' => TRUE,

-			'file' => $dbg[0]['file'],

-			'line' => $dbg[0]['line'],

-			'method' => __CLASS__ . '::' . __FUNCTION__

-		);

-

-		// initialize the global object $PHPCAS_CLIENT

-		$PHPCAS_CLIENT = new CASClient($server_version, FALSE /*proxy*/

-		, $server_hostname, $server_port, $server_uri, $start_session);

-		phpCAS :: traceEnd();

-	}

-

-	/**

-	 * phpCAS proxy initializer.

-	 * @note Only one of the phpCAS::client() and phpCAS::proxy functions should be

-	 * called, only once, and before all other methods (except phpCAS::getVersion()

-	 * and phpCAS::setDebug()).

-	 *

-	 * @param $server_version the version of the CAS server

-	 * @param $server_hostname the hostname of the CAS server

-	 * @param $server_port the port the CAS server is running on

-	 * @param $server_uri the URI the CAS server is responding on

-	 * @param $start_session Have phpCAS start PHP sessions (default true)

-	 *

-	 * @return a newly created CASClient object

-	 */

-	function proxy($server_version, $server_hostname, $server_port, $server_uri, $start_session = true) {

-		global $PHPCAS_CLIENT, $PHPCAS_INIT_CALL;

-

-		phpCAS :: traceBegin();

-		if (is_object($PHPCAS_CLIENT)) {

-			phpCAS :: error($PHPCAS_INIT_CALL['method'] . '() has already been called (at ' . $PHPCAS_INIT_CALL['file'] . ':' . $PHPCAS_INIT_CALL['line'] . ')');

-		}

-		if (gettype($server_version) != 'string') {

-			phpCAS :: error('type mismatched for parameter $server_version (should be `string\')');

-		}

-		if (gettype($server_hostname) != 'string') {

-			phpCAS :: error('type mismatched for parameter $server_hostname (should be `string\')');

-		}

-		if (gettype($server_port) != 'integer') {

-			phpCAS :: error('type mismatched for parameter $server_port (should be `integer\')');

-		}

-		if (gettype($server_uri) != 'string') {

-			phpCAS :: error('type mismatched for parameter $server_uri (should be `string\')');

-		}

-

-		// store where the initialzer is called from

-		$dbg = phpCAS :: backtrace();

-		$PHPCAS_INIT_CALL = array (

-			'done' => TRUE,

-			'file' => $dbg[0]['file'],

-			'line' => $dbg[0]['line'],

-			'method' => __CLASS__ . '::' . __FUNCTION__

-		);

-

-		// initialize the global object $PHPCAS_CLIENT

-		$PHPCAS_CLIENT = new CASClient($server_version, TRUE /*proxy*/

-		, $server_hostname, $server_port, $server_uri, $start_session);

-		phpCAS :: traceEnd();

-	}

-

-	/** @} */

-	// ########################################################################

-	//  DEBUGGING

-	// ########################################################################

-

-	/**

-	 * @addtogroup publicDebug

-	 * @{

-	 */

-

-	/**

-	 * Set/unset debug mode

-	 *

-	 * @param $filename the name of the file used for logging, or FALSE to stop debugging.

-	 */

-	function setDebug($filename = '') {

-		global $PHPCAS_DEBUG;

-

-		if ($filename != FALSE && gettype($filename) != 'string') {

-			phpCAS :: error('type mismatched for parameter $dbg (should be FALSE or the name of the log file)');

-		}

-

-		if (empty ($filename)) {

-			if (preg_match('/^Win.*/', getenv('OS'))) {

-				if (isset ($_ENV['TMP'])) {

-					$debugDir = $_ENV['TMP'] . '/';

-				} else

-					if (isset ($_ENV['TEMP'])) {

-						$debugDir = $_ENV['TEMP'] . '/';

-					} else {

-						$debugDir = '';

-					}

-			} else {

-				$debugDir = DEFAULT_DEBUG_DIR;

-			}

-			$filename = $debugDir . 'phpCAS.log';

-		}

-

-		if (empty ($PHPCAS_DEBUG['unique_id'])) {

-			$PHPCAS_DEBUG['unique_id'] = substr(strtoupper(md5(uniqid(''))), 0, 4);

-		}

-

-		$PHPCAS_DEBUG['filename'] = $filename;

-

-		phpCAS :: trace('START ******************');

-	}

-

-	/** @} */

-	/**

-	 * @addtogroup internalDebug

-	 * @{

-	 */

-

-	/**

-	 * This method is a wrapper for debug_backtrace() that is not available 

-	 * in all PHP versions (>= 4.3.0 only)

-	 */

-	function backtrace() {

-		if (function_exists('debug_backtrace')) {

-			return debug_backtrace();

-		} else {

-			// poor man's hack ... but it does work ...

-			return array ();

-		}

-	}

-

-	/**

-	 * Logs a string in debug mode.

-	 *

-	 * @param $str the string to write

-	 *

-	 * @private

-	 */

-	function log($str) {

-		$indent_str = ".";

-		global $PHPCAS_DEBUG;

-

-		if ($PHPCAS_DEBUG['filename']) {

-			for ($i = 0; $i < $PHPCAS_DEBUG['indent']; $i++) {

-				$indent_str .= '|    ';

-			}

-			error_log($PHPCAS_DEBUG['unique_id'] . ' ' . $indent_str . $str . "\n", 3, $PHPCAS_DEBUG['filename']);

-		}

-

-	}

-

-	/**

-	 * This method is used by interface methods to print an error and where the function

-	 * was originally called from.

-	 *

-	 * @param $msg the message to print

-	 *

-	 * @private

-	 */

-	function error($msg) {

-		$dbg = phpCAS :: backtrace();

-		$function = '?';

-		$file = '?';

-		$line = '?';

-		if (is_array($dbg)) {

-			for ($i = 1; $i < sizeof($dbg); $i++) {

-				if (is_array($dbg[$i])) {

-					if ($dbg[$i]['class'] == __CLASS__) {

-						$function = $dbg[$i]['function'];

-						$file = $dbg[$i]['file'];

-						$line = $dbg[$i]['line'];

-					}

-				}

-			}

-		}

-		echo "<br />\n<b>phpCAS error</b>: <font color=\"FF0000\"><b>" . __CLASS__ . "::" . $function . '(): ' . htmlentities($msg) . "</b></font> in <b>" . $file . "</b> on line <b>" . $line . "</b><br />\n";

-		phpCAS :: trace($msg);

-		phpCAS :: traceExit();

-		exit ();

-	}

-

-	/**

-	 * This method is used to log something in debug mode.

-	 */

-	function trace($str) {

-		$dbg = phpCAS :: backtrace();

-		phpCAS :: log($str . ' [' . basename($dbg[1]['file']) . ':' . $dbg[1]['line'] . ']');

-	}

-

-	/**

-	 * This method is used to indicate the start of the execution of a function in debug mode.

-	 */

-	function traceBegin() {

-		global $PHPCAS_DEBUG;

-

-		$dbg = phpCAS :: backtrace();

-		$str = '=> ';

-		if (!empty ($dbg[2]['class'])) {

-			$str .= $dbg[2]['class'] . '::';

-		}

-		$str .= $dbg[2]['function'] . '(';

-		if (is_array($dbg[2]['args'])) {

-			foreach ($dbg[2]['args'] as $index => $arg) {

-				if ($index != 0) {

-					$str .= ', ';

-				}

-				$str .= str_replace("\n", "", var_export($arg, TRUE));

-			}

-		}

-		$str .= ') [' . basename($dbg[2]['file']) . ':' . $dbg[2]['line'] . ']';

-		phpCAS :: log($str);

-		$PHPCAS_DEBUG['indent']++;

-	}

-

-	/**

-	 * This method is used to indicate the end of the execution of a function in debug mode.

-	 *

-	 * @param $res the result of the function

-	 */

-	function traceEnd($res = '') {

-		global $PHPCAS_DEBUG;

-

-		$PHPCAS_DEBUG['indent']--;

-		$dbg = phpCAS :: backtrace();

-		$str = '';

-		$str .= '<= ' . str_replace("\n", "", var_export($res, TRUE));

-		phpCAS :: log($str);

-	}

-

-	/**

-	 * This method is used to indicate the end of the execution of the program

-	 */

-	function traceExit() {

-		global $PHPCAS_DEBUG;

-

-		phpCAS :: log('exit()');

-		while ($PHPCAS_DEBUG['indent'] > 0) {

-			phpCAS :: log('-');

-			$PHPCAS_DEBUG['indent']--;

-		}

-	}

-

-	/** @} */

-	// ########################################################################

-	//  INTERNATIONALIZATION

-	// ########################################################################

-	/**

-	 * @addtogroup publicLang

-	 * @{

-	 */

-

-	/**

-	 * This method is used to set the language used by phpCAS. 

-	 * @note Can be called only once.

-	 *

-	 * @param $lang a string representing the language.

-	 *

-	 * @sa PHPCAS_LANG_FRENCH, PHPCAS_LANG_ENGLISH

-	 */

-	function setLang($lang) {

-		global $PHPCAS_CLIENT;

-		if (!is_object($PHPCAS_CLIENT)) {

-			phpCAS :: error('this method should not be called before ' . __CLASS__ . '::client() or ' . __CLASS__ . '::proxy()');

-		}

-		if (gettype($lang) != 'string') {

-			phpCAS :: error('type mismatched for parameter $lang (should be `string\')');

-		}

-		$PHPCAS_CLIENT->setLang($lang);

-	}

-

-	/** @} */

-	// ########################################################################

-	//  VERSION

-	// ########################################################################

-	/**

-	 * @addtogroup public

-	 * @{

-	 */

-

-	/**

-	 * This method returns the phpCAS version.

-	 *

-	 * @return the phpCAS version.

-	 */

-	function getVersion() {

-		return PHPCAS_VERSION;

-	}

-

-	/** @} */

-	// ########################################################################

-	//  HTML OUTPUT

-	// ########################################################################

-	/**

-	 * @addtogroup publicOutput

-	 * @{

-	 */

-

-	/**

-	 * This method sets the HTML header used for all outputs.

-	 *

-	 * @param $header the HTML header.

-	 */

-	function setHTMLHeader($header) {

-		global $PHPCAS_CLIENT;

-		if (!is_object($PHPCAS_CLIENT)) {

-			phpCAS :: error('this method should not be called before ' . __CLASS__ . '::client() or ' . __CLASS__ . '::proxy()');

-		}

-		if (gettype($header) != 'string') {

-			phpCAS :: error('type mismatched for parameter $header (should be `string\')');

-		}

-		$PHPCAS_CLIENT->setHTMLHeader($header);

-	}

-

-	/**

-	 * This method sets the HTML footer used for all outputs.

-	 *

-	 * @param $footer the HTML footer.

-	 */

-	function setHTMLFooter($footer) {

-		global $PHPCAS_CLIENT;

-		if (!is_object($PHPCAS_CLIENT)) {

-			phpCAS :: error('this method should not be called before ' . __CLASS__ . '::client() or ' . __CLASS__ . '::proxy()');

-		}

-		if (gettype($footer) != 'string') {

-			phpCAS :: error('type mismatched for parameter $footer (should be `string\')');

-		}

-		$PHPCAS_CLIENT->setHTMLFooter($footer);

-	}

-

-	/** @} */

-	// ########################################################################

-	//  PGT STORAGE

-	// ########################################################################

-	/**

-	 * @addtogroup publicPGTStorage

-	 * @{

-	 */

-

-	/**

-	 * This method is used to tell phpCAS to store the response of the

-	 * CAS server to PGT requests onto the filesystem. 

-	 *

-	 * @param $format the format used to store the PGT's (`plain' and `xml' allowed)

-	 * @param $path the path where the PGT's should be stored

-	 */

-	function setPGTStorageFile($format = '', $path = '') {

-		global $PHPCAS_CLIENT, $PHPCAS_AUTH_CHECK_CALL;

-

-		phpCAS :: traceBegin();

-		if (!is_object($PHPCAS_CLIENT)) {

-			phpCAS :: error('this method should only be called after ' . __CLASS__ . '::proxy()');

-		}

-		if (!$PHPCAS_CLIENT->isProxy()) {

-			phpCAS :: error('this method should only be called after ' . __CLASS__ . '::proxy()');

-		}

-		if ($PHPCAS_AUTH_CHECK_CALL['done']) {

-			phpCAS :: error('this method should only be called before ' . $PHPCAS_AUTH_CHECK_CALL['method'] . '() (called at ' . $PHPCAS_AUTH_CHECK_CALL['file'] . ':' . $PHPCAS_AUTH_CHECK_CALL['line'] . ')');

-		}

-		if (gettype($format) != 'string') {

-			phpCAS :: error('type mismatched for parameter $format (should be `string\')');

-		}

-		if (gettype($path) != 'string') {

-			phpCAS :: error('type mismatched for parameter $format (should be `string\')');

-		}

-		$PHPCAS_CLIENT->setPGTStorageFile($format, $path);

-		phpCAS :: traceEnd();

-	}

-

-	/**

-	 * This method is used to tell phpCAS to store the response of the

-	 * CAS server to PGT requests into a database. 

-	 * @note The connection to the database is done only when needed. 

-	 * As a consequence, bad parameters are detected only when 

-	 * initializing PGT storage, except in debug mode.

-	 *

-	 * @param $user the user to access the data with

-	 * @param $password the user's password

-	 * @param $database_type the type of the database hosting the data

-	 * @param $hostname the server hosting the database

-	 * @param $port the port the server is listening on

-	 * @param $database the name of the database

-	 * @param $table the name of the table storing the data

-	 */

-	function setPGTStorageDB($user, $password, $database_type = '', $hostname = '', $port = 0, $database = '', $table = '') {

-		global $PHPCAS_CLIENT, $PHPCAS_AUTH_CHECK_CALL;

-

-		phpCAS :: traceBegin();

-		if (!is_object($PHPCAS_CLIENT)) {

-			phpCAS :: error('this method should only be called after ' . __CLASS__ . '::proxy()');

-		}

-		if (!$PHPCAS_CLIENT->isProxy()) {

-			phpCAS :: error('this method should only be called after ' . __CLASS__ . '::proxy()');

-		}

-		if ($PHPCAS_AUTH_CHECK_CALL['done']) {

-			phpCAS :: error('this method should only be called before ' . $PHPCAS_AUTH_CHECK_CALL['method'] . '() (called at ' . $PHPCAS_AUTH_CHECK_CALL['file'] . ':' . $PHPCAS_AUTH_CHECK_CALL['line'] . ')');

-		}

-		if (gettype($user) != 'string') {

-			phpCAS :: error('type mismatched for parameter $user (should be `string\')');

-		}

-		if (gettype($password) != 'string') {

-			phpCAS :: error('type mismatched for parameter $password (should be `string\')');

-		}

-		if (gettype($database_type) != 'string') {

-			phpCAS :: error('type mismatched for parameter $database_type (should be `string\')');

-		}

-		if (gettype($hostname) != 'string') {

-			phpCAS :: error('type mismatched for parameter $hostname (should be `string\')');

-		}

-		if (gettype($port) != 'integer') {

-			phpCAS :: error('type mismatched for parameter $port (should be `integer\')');

-		}

-		if (gettype($database) != 'string') {

-			phpCAS :: error('type mismatched for parameter $database (should be `string\')');

-		}

-		if (gettype($table) != 'string') {

-			phpCAS :: error('type mismatched for parameter $table (should be `string\')');

-		}

-		$PHPCAS_CLIENT->setPGTStorageDB($user, $password, $database_type, $hostname, $port, $database, $table);

-		phpCAS :: traceEnd();

-	}

-

-	/** @} */

-	// ########################################################################

-	// ACCESS TO EXTERNAL SERVICES

-	// ########################################################################

-	/**

-	 * @addtogroup publicServices

-	 * @{

-	 */

-

-	/**

-	 * This method is used to access an HTTP[S] service.

-	 * 

-	 * @param $url the service to access.

-	 * @param $err_code an error code Possible values are PHPCAS_SERVICE_OK (on

-	 * success), PHPCAS_SERVICE_PT_NO_SERVER_RESPONSE, PHPCAS_SERVICE_PT_BAD_SERVER_RESPONSE,

-	 * PHPCAS_SERVICE_PT_FAILURE, PHPCAS_SERVICE_NOT AVAILABLE.

-	 * @param $output the output of the service (also used to give an error

-	 * message on failure).

-	 *

-	 * @return TRUE on success, FALSE otherwise (in this later case, $err_code

-	 * gives the reason why it failed and $output contains an error message).

-	 */

-	function serviceWeb($url, & $err_code, & $output) {

-		global $PHPCAS_CLIENT, $PHPCAS_AUTH_CHECK_CALL;

-

-		phpCAS :: traceBegin();

-		if (!is_object($PHPCAS_CLIENT)) {

-			phpCAS :: error('this method should only be called after ' . __CLASS__ . '::proxy()');

-		}

-		if (!$PHPCAS_CLIENT->isProxy()) {

-			phpCAS :: error('this method should only be called after ' . __CLASS__ . '::proxy()');

-		}

-		if (!$PHPCAS_AUTH_CHECK_CALL['done']) {

-			phpCAS :: error('this method should only be called after the programmer is sure the user has been authenticated (by calling ' . __CLASS__ . '::checkAuthentication() or ' . __CLASS__ . '::forceAuthentication()');

-		}

-		if (!$PHPCAS_AUTH_CHECK_CALL['result']) {

-			phpCAS :: error('authentication was checked (by ' . $PHPCAS_AUTH_CHECK_CALL['method'] . '() at ' . $PHPCAS_AUTH_CHECK_CALL['file'] . ':' . $PHPCAS_AUTH_CHECK_CALL['line'] . ') but the method returned FALSE');

-		}

-		if (gettype($url) != 'string') {

-			phpCAS :: error('type mismatched for parameter $url (should be `string\')');

-		}

-

-		$res = $PHPCAS_CLIENT->serviceWeb($url, $err_code, $output);

-

-		phpCAS :: traceEnd($res);

-		return $res;

-	}

-

-	/**

-	 * This method is used to access an IMAP/POP3/NNTP service.

-	 * 

-	 * @param $url a string giving the URL of the service, including the mailing box

-	 * for IMAP URLs, as accepted by imap_open().

-	 * @param $service a string giving for CAS retrieve Proxy ticket

-	 * @param $flags options given to imap_open().

-	 * @param $err_code an error code Possible values are PHPCAS_SERVICE_OK (on

-	 * success), PHPCAS_SERVICE_PT_NO_SERVER_RESPONSE, PHPCAS_SERVICE_PT_BAD_SERVER_RESPONSE,

-	 * PHPCAS_SERVICE_PT_FAILURE, PHPCAS_SERVICE_NOT AVAILABLE.

-	 * @param $err_msg an error message on failure

-	 * @param $pt the Proxy Ticket (PT) retrieved from the CAS server to access the URL

-	 * on success, FALSE on error).

-	 *

-	 * @return an IMAP stream on success, FALSE otherwise (in this later case, $err_code

-	 * gives the reason why it failed and $err_msg contains an error message).

-	 */

-	function serviceMail($url, $service, $flags, & $err_code, & $err_msg, & $pt) {

-		global $PHPCAS_CLIENT, $PHPCAS_AUTH_CHECK_CALL;

-

-		phpCAS :: traceBegin();

-		if (!is_object($PHPCAS_CLIENT)) {

-			phpCAS :: error('this method should only be called after ' . __CLASS__ . '::proxy()');

-		}

-		if (!$PHPCAS_CLIENT->isProxy()) {

-			phpCAS :: error('this method should only be called after ' . __CLASS__ . '::proxy()');

-		}

-		if (!$PHPCAS_AUTH_CHECK_CALL['done']) {

-			phpCAS :: error('this method should only be called after the programmer is sure the user has been authenticated (by calling ' . __CLASS__ . '::checkAuthentication() or ' . __CLASS__ . '::forceAuthentication()');

-		}

-		if (!$PHPCAS_AUTH_CHECK_CALL['result']) {

-			phpCAS :: error('authentication was checked (by ' . $PHPCAS_AUTH_CHECK_CALL['method'] . '() at ' . $PHPCAS_AUTH_CHECK_CALL['file'] . ':' . $PHPCAS_AUTH_CHECK_CALL['line'] . ') but the method returned FALSE');

-		}

-		if (gettype($url) != 'string') {

-			phpCAS :: error('type mismatched for parameter $url (should be `string\')');

-		}

-

-		if (gettype($flags) != 'integer') {

-			phpCAS :: error('type mismatched for parameter $flags (should be `integer\')');

-		}

-

-		$res = $PHPCAS_CLIENT->serviceMail($url, $service, $flags, $err_code, $err_msg, $pt);

-

-		phpCAS :: traceEnd($res);

-		return $res;

-	}

-

-	/** @} */

-	// ########################################################################

-	//  AUTHENTICATION

-	// ########################################################################

-	/**

-	 * @addtogroup publicAuth

-	 * @{

-	 */

-

-	/**

-	 * Set the times authentication will be cached before really accessing the CAS server in gateway mode: 

-	 * - -1: check only once, and then never again (until you pree login)

-	 * - 0: always check

-	 * - n: check every "n" time

-	 *

-	 * @param $n an integer.

-	 */

-	function setCacheTimesForAuthRecheck($n) {

-		global $PHPCAS_CLIENT;

-		if (!is_object($PHPCAS_CLIENT)) {

-			phpCAS :: error('this method should not be called before ' . __CLASS__ . '::client() or ' . __CLASS__ . '::proxy()');

-		}

-		if (gettype($n) != 'integer') {

-			phpCAS :: error('type mismatched for parameter $header (should be `string\')');

-		}

-		$PHPCAS_CLIENT->setCacheTimesForAuthRecheck($n);

-	}

-

-	/**

-	 * This method is called to check if the user is authenticated (use the gateway feature).

-	 * @return TRUE when the user is authenticated; otherwise FALSE.

-	 */

-	function checkAuthentication() {

-		global $PHPCAS_CLIENT, $PHPCAS_AUTH_CHECK_CALL;

-

-		phpCAS :: traceBegin();

-		if (!is_object($PHPCAS_CLIENT)) {

-			phpCAS :: error('this method should not be called before ' . __CLASS__ . '::client() or ' . __CLASS__ . '::proxy()');

-		}

-

-		$auth = $PHPCAS_CLIENT->checkAuthentication();

-

-		// store where the authentication has been checked and the result

-		$dbg = phpCAS :: backtrace();

-		$PHPCAS_AUTH_CHECK_CALL = array (

-			'done' => TRUE,

-			'file' => $dbg[0]['file'],

-			'line' => $dbg[0]['line'],

-			'method' => __CLASS__ . '::' . __FUNCTION__,

-			'result' => $auth

-		);

-		phpCAS :: traceEnd($auth);

-		return $auth;

-	}

-

-	/**

-	 * This method is called to force authentication if the user was not already 

-	 * authenticated. If the user is not authenticated, halt by redirecting to 

-	 * the CAS server.

-	 */

-	function forceAuthentication() {

-		global $PHPCAS_CLIENT, $PHPCAS_AUTH_CHECK_CALL;

-

-		phpCAS :: traceBegin();

-		if (!is_object($PHPCAS_CLIENT)) {

-			phpCAS :: error('this method should not be called before ' . __CLASS__ . '::client() or ' . __CLASS__ . '::proxy()');

-		}

-

-		$auth = $PHPCAS_CLIENT->forceAuthentication();

-

-		// store where the authentication has been checked and the result

-		$dbg = phpCAS :: backtrace();

-		$PHPCAS_AUTH_CHECK_CALL = array (

-			'done' => TRUE,

-			'file' => $dbg[0]['file'],

-			'line' => $dbg[0]['line'],

-			'method' => __CLASS__ . '::' . __FUNCTION__,

-			'result' => $auth

-		);

-

-		if (!$auth) {

-			phpCAS :: trace('user is not authenticated, redirecting to the CAS server');

-			$PHPCAS_CLIENT->forceAuthentication();

-		} else {

-			phpCAS :: trace('no need to authenticate (user `' . phpCAS :: getUser() . '\' is already authenticated)');

-		}

-

-		phpCAS :: traceEnd();

-		return $auth;

-	}

-

-	/**

-	 * This method is called to renew the authentication.

-	 **/

-	function renewAuthentication() {

-		global $PHPCAS_CLIENT, $PHPCAS_AUTH_CHECK_CALL;

-

-		phpCAS :: traceBegin();

-		if (!is_object($PHPCAS_CLIENT)) {

-			phpCAS :: error('this method should not be called before' . __CLASS__ . '::client() or ' . __CLASS__ . '::proxy()');

-		}

-

-		// store where the authentication has been checked and the result

-		$dbg = phpCAS :: backtrace();

-		$PHPCAS_AUTH_CHECK_CALL = array (

-			'done' => TRUE,

-			'file' => $dbg[0]['file'],

-			'line' => $dbg[0]['line'],

-			'method' => __CLASS__ . '::' . __FUNCTION__,

-			'result' => $auth

-		);

-

-		$PHPCAS_CLIENT->renewAuthentication();

-		phpCAS :: traceEnd();

-	}

-

-	/**

-	 * This method has been left from version 0.4.1 for compatibility reasons.

-	 */

-	function authenticate() {

-		phpCAS :: error('this method is deprecated. You should use ' . __CLASS__ . '::forceAuthentication() instead');

-	}

-

-	/**

-	 * This method is called to check if the user is authenticated (previously or by

-	 * tickets given in the URL).

-	 *

-	 * @return TRUE when the user is authenticated.

-	 */

-	function isAuthenticated() {

-		global $PHPCAS_CLIENT, $PHPCAS_AUTH_CHECK_CALL;

-

-		phpCAS :: traceBegin();

-		if (!is_object($PHPCAS_CLIENT)) {

-			phpCAS :: error('this method should not be called before ' . __CLASS__ . '::client() or ' . __CLASS__ . '::proxy()');

-		}

-

-		// call the isAuthenticated method of the global $PHPCAS_CLIENT object

-		$auth = $PHPCAS_CLIENT->isAuthenticated();

-

-		// store where the authentication has been checked and the result

-		$dbg = phpCAS :: backtrace();

-		$PHPCAS_AUTH_CHECK_CALL = array (

-			'done' => TRUE,

-			'file' => $dbg[0]['file'],

-			'line' => $dbg[0]['line'],

-			'method' => __CLASS__ . '::' . __FUNCTION__,

-			'result' => $auth

-		);

-		phpCAS :: traceEnd($auth);

-		return $auth;

-	}

-

-	/**

-	 * Checks whether authenticated based on $_SESSION. Useful to avoid

-	 * server calls.

-	 * @return true if authenticated, false otherwise.

-	 * @since 0.4.22 by Brendan Arnold

-	 */

-	function isSessionAuthenticated() {

-		global $PHPCAS_CLIENT;

-		if (!is_object($PHPCAS_CLIENT)) {

-			phpCAS :: error('this method should not be called before ' . __CLASS__ . '::client() or ' . __CLASS__ . '::proxy()');

-		}

-		return ($PHPCAS_CLIENT->isSessionAuthenticated());

-	}

-

-	/**

-	 * This method returns the CAS user's login name.

-	 * @warning should not be called only after phpCAS::forceAuthentication()

-	 * or phpCAS::checkAuthentication().

-	 *

-	 * @return the login name of the authenticated user

-	 */

-	function getUser() {

-		global $PHPCAS_CLIENT, $PHPCAS_AUTH_CHECK_CALL;

-		if (!is_object($PHPCAS_CLIENT)) {

-			phpCAS :: error('this method should not be called before ' . __CLASS__ . '::client() or ' . __CLASS__ . '::proxy()');

-		}

-		if (!$PHPCAS_AUTH_CHECK_CALL['done']) {

-			phpCAS :: error('this method should only be called after ' . __CLASS__ . '::forceAuthentication() or ' . __CLASS__ . '::isAuthenticated()');

-		}

-		if (!$PHPCAS_AUTH_CHECK_CALL['result']) {

-			phpCAS :: error('authentication was checked (by ' . $PHPCAS_AUTH_CHECK_CALL['method'] . '() at ' . $PHPCAS_AUTH_CHECK_CALL['file'] . ':' . $PHPCAS_AUTH_CHECK_CALL['line'] . ') but the method returned FALSE');

-		}

-		return $PHPCAS_CLIENT->getUser();

-	}

-

-	/**

-	 * This method returns the CAS user's login name.

-	 * @warning should not be called only after phpCAS::forceAuthentication()

-	 * or phpCAS::checkAuthentication().

-	 *

-	 * @return the login name of the authenticated user

-	 */

-	function getAttributes() {

-		global $PHPCAS_CLIENT, $PHPCAS_AUTH_CHECK_CALL;

-		if (!is_object($PHPCAS_CLIENT)) {

-			phpCAS :: error('this method should not be called before ' . __CLASS__ . '::client() or ' . __CLASS__ . '::proxy()');

-		}

-		if (!$PHPCAS_AUTH_CHECK_CALL['done']) {

-			phpCAS :: error('this method should only be called after ' . __CLASS__ . '::forceAuthentication() or ' . __CLASS__ . '::isAuthenticated()');

-		}

-		if (!$PHPCAS_AUTH_CHECK_CALL['result']) {

-			phpCAS :: error('authentication was checked (by ' . $PHPCAS_AUTH_CHECK_CALL['method'] . '() at ' . $PHPCAS_AUTH_CHECK_CALL['file'] . ':' . $PHPCAS_AUTH_CHECK_CALL['line'] . ') but the method returned FALSE');

-		}

-		return $PHPCAS_CLIENT->getAttributes();

-	}

-	/**

-	 * Handle logout requests.

-	 */

-	function handleLogoutRequests($check_client = true, $allowed_clients = false) {

-		global $PHPCAS_CLIENT;

-		if (!is_object($PHPCAS_CLIENT)) {

-			phpCAS :: error('this method should not be called before ' . __CLASS__ . '::client() or ' . __CLASS__ . '::proxy()');

-		}

-		return ($PHPCAS_CLIENT->handleLogoutRequests($check_client, $allowed_clients));

-	}

-

-	/**

-	 * This method returns the URL to be used to login.

-	 * or phpCAS::isAuthenticated().

-	 *

-	 * @return the login name of the authenticated user

-	 */

-	function getServerLoginURL() {

-		global $PHPCAS_CLIENT;

-		if (!is_object($PHPCAS_CLIENT)) {

-			phpCAS :: error('this method should not be called before ' . __CLASS__ . '::client() or ' . __CLASS__ . '::proxy()');

-		}

-		return $PHPCAS_CLIENT->getServerLoginURL();

-	}

-

-	/**

-	 * Set the login URL of the CAS server.

-	 * @param $url the login URL

-	 * @since 0.4.21 by Wyman Chan

-	 */

-	function setServerLoginURL($url = '') {

-		global $PHPCAS_CLIENT;

-		phpCAS :: traceBegin();

-		if (!is_object($PHPCAS_CLIENT)) {

-			phpCAS :: error('this method should only be called after

+    // ########################################################################

+    //  INITIALIZATION

+    // ########################################################################

+

+    /**

+     * @addtogroup publicInit

+     * @{

+     */

+

+    /**

+     * phpCAS client initializer.

+     * @note Only one of the phpCAS::client() and phpCAS::proxy functions should be

+     * called, only once, and before all other methods (except phpCAS::getVersion()

+     * and phpCAS::setDebug()).

+     *

+     * @param $server_version the version of the CAS server

+     * @param $server_hostname the hostname of the CAS server

+     * @param $server_port the port the CAS server is running on

+     * @param $server_uri the URI the CAS server is responding on

+     * @param $start_session Have phpCAS start PHP sessions (default true)

+     *

+     * @return a newly created CASClient object

+     */

+    function client($server_version, $server_hostname, $server_port, $server_uri, $start_session = true) {

+        global $PHPCAS_CLIENT, $PHPCAS_INIT_CALL;

+

+        phpCAS :: traceBegin();

+        if (is_object($PHPCAS_CLIENT)) {

+            phpCAS :: error($PHPCAS_INIT_CALL['method'] . '() has already been called (at ' . $PHPCAS_INIT_CALL['file'] . ':' . $PHPCAS_INIT_CALL['line'] . ')');

+        }

+        if (gettype($server_version) != 'string') {

+            phpCAS :: error('type mismatched for parameter $server_version (should be `string\')');

+        }

+        if (gettype($server_hostname) != 'string') {

+            phpCAS :: error('type mismatched for parameter $server_hostname (should be `string\')');

+        }

+        if (gettype($server_port) != 'integer') {

+            phpCAS :: error('type mismatched for parameter $server_port (should be `integer\')');

+        }

+        if (gettype($server_uri) != 'string') {

+            phpCAS :: error('type mismatched for parameter $server_uri (should be `string\')');

+        }

+

+        // store where the initializer is called from

+        $dbg = phpCAS :: backtrace();

+        $PHPCAS_INIT_CALL = array (

+            'done' => TRUE,

+            'file' => $dbg[0]['file'],

+            'line' => $dbg[0]['line'],

+            'method' => __CLASS__ . '::' . __FUNCTION__

+        );

+

+        // initialize the global object $PHPCAS_CLIENT

+        $PHPCAS_CLIENT = new CASClient($server_version, FALSE /*proxy*/

+        , $server_hostname, $server_port, $server_uri, $start_session);

+        phpCAS :: traceEnd();

+    }

+

+    /**

+     * phpCAS proxy initializer.

+     * @note Only one of the phpCAS::client() and phpCAS::proxy functions should be

+     * called, only once, and before all other methods (except phpCAS::getVersion()

+     * and phpCAS::setDebug()).

+     *

+     * @param $server_version the version of the CAS server

+     * @param $server_hostname the hostname of the CAS server

+     * @param $server_port the port the CAS server is running on

+     * @param $server_uri the URI the CAS server is responding on

+     * @param $start_session Have phpCAS start PHP sessions (default true)

+     *

+     * @return a newly created CASClient object

+     */

+    function proxy($server_version, $server_hostname, $server_port, $server_uri, $start_session = true) {

+        global $PHPCAS_CLIENT, $PHPCAS_INIT_CALL;

+

+        phpCAS :: traceBegin();

+        if (is_object($PHPCAS_CLIENT)) {

+            phpCAS :: error($PHPCAS_INIT_CALL['method'] . '() has already been called (at ' . $PHPCAS_INIT_CALL['file'] . ':' . $PHPCAS_INIT_CALL['line'] . ')');

+        }

+        if (gettype($server_version) != 'string') {

+            phpCAS :: error('type mismatched for parameter $server_version (should be `string\')');

+        }

+        if (gettype($server_hostname) != 'string') {

+            phpCAS :: error('type mismatched for parameter $server_hostname (should be `string\')');

+        }

+        if (gettype($server_port) != 'integer') {

+            phpCAS :: error('type mismatched for parameter $server_port (should be `integer\')');

+        }

+        if (gettype($server_uri) != 'string') {

+            phpCAS :: error('type mismatched for parameter $server_uri (should be `string\')');

+        }

+

+        // store where the initialzer is called from

+        $dbg = phpCAS :: backtrace();

+        $PHPCAS_INIT_CALL = array (

+            'done' => TRUE,

+            'file' => $dbg[0]['file'],

+            'line' => $dbg[0]['line'],

+            'method' => __CLASS__ . '::' . __FUNCTION__

+        );

+

+        // initialize the global object $PHPCAS_CLIENT

+        $PHPCAS_CLIENT = new CASClient($server_version, TRUE /*proxy*/

+        , $server_hostname, $server_port, $server_uri, $start_session);

+        phpCAS :: traceEnd();

+    }

+

+    /** @} */

+    // ########################################################################

+    //  DEBUGGING

+    // ########################################################################

+

+    /**

+     * @addtogroup publicDebug

+     * @{

+     */

+

+    /**

+     * Set/unset debug mode

+     *

+     * @param $filename the name of the file used for logging, or FALSE to stop debugging.

+     */

+    function setDebug($filename = '') {

+        global $PHPCAS_DEBUG;

+

+        if ($filename != FALSE && gettype($filename) != 'string') {

+            phpCAS :: error('type mismatched for parameter $dbg (should be FALSE or the name of the log file)');

+        }

+

+        if (empty ($filename)) {

+            if (preg_match('/^Win.*/', getenv('OS'))) {

+                if (isset ($_ENV['TMP'])) {

+                    $debugDir = $_ENV['TMP'] . '/';

+                } else

+                    if (isset ($_ENV['TEMP'])) {

+                        $debugDir = $_ENV['TEMP'] . '/';

+                    } else {

+                        $debugDir = '';

+                    }

+            } else {

+                $debugDir = DEFAULT_DEBUG_DIR;

+            }

+            $filename = $debugDir . 'phpCAS.log';

+        }

+

+        if (empty ($PHPCAS_DEBUG['unique_id'])) {

+            $PHPCAS_DEBUG['unique_id'] = substr(strtoupper(md5(uniqid(''))), 0, 4);

+        }

+

+        $PHPCAS_DEBUG['filename'] = $filename;

+

+        phpCAS :: trace('START ******************');

+    }

+

+    /** @} */

+    /**

+     * @addtogroup internalDebug

+     * @{

+     */

+

+    /**

+     * This method is a wrapper for debug_backtrace() that is not available 

+     * in all PHP versions (>= 4.3.0 only)

+     */

+    function backtrace() {

+        if (function_exists('debug_backtrace')) {

+            return debug_backtrace();

+        } else {

+            // poor man's hack ... but it does work ...

+            return array ();

+        }

+    }

+

+    /**

+     * Logs a string in debug mode.

+     *

+     * @param $str the string to write

+     *

+     * @private

+     */

+    function log($str) {

+        $indent_str = ".";

+        global $PHPCAS_DEBUG;

+

+        if ($PHPCAS_DEBUG['filename']) {

+            for ($i = 0; $i < $PHPCAS_DEBUG['indent']; $i++) {

+                $indent_str .= '|    ';

+            }

+            error_log($PHPCAS_DEBUG['unique_id'] . ' ' . $indent_str . $str . "\n", 3, $PHPCAS_DEBUG['filename']);

+        }

+

+    }

+

+    /**

+     * This method is used by interface methods to print an error and where the function

+     * was originally called from.

+     *

+     * @param $msg the message to print

+     *

+     * @private

+     */

+    function error($msg) {

+        $dbg = phpCAS :: backtrace();

+        $function = '?';

+        $file = '?';

+        $line = '?';

+        if (is_array($dbg)) {

+            for ($i = 1; $i < sizeof($dbg); $i++) {

+                if (is_array($dbg[$i])) {

+                    if ($dbg[$i]['class'] == __CLASS__) {

+                        $function = $dbg[$i]['function'];

+                        $file = $dbg[$i]['file'];

+                        $line = $dbg[$i]['line'];

+                    }

+                }

+            }

+        }

+        echo "<br />\n<b>phpCAS error</b>: <font color=\"FF0000\"><b>" . __CLASS__ . "::" . $function . '(): ' . htmlentities($msg) . "</b></font> in <b>" . $file . "</b> on line <b>" . $line . "</b><br />\n";

+        phpCAS :: trace($msg);

+        phpCAS :: traceExit();

+        exit ();

+    }

+

+    /**

+     * This method is used to log something in debug mode.

+     */

+    function trace($str) {

+        $dbg = phpCAS :: backtrace();

+        phpCAS :: log($str . ' [' . basename($dbg[1]['file']) . ':' . $dbg[1]['line'] . ']');

+    }

+

+    /**

+     * This method is used to indicate the start of the execution of a function in debug mode.

+     */

+    function traceBegin() {

+        global $PHPCAS_DEBUG;

+

+        $dbg = phpCAS :: backtrace();

+        $str = '=> ';

+        if (!empty ($dbg[2]['class'])) {

+            $str .= $dbg[2]['class'] . '::';

+        }

+        $str .= $dbg[2]['function'] . '(';

+        if (is_array($dbg[2]['args'])) {

+            foreach ($dbg[2]['args'] as $index => $arg) {

+                if ($index != 0) {

+                    $str .= ', ';

+                }

+                $str .= str_replace("\n", "", var_export($arg, TRUE));

+            }

+        }

+        $str .= ') [' . basename($dbg[2]['file']) . ':' . $dbg[2]['line'] . ']';

+        phpCAS :: log($str);

+        $PHPCAS_DEBUG['indent']++;

+    }

+

+    /**

+     * This method is used to indicate the end of the execution of a function in debug mode.

+     *

+     * @param $res the result of the function

+     */

+    function traceEnd($res = '') {

+        global $PHPCAS_DEBUG;

+

+        $PHPCAS_DEBUG['indent']--;

+        $dbg = phpCAS :: backtrace();

+        $str = '';

+        $str .= '<= ' . str_replace("\n", "", var_export($res, TRUE));

+        phpCAS :: log($str);

+    }

+

+    /**

+     * This method is used to indicate the end of the execution of the program

+     */

+    function traceExit() {

+        global $PHPCAS_DEBUG;

+

+        phpCAS :: log('exit()');

+        while ($PHPCAS_DEBUG['indent'] > 0) {

+            phpCAS :: log('-');

+            $PHPCAS_DEBUG['indent']--;

+        }

+    }

+

+    /** @} */

+    // ########################################################################

+    //  INTERNATIONALIZATION

+    // ########################################################################

+    /**

+     * @addtogroup publicLang

+     * @{

+     */

+

+    /**

+     * This method is used to set the language used by phpCAS. 

+     * @note Can be called only once.

+     *

+     * @param $lang a string representing the language.

+     *

+     * @sa PHPCAS_LANG_FRENCH, PHPCAS_LANG_ENGLISH

+     */

+    function setLang($lang) {

+        global $PHPCAS_CLIENT;

+        if (!is_object($PHPCAS_CLIENT)) {

+            phpCAS :: error('this method should not be called before ' . __CLASS__ . '::client() or ' . __CLASS__ . '::proxy()');

+        }

+        if (gettype($lang) != 'string') {

+            phpCAS :: error('type mismatched for parameter $lang (should be `string\')');

+        }

+        $PHPCAS_CLIENT->setLang($lang);

+    }

+

+    /** @} */

+    // ########################################################################

+    //  VERSION

+    // ########################################################################

+    /**

+     * @addtogroup public

+     * @{

+     */

+

+    /**

+     * This method returns the phpCAS version.

+     *

+     * @return the phpCAS version.

+     */

+    function getVersion() {

+        return PHPCAS_VERSION;

+    }

+

+    /** @} */

+    // ########################################################################

+    //  HTML OUTPUT

+    // ########################################################################

+    /**

+     * @addtogroup publicOutput

+     * @{

+     */

+

+    /**

+     * This method sets the HTML header used for all outputs.

+     *

+     * @param $header the HTML header.

+     */

+    function setHTMLHeader($header) {

+        global $PHPCAS_CLIENT;

+        if (!is_object($PHPCAS_CLIENT)) {

+            phpCAS :: error('this method should not be called before ' . __CLASS__ . '::client() or ' . __CLASS__ . '::proxy()');

+        }

+        if (gettype($header) != 'string') {

+            phpCAS :: error('type mismatched for parameter $header (should be `string\')');

+        }

+        $PHPCAS_CLIENT->setHTMLHeader($header);

+    }

+

+    /**

+     * This method sets the HTML footer used for all outputs.

+     *

+     * @param $footer the HTML footer.

+     */

+    function setHTMLFooter($footer) {

+        global $PHPCAS_CLIENT;

+        if (!is_object($PHPCAS_CLIENT)) {

+            phpCAS :: error('this method should not be called before ' . __CLASS__ . '::client() or ' . __CLASS__ . '::proxy()');

+        }

+        if (gettype($footer) != 'string') {

+            phpCAS :: error('type mismatched for parameter $footer (should be `string\')');

+        }

+        $PHPCAS_CLIENT->setHTMLFooter($footer);

+    }

+

+    /** @} */

+    // ########################################################################

+    //  PGT STORAGE

+    // ########################################################################

+    /**

+     * @addtogroup publicPGTStorage

+     * @{

+     */

+

+    /**

+     * This method is used to tell phpCAS to store the response of the

+     * CAS server to PGT requests onto the filesystem. 

+     *

+     * @param $format the format used to store the PGT's (`plain' and `xml' allowed)

+     * @param $path the path where the PGT's should be stored

+     */

+    function setPGTStorageFile($format = '', $path = '') {

+        global $PHPCAS_CLIENT, $PHPCAS_AUTH_CHECK_CALL;

+

+        phpCAS :: traceBegin();

+        if (!is_object($PHPCAS_CLIENT)) {

+            phpCAS :: error('this method should only be called after ' . __CLASS__ . '::proxy()');

+        }

+        if (!$PHPCAS_CLIENT->isProxy()) {

+            phpCAS :: error('this method should only be called after ' . __CLASS__ . '::proxy()');

+        }

+        if ($PHPCAS_AUTH_CHECK_CALL['done']) {

+            phpCAS :: error('this method should only be called before ' . $PHPCAS_AUTH_CHECK_CALL['method'] . '() (called at ' . $PHPCAS_AUTH_CHECK_CALL['file'] . ':' . $PHPCAS_AUTH_CHECK_CALL['line'] . ')');

+        }

+        if (gettype($format) != 'string') {

+            phpCAS :: error('type mismatched for parameter $format (should be `string\')');

+        }

+        if (gettype($path) != 'string') {

+            phpCAS :: error('type mismatched for parameter $format (should be `string\')');

+        }

+        $PHPCAS_CLIENT->setPGTStorageFile($format, $path);

+        phpCAS :: traceEnd();

+    }

+

+    /**

+     * This method is used to tell phpCAS to store the response of the

+     * CAS server to PGT requests into a database. 

+     * @note The connection to the database is done only when needed. 

+     * As a consequence, bad parameters are detected only when 

+     * initializing PGT storage, except in debug mode.

+     *

+     * @param $user the user to access the data with

+     * @param $password the user's password

+     * @param $database_type the type of the database hosting the data

+     * @param $hostname the server hosting the database

+     * @param $port the port the server is listening on

+     * @param $database the name of the database

+     * @param $table the name of the table storing the data

+     */

+    function setPGTStorageDB($user, $password, $database_type = '', $hostname = '', $port = 0, $database = '', $table = '') {

+        global $PHPCAS_CLIENT, $PHPCAS_AUTH_CHECK_CALL;

+

+        phpCAS :: traceBegin();

+        if (!is_object($PHPCAS_CLIENT)) {

+            phpCAS :: error('this method should only be called after ' . __CLASS__ . '::proxy()');

+        }

+        if (!$PHPCAS_CLIENT->isProxy()) {

+            phpCAS :: error('this method should only be called after ' . __CLASS__ . '::proxy()');

+        }

+        if ($PHPCAS_AUTH_CHECK_CALL['done']) {

+            phpCAS :: error('this method should only be called before ' . $PHPCAS_AUTH_CHECK_CALL['method'] . '() (called at ' . $PHPCAS_AUTH_CHECK_CALL['file'] . ':' . $PHPCAS_AUTH_CHECK_CALL['line'] . ')');

+        }

+        if (gettype($user) != 'string') {

+            phpCAS :: error('type mismatched for parameter $user (should be `string\')');

+        }

+        if (gettype($password) != 'string') {

+            phpCAS :: error('type mismatched for parameter $password (should be `string\')');

+        }

+        if (gettype($database_type) != 'string') {

+            phpCAS :: error('type mismatched for parameter $database_type (should be `string\')');

+        }

+        if (gettype($hostname) != 'string') {

+            phpCAS :: error('type mismatched for parameter $hostname (should be `string\')');

+        }

+        if (gettype($port) != 'integer') {

+            phpCAS :: error('type mismatched for parameter $port (should be `integer\')');

+        }

+        if (gettype($database) != 'string') {

+            phpCAS :: error('type mismatched for parameter $database (should be `string\')');

+        }

+        if (gettype($table) != 'string') {

+            phpCAS :: error('type mismatched for parameter $table (should be `string\')');

+        }

+        $PHPCAS_CLIENT->setPGTStorageDB($user, $password, $database_type, $hostname, $port, $database, $table);

+        phpCAS :: traceEnd();

+    }

+

+    /** @} */

+    // ########################################################################

+    // ACCESS TO EXTERNAL SERVICES

+    // ########################################################################

+    /**

+     * @addtogroup publicServices

+     * @{

+     */

+

+    /**

+     * This method is used to access an HTTP[S] service.

+     * 

+     * @param $url the service to access.

+     * @param $err_code an error code Possible values are PHPCAS_SERVICE_OK (on

+     * success), PHPCAS_SERVICE_PT_NO_SERVER_RESPONSE, PHPCAS_SERVICE_PT_BAD_SERVER_RESPONSE,

+     * PHPCAS_SERVICE_PT_FAILURE, PHPCAS_SERVICE_NOT AVAILABLE.

+     * @param $output the output of the service (also used to give an error

+     * message on failure).

+     *

+     * @return TRUE on success, FALSE otherwise (in this later case, $err_code

+     * gives the reason why it failed and $output contains an error message).

+     */

+    function serviceWeb($url, & $err_code, & $output) {

+        global $PHPCAS_CLIENT, $PHPCAS_AUTH_CHECK_CALL;

+

+        phpCAS :: traceBegin();

+        if (!is_object($PHPCAS_CLIENT)) {

+            phpCAS :: error('this method should only be called after ' . __CLASS__ . '::proxy()');

+        }

+        if (!$PHPCAS_CLIENT->isProxy()) {

+            phpCAS :: error('this method should only be called after ' . __CLASS__ . '::proxy()');

+        }

+        if (!$PHPCAS_AUTH_CHECK_CALL['done']) {

+            phpCAS :: error('this method should only be called after the programmer is sure the user has been authenticated (by calling ' . __CLASS__ . '::checkAuthentication() or ' . __CLASS__ . '::forceAuthentication()');

+        }

+        if (!$PHPCAS_AUTH_CHECK_CALL['result']) {

+            phpCAS :: error('authentication was checked (by ' . $PHPCAS_AUTH_CHECK_CALL['method'] . '() at ' . $PHPCAS_AUTH_CHECK_CALL['file'] . ':' . $PHPCAS_AUTH_CHECK_CALL['line'] . ') but the method returned FALSE');

+        }

+        if (gettype($url) != 'string') {

+            phpCAS :: error('type mismatched for parameter $url (should be `string\')');

+        }

+

+        $res = $PHPCAS_CLIENT->serviceWeb($url, $err_code, $output);

+

+        phpCAS :: traceEnd($res);

+        return $res;

+    }

+

+    /**

+     * This method is used to access an IMAP/POP3/NNTP service.

+     * 

+     * @param $url a string giving the URL of the service, including the mailing box

+     * for IMAP URLs, as accepted by imap_open().

+     * @param $service a string giving for CAS retrieve Proxy ticket

+     * @param $flags options given to imap_open().

+     * @param $err_code an error code Possible values are PHPCAS_SERVICE_OK (on

+     * success), PHPCAS_SERVICE_PT_NO_SERVER_RESPONSE, PHPCAS_SERVICE_PT_BAD_SERVER_RESPONSE,

+     * PHPCAS_SERVICE_PT_FAILURE, PHPCAS_SERVICE_NOT AVAILABLE.

+     * @param $err_msg an error message on failure

+     * @param $pt the Proxy Ticket (PT) retrieved from the CAS server to access the URL

+     * on success, FALSE on error).

+     *

+     * @return an IMAP stream on success, FALSE otherwise (in this later case, $err_code

+     * gives the reason why it failed and $err_msg contains an error message).

+     */

+    function serviceMail($url, $service, $flags, & $err_code, & $err_msg, & $pt) {

+        global $PHPCAS_CLIENT, $PHPCAS_AUTH_CHECK_CALL;

+

+        phpCAS :: traceBegin();

+        if (!is_object($PHPCAS_CLIENT)) {

+            phpCAS :: error('this method should only be called after ' . __CLASS__ . '::proxy()');

+        }

+        if (!$PHPCAS_CLIENT->isProxy()) {

+            phpCAS :: error('this method should only be called after ' . __CLASS__ . '::proxy()');

+        }

+        if (!$PHPCAS_AUTH_CHECK_CALL['done']) {

+            phpCAS :: error('this method should only be called after the programmer is sure the user has been authenticated (by calling ' . __CLASS__ . '::checkAuthentication() or ' . __CLASS__ . '::forceAuthentication()');

+        }

+        if (!$PHPCAS_AUTH_CHECK_CALL['result']) {

+            phpCAS :: error('authentication was checked (by ' . $PHPCAS_AUTH_CHECK_CALL['method'] . '() at ' . $PHPCAS_AUTH_CHECK_CALL['file'] . ':' . $PHPCAS_AUTH_CHECK_CALL['line'] . ') but the method returned FALSE');

+        }

+        if (gettype($url) != 'string') {

+            phpCAS :: error('type mismatched for parameter $url (should be `string\')');

+        }

+

+        if (gettype($flags) != 'integer') {

+            phpCAS :: error('type mismatched for parameter $flags (should be `integer\')');

+        }

+

+        $res = $PHPCAS_CLIENT->serviceMail($url, $service, $flags, $err_code, $err_msg, $pt);

+

+        phpCAS :: traceEnd($res);

+        return $res;

+    }

+

+    /** @} */

+    // ########################################################################

+    //  AUTHENTICATION

+    // ########################################################################

+    /**

+     * @addtogroup publicAuth

+     * @{

+     */

+

+    /**

+     * Set the times authentication will be cached before really accessing the CAS server in gateway mode: 

+     * - -1: check only once, and then never again (until you pree login)

+     * - 0: always check

+     * - n: check every "n" time

+     *

+     * @param $n an integer.

+     */

+    function setCacheTimesForAuthRecheck($n) {

+        global $PHPCAS_CLIENT;

+        if (!is_object($PHPCAS_CLIENT)) {

+            phpCAS :: error('this method should not be called before ' . __CLASS__ . '::client() or ' . __CLASS__ . '::proxy()');

+        }

+        if (gettype($n) != 'integer') {

+            phpCAS :: error('type mismatched for parameter $header (should be `string\')');

+        }

+        $PHPCAS_CLIENT->setCacheTimesForAuthRecheck($n);

+    }

+

+    /**

+     * This method is called to check if the user is authenticated (use the gateway feature).

+     * @return TRUE when the user is authenticated; otherwise FALSE.

+     */

+    function checkAuthentication() {

+        global $PHPCAS_CLIENT, $PHPCAS_AUTH_CHECK_CALL;

+

+        phpCAS :: traceBegin();

+        if (!is_object($PHPCAS_CLIENT)) {

+            phpCAS :: error('this method should not be called before ' . __CLASS__ . '::client() or ' . __CLASS__ . '::proxy()');

+        }

+

+        $auth = $PHPCAS_CLIENT->checkAuthentication();

+

+        // store where the authentication has been checked and the result

+        $dbg = phpCAS :: backtrace();

+        $PHPCAS_AUTH_CHECK_CALL = array (

+            'done' => TRUE,

+            'file' => $dbg[0]['file'],

+            'line' => $dbg[0]['line'],

+            'method' => __CLASS__ . '::' . __FUNCTION__,

+            'result' => $auth

+        );

+        phpCAS :: traceEnd($auth);

+        return $auth;

+    }

+

+    /**

+     * This method is called to force authentication if the user was not already 

+     * authenticated. If the user is not authenticated, halt by redirecting to 

+     * the CAS server.

+     */

+    function forceAuthentication() {

+        global $PHPCAS_CLIENT, $PHPCAS_AUTH_CHECK_CALL;

+

+        phpCAS :: traceBegin();

+        if (!is_object($PHPCAS_CLIENT)) {

+            phpCAS :: error('this method should not be called before ' . __CLASS__ . '::client() or ' . __CLASS__ . '::proxy()');

+        }

+

+        $auth = $PHPCAS_CLIENT->forceAuthentication();

+

+        // store where the authentication has been checked and the result

+        $dbg = phpCAS :: backtrace();

+        $PHPCAS_AUTH_CHECK_CALL = array (

+            'done' => TRUE,

+            'file' => $dbg[0]['file'],

+            'line' => $dbg[0]['line'],

+            'method' => __CLASS__ . '::' . __FUNCTION__,

+            'result' => $auth

+        );

+

+        if (!$auth) {

+            phpCAS :: trace('user is not authenticated, redirecting to the CAS server');

+            $PHPCAS_CLIENT->forceAuthentication();

+        } else {

+            phpCAS :: trace('no need to authenticate (user `' . phpCAS :: getUser() . '\' is already authenticated)');

+        }

+

+        phpCAS :: traceEnd();

+        return $auth;

+    }

+

+    /**

+     * This method is called to renew the authentication.

+     **/

+    function renewAuthentication() {

+        global $PHPCAS_CLIENT, $PHPCAS_AUTH_CHECK_CALL;

+

+        phpCAS :: traceBegin();

+        if (!is_object($PHPCAS_CLIENT)) {

+            phpCAS :: error('this method should not be called before' . __CLASS__ . '::client() or ' . __CLASS__ . '::proxy()');

+        }

+

+        // store where the authentication has been checked and the result

+        $dbg = phpCAS :: backtrace();

+        $PHPCAS_AUTH_CHECK_CALL = array (

+            'done' => TRUE,

+            'file' => $dbg[0]['file'],

+            'line' => $dbg[0]['line'],

+            'method' => __CLASS__ . '::' . __FUNCTION__,

+            'result' => $auth

+        );

+

+        $PHPCAS_CLIENT->renewAuthentication();

+        phpCAS :: traceEnd();

+    }

+

+    /**

+     * This method has been left from version 0.4.1 for compatibility reasons.

+     */

+    function authenticate() {

+        phpCAS :: error('this method is deprecated. You should use ' . __CLASS__ . '::forceAuthentication() instead');

+    }

+

+    /**

+     * This method is called to check if the user is authenticated (previously or by

+     * tickets given in the URL).

+     *

+     * @return TRUE when the user is authenticated.

+     */

+    function isAuthenticated() {

+        global $PHPCAS_CLIENT, $PHPCAS_AUTH_CHECK_CALL;

+

+        phpCAS :: traceBegin();

+        if (!is_object($PHPCAS_CLIENT)) {

+            phpCAS :: error('this method should not be called before ' . __CLASS__ . '::client() or ' . __CLASS__ . '::proxy()');

+        }

+

+        // call the isAuthenticated method of the global $PHPCAS_CLIENT object

+        $auth = $PHPCAS_CLIENT->isAuthenticated();

+

+        // store where the authentication has been checked and the result

+        $dbg = phpCAS :: backtrace();

+        $PHPCAS_AUTH_CHECK_CALL = array (

+            'done' => TRUE,

+            'file' => $dbg[0]['file'],

+            'line' => $dbg[0]['line'],

+            'method' => __CLASS__ . '::' . __FUNCTION__,

+            'result' => $auth

+        );

+        phpCAS :: traceEnd($auth);

+        return $auth;

+    }

+

+    /**

+     * Checks whether authenticated based on $_SESSION. Useful to avoid

+     * server calls.

+     * @return true if authenticated, false otherwise.

+     * @since 0.4.22 by Brendan Arnold

+     */

+    function isSessionAuthenticated() {

+        global $PHPCAS_CLIENT;

+        if (!is_object($PHPCAS_CLIENT)) {

+            phpCAS :: error('this method should not be called before ' . __CLASS__ . '::client() or ' . __CLASS__ . '::proxy()');

+        }

+        return ($PHPCAS_CLIENT->isSessionAuthenticated());

+    }

+

+    /**

+     * This method returns the CAS user's login name.

+     * @warning should not be called only after phpCAS::forceAuthentication()

+     * or phpCAS::checkAuthentication().

+     *

+     * @return the login name of the authenticated user

+     */

+    function getUser() {

+        global $PHPCAS_CLIENT, $PHPCAS_AUTH_CHECK_CALL;

+        if (!is_object($PHPCAS_CLIENT)) {

+            phpCAS :: error('this method should not be called before ' . __CLASS__ . '::client() or ' . __CLASS__ . '::proxy()');

+        }

+        if (!$PHPCAS_AUTH_CHECK_CALL['done']) {

+            phpCAS :: error('this method should only be called after ' . __CLASS__ . '::forceAuthentication() or ' . __CLASS__ . '::isAuthenticated()');

+        }

+        if (!$PHPCAS_AUTH_CHECK_CALL['result']) {

+            phpCAS :: error('authentication was checked (by ' . $PHPCAS_AUTH_CHECK_CALL['method'] . '() at ' . $PHPCAS_AUTH_CHECK_CALL['file'] . ':' . $PHPCAS_AUTH_CHECK_CALL['line'] . ') but the method returned FALSE');

+        }

+        return $PHPCAS_CLIENT->getUser();

+    }

+

+    /**

+     * This method returns the CAS user's login name.

+     * @warning should not be called only after phpCAS::forceAuthentication()

+     * or phpCAS::checkAuthentication().

+     *

+     * @return the login name of the authenticated user

+     */

+    function getAttributes() {

+        global $PHPCAS_CLIENT, $PHPCAS_AUTH_CHECK_CALL;

+        if (!is_object($PHPCAS_CLIENT)) {

+            phpCAS :: error('this method should not be called before ' . __CLASS__ . '::client() or ' . __CLASS__ . '::proxy()');

+        }

+        if (!$PHPCAS_AUTH_CHECK_CALL['done']) {

+            phpCAS :: error('this method should only be called after ' . __CLASS__ . '::forceAuthentication() or ' . __CLASS__ . '::isAuthenticated()');

+        }

+        if (!$PHPCAS_AUTH_CHECK_CALL['result']) {

+            phpCAS :: error('authentication was checked (by ' . $PHPCAS_AUTH_CHECK_CALL['method'] . '() at ' . $PHPCAS_AUTH_CHECK_CALL['file'] . ':' . $PHPCAS_AUTH_CHECK_CALL['line'] . ') but the method returned FALSE');

+        }

+        return $PHPCAS_CLIENT->getAttributes();

+    }

+    /**

+     * Handle logout requests.

+     */

+    function handleLogoutRequests($check_client = true, $allowed_clients = false) {

+        global $PHPCAS_CLIENT;

+        if (!is_object($PHPCAS_CLIENT)) {

+            phpCAS :: error('this method should not be called before ' . __CLASS__ . '::client() or ' . __CLASS__ . '::proxy()');

+        }

+        return ($PHPCAS_CLIENT->handleLogoutRequests($check_client, $allowed_clients));

+    }

+

+    /**

+     * This method returns the URL to be used to login.

+     * or phpCAS::isAuthenticated().

+     *

+     * @return the login name of the authenticated user

+     */

+    function getServerLoginURL() {

+        global $PHPCAS_CLIENT;

+        if (!is_object($PHPCAS_CLIENT)) {

+            phpCAS :: error('this method should not be called before ' . __CLASS__ . '::client() or ' . __CLASS__ . '::proxy()');

+        }

+        return $PHPCAS_CLIENT->getServerLoginURL();

+    }

+

+    /**

+     * Set the login URL of the CAS server.

+     * @param $url the login URL

+     * @since 0.4.21 by Wyman Chan

+     */

+    function setServerLoginURL($url = '') {

+        global $PHPCAS_CLIENT;

+        phpCAS :: traceBegin();

+        if (!is_object($PHPCAS_CLIENT)) {

+            phpCAS :: error('this method should only be called after

 							' . __CLASS__ . '::client()');

-		}

-		if (gettype($url) != 'string') {

-			phpCAS :: error('type mismatched for parameter $url (should be

+        }

+        if (gettype($url) != 'string') {

+            phpCAS :: error('type mismatched for parameter $url (should be

 						`string\')');

-		}

-		$PHPCAS_CLIENT->setServerLoginURL($url);

-		phpCAS :: traceEnd();

-	}

-

-	/**

-	 * Set the serviceValidate URL of the CAS server.

-	 * Used only in CAS 1.0 validations

-	 * @param $url the serviceValidate URL

-	 * @since 1.1.0 by Joachim Fritschi

-	 */

-	function setServerServiceValidateURL($url = '') {

-		global $PHPCAS_CLIENT;

-		phpCAS :: traceBegin();

-		if (!is_object($PHPCAS_CLIENT)) {

-			phpCAS :: error('this method should only be called after

+        }

+        $PHPCAS_CLIENT->setServerLoginURL($url);

+        phpCAS :: traceEnd();

+    }

+

+    /**

+     * Set the serviceValidate URL of the CAS server.

+     * Used only in CAS 1.0 validations

+     * @param $url the serviceValidate URL

+     * @since 1.1.0 by Joachim Fritschi

+     */

+    function setServerServiceValidateURL($url = '') {

+        global $PHPCAS_CLIENT;

+        phpCAS :: traceBegin();

+        if (!is_object($PHPCAS_CLIENT)) {

+            phpCAS :: error('this method should only be called after

 							' . __CLASS__ . '::client()');

-		}

-		if (gettype($url) != 'string') {

-			phpCAS :: error('type mismatched for parameter $url (should be

+        }

+        if (gettype($url) != 'string') {

+            phpCAS :: error('type mismatched for parameter $url (should be

 						`string\')');

-		}

-		$PHPCAS_CLIENT->setServerServiceValidateURL($url);

-		phpCAS :: traceEnd();

-	}

-

-	/**

-	 * Set the proxyValidate URL of the CAS server.

-	 * Used for all CAS 2.0 validations

-	 * @param $url the proxyValidate URL

-	 * @since 1.1.0 by Joachim Fritschi

-	 */

-	function setServerProxyValidateURL($url = '') {

-		global $PHPCAS_CLIENT;

-		phpCAS :: traceBegin();

-		if (!is_object($PHPCAS_CLIENT)) {

-			phpCAS :: error('this method should only be called after

+        }

+        $PHPCAS_CLIENT->setServerServiceValidateURL($url);

+        phpCAS :: traceEnd();

+    }

+

+    /**

+     * Set the proxyValidate URL of the CAS server.

+     * Used for all CAS 2.0 validations

+     * @param $url the proxyValidate URL

+     * @since 1.1.0 by Joachim Fritschi

+     */

+    function setServerProxyValidateURL($url = '') {

+        global $PHPCAS_CLIENT;

+        phpCAS :: traceBegin();

+        if (!is_object($PHPCAS_CLIENT)) {

+            phpCAS :: error('this method should only be called after

 							' . __CLASS__ . '::client()');

-		}

-		if (gettype($url) != 'string') {

-			phpCAS :: error('type mismatched for parameter $url (should be

+        }

+        if (gettype($url) != 'string') {

+            phpCAS :: error('type mismatched for parameter $url (should be

 						`string\')');

-		}

-		$PHPCAS_CLIENT->setServerProxyValidateURL($url);

-		phpCAS :: traceEnd();

-	}

-

-	/**

-	 * Set the samlValidate URL of the CAS server.

-	 * @param $url the samlValidate URL

-	 * @since 1.1.0 by Joachim Fritschi

-	 */

-	function setServerSamlValidateURL($url = '') {

-		global $PHPCAS_CLIENT;

-		phpCAS :: traceBegin();

-		if (!is_object($PHPCAS_CLIENT)) {

-			phpCAS :: error('this method should only be called after

+        }

+        $PHPCAS_CLIENT->setServerProxyValidateURL($url);

+        phpCAS :: traceEnd();

+    }

+

+    /**

+     * Set the samlValidate URL of the CAS server.

+     * @param $url the samlValidate URL

+     * @since 1.1.0 by Joachim Fritschi

+     */

+    function setServerSamlValidateURL($url = '') {

+        global $PHPCAS_CLIENT;

+        phpCAS :: traceBegin();

+        if (!is_object($PHPCAS_CLIENT)) {

+            phpCAS :: error('this method should only be called after

 							' . __CLASS__ . '::client()');

-		}

-		if (gettype($url) != 'string') {

-			phpCAS :: error('type mismatched for parameter $url (should be

+        }

+        if (gettype($url) != 'string') {

+            phpCAS :: error('type mismatched for parameter $url (should be

 						`string\')');

-		}

-		$PHPCAS_CLIENT->setServerSamlValidateURL($url);

-		phpCAS :: traceEnd();

-	}

-

-	/**

-	 * This method returns the URL to be used to login.

-	 * or phpCAS::isAuthenticated().

-	 *

-	 * @return the login name of the authenticated user

-	 */

-	function getServerLogoutURL() {

-		global $PHPCAS_CLIENT;

-		if (!is_object($PHPCAS_CLIENT)) {

-			phpCAS :: error('this method should not be called before ' . __CLASS__ . '::client() or ' . __CLASS__ . '::proxy()');

-		}

-		return $PHPCAS_CLIENT->getServerLogoutURL();

-	}

-

-	/**

-	 * Set the logout URL of the CAS server.

-	 * @param $url the logout URL

-	 * @since 0.4.21 by Wyman Chan

-	 */

-	function setServerLogoutURL($url = '') {

-		global $PHPCAS_CLIENT;

-		phpCAS :: traceBegin();

-		if (!is_object($PHPCAS_CLIENT)) {

-			phpCAS :: error('this method should only be called after

+        }

+        $PHPCAS_CLIENT->setServerSamlValidateURL($url);

+        phpCAS :: traceEnd();

+    }

+

+    /**

+     * This method returns the URL to be used to login.

+     * or phpCAS::isAuthenticated().

+     *

+     * @return the login name of the authenticated user

+     */

+    function getServerLogoutURL() {

+        global $PHPCAS_CLIENT;

+        if (!is_object($PHPCAS_CLIENT)) {

+            phpCAS :: error('this method should not be called before ' . __CLASS__ . '::client() or ' . __CLASS__ . '::proxy()');

+        }

+        return $PHPCAS_CLIENT->getServerLogoutURL();

+    }

+

+    /**

+     * Set the logout URL of the CAS server.

+     * @param $url the logout URL

+     * @since 0.4.21 by Wyman Chan

+     */

+    function setServerLogoutURL($url = '') {

+        global $PHPCAS_CLIENT;

+        phpCAS :: traceBegin();

+        if (!is_object($PHPCAS_CLIENT)) {

+            phpCAS :: error('this method should only be called after

 							' . __CLASS__ . '::client()');

-		}

-		if (gettype($url) != 'string') {

-			phpCAS :: error('type mismatched for parameter $url (should be

+        }

+        if (gettype($url) != 'string') {

+            phpCAS :: error('type mismatched for parameter $url (should be

 						`string\')');

-		}

-		$PHPCAS_CLIENT->setServerLogoutURL($url);

-		phpCAS :: traceEnd();

-	}

-

-	/**

-	 * This method is used to logout from CAS.

-	 * @params $params an array that contains the optional url and service parameters that will be passed to the CAS server

-	 * @public

-	 */

-	function logout($params = "") {

-		global $PHPCAS_CLIENT;

-		phpCAS :: traceBegin();

-		if (!is_object($PHPCAS_CLIENT)) {

-			phpCAS :: error('this method should only be called after ' . __CLASS__ . '::client() or' . __CLASS__ . '::proxy()');

-		}

-		$parsedParams = array ();

-		if ($params != "") {

-			if (is_string($params)) {

-				phpCAS :: error('method `phpCAS::logout($url)\' is now deprecated, use `phpCAS::logoutWithUrl($url)\' instead');

-			}

-			if (!is_array($params)) {

-				phpCAS :: error('type mismatched for parameter $params (should be `array\')');

-			}

-			foreach ($params as $key => $value) {

-				if ($key != "service" && $key != "url") {

-					phpCAS :: error('only `url\' and `service\' parameters are allowed for method `phpCAS::logout($params)\'');

-				}

-				$parsedParams[$key] = $value;

-			}

-		}

-		$PHPCAS_CLIENT->logout($parsedParams);

-		// never reached

-		phpCAS :: traceEnd();

-	}

-

-	/**

-	 * This method is used to logout from CAS. Halts by redirecting to the CAS server.

-	 * @param $service a URL that will be transmitted to the CAS server

-	 */

-	function logoutWithRedirectService($service) {

-		global $PHPCAS_CLIENT;

-		phpCAS :: traceBegin();

-		if (!is_object($PHPCAS_CLIENT)) {

-			phpCAS :: error('this method should only be called after ' . __CLASS__ . '::client() or' . __CLASS__ . '::proxy()');

-		}

-		if (!is_string($service)) {

-			phpCAS :: error('type mismatched for parameter $service (should be `string\')');

-		}

-		$PHPCAS_CLIENT->logout(array (

-			"service" => $service

-		));

-		// never reached

-		phpCAS :: traceEnd();

-	}

-

-	/**

-	 * This method is used to logout from CAS. Halts by redirecting to the CAS server.

-	 * @param $url a URL that will be transmitted to the CAS server

-	 */

-	function logoutWithUrl($url) {

-		global $PHPCAS_CLIENT;

-		phpCAS :: traceBegin();

-		if (!is_object($PHPCAS_CLIENT)) {

-			phpCAS :: error('this method should only be called after ' . __CLASS__ . '::client() or' . __CLASS__ . '::proxy()');

-		}

-		if (!is_string($url)) {

-			phpCAS :: error('type mismatched for parameter $url (should be `string\')');

-		}

-		$PHPCAS_CLIENT->logout(array (

-			"url" => $url

-		));

-		// never reached

-		phpCAS :: traceEnd();

-	}

-

-	/**

-	 * This method is used to logout from CAS. Halts by redirecting to the CAS server.

-	 * @param $service a URL that will be transmitted to the CAS server

-	 * @param $url a URL that will be transmitted to the CAS server

-	 */

-	function logoutWithRedirectServiceAndUrl($service, $url) {

-		global $PHPCAS_CLIENT;

-		phpCAS :: traceBegin();

-		if (!is_object($PHPCAS_CLIENT)) {

-			phpCAS :: error('this method should only be called after ' . __CLASS__ . '::client() or' . __CLASS__ . '::proxy()');

-		}

-		if (!is_string($service)) {

-			phpCAS :: error('type mismatched for parameter $service (should be `string\')');

-		}

-		if (!is_string($url)) {

-			phpCAS :: error('type mismatched for parameter $url (should be `string\')');

-		}

-		$PHPCAS_CLIENT->logout(array (

-			"service" => $service,

-			"url" => $url

-		));

-		// never reached

-		phpCAS :: traceEnd();

-	}

-

-	/**

-	 * Set the fixed URL that will be used by the CAS server to transmit the PGT.

-	 * When this method is not called, a phpCAS script uses its own URL for the callback.

-	 *

-	 * @param $url the URL

-	 */

-	function setFixedCallbackURL($url = '') {

-		global $PHPCAS_CLIENT;

-		phpCAS :: traceBegin();

-		if (!is_object($PHPCAS_CLIENT)) {

-			phpCAS :: error('this method should only be called after ' . __CLASS__ . '::proxy()');

-		}

-		if (!$PHPCAS_CLIENT->isProxy()) {

-			phpCAS :: error('this method should only be called after ' . __CLASS__ . '::proxy()');

-		}

-		if (gettype($url) != 'string') {

-			phpCAS :: error('type mismatched for parameter $url (should be `string\')');

-		}

-		$PHPCAS_CLIENT->setCallbackURL($url);

-		phpCAS :: traceEnd();

-	}

-

-	/**

-	 * Set the fixed URL that will be set as the CAS service parameter. When this

-	 * method is not called, a phpCAS script uses its own URL.

-	 *

-	 * @param $url the URL

-	 */

-	function setFixedServiceURL($url) {

-		global $PHPCAS_CLIENT;

-		phpCAS :: traceBegin();

-		if (!is_object($PHPCAS_CLIENT)) {

-			phpCAS :: error('this method should only be called after ' . __CLASS__ . '::proxy()');

-		}

-		if (gettype($url) != 'string') {

-			phpCAS :: error('type mismatched for parameter $url (should be `string\')');

-		}

-		$PHPCAS_CLIENT->setURL($url);

-		phpCAS :: traceEnd();

-	}

-

-	/**

-	 * Get the URL that is set as the CAS service parameter.

-	 */

-	function getServiceURL() {

-		global $PHPCAS_CLIENT;

-		if (!is_object($PHPCAS_CLIENT)) {

-			phpCAS :: error('this method should only be called after ' . __CLASS__ . '::proxy()');

-		}

-		return ($PHPCAS_CLIENT->getURL());

-	}

-

-	/**

-	 * Retrieve a Proxy Ticket from the CAS server.

-	 */

-	function retrievePT($target_service, & $err_code, & $err_msg) {

-		global $PHPCAS_CLIENT;

-		if (!is_object($PHPCAS_CLIENT)) {

-			phpCAS :: error('this method should only be called after ' . __CLASS__ . '::proxy()');

-		}

-		if (gettype($target_service) != 'string') {

-			phpCAS :: error('type mismatched for parameter $target_service(should be `string\')');

-		}

-		return ($PHPCAS_CLIENT->retrievePT($target_service, $err_code, $err_msg));

-	}

-

-	/**

-	 * Set the certificate of the CAS server.

-	 *

-	 * @param $cert the PEM certificate

-	 */

-	function setCasServerCert($cert) {

-		global $PHPCAS_CLIENT;

-		phpCAS :: traceBegin();

-		if (!is_object($PHPCAS_CLIENT)) {

-			phpCAS :: error('this method should only be called after ' . __CLASS__ . '::client() or' . __CLASS__ . '::proxy()');

-		}

-		if (gettype($cert) != 'string') {

-			phpCAS :: error('type mismatched for parameter $cert (should be `string\')');

-		}

-		$PHPCAS_CLIENT->setCasServerCert($cert);

-		phpCAS :: traceEnd();

-	}

-

-	/**

-	 * Set the certificate of the CAS server CA.

-	 *

-	 * @param $cert the CA certificate

-	 */

-	function setCasServerCACert($cert) {

-		global $PHPCAS_CLIENT;

-		phpCAS :: traceBegin();

-		if (!is_object($PHPCAS_CLIENT)) {

-			phpCAS :: error('this method should only be called after ' . __CLASS__ . '::client() or' . __CLASS__ . '::proxy()');

-		}

-		if (gettype($cert) != 'string') {

-			phpCAS :: error('type mismatched for parameter $cert (should be `string\')');

-		}

-		$PHPCAS_CLIENT->setCasServerCACert($cert);

-		phpCAS :: traceEnd();

-	}

-

-	/**

-	 * Set no SSL validation for the CAS server.

-	 */

-	function setNoCasServerValidation() {

-		global $PHPCAS_CLIENT;

-		phpCAS :: traceBegin();

-		if (!is_object($PHPCAS_CLIENT)) {

-			phpCAS :: error('this method should only be called after ' . __CLASS__ . '::client() or' . __CLASS__ . '::proxy()');

-		}

-		$PHPCAS_CLIENT->setNoCasServerValidation();

-		phpCAS :: traceEnd();

-	}

-

-	/** @} */

-

-	/**

-	 * Change CURL options.

-	 * CURL is used to connect through HTTPS to CAS server

-	 * @param $key the option key

-	 * @param $value the value to set

-	 */

-	function setExtraCurlOption($key, $value) {

-		global $PHPCAS_CLIENT;

-		phpCAS :: traceBegin();

-		if (!is_object($PHPCAS_CLIENT)) {

-			phpCAS :: error('this method should only be called after ' . __CLASS__ . '::client() or' . __CLASS__ . '::proxy()');

-		}

-		$PHPCAS_CLIENT->setExtraCurlOption($key, $value);

-		phpCAS :: traceEnd();

-	}

+        }

+        $PHPCAS_CLIENT->setServerLogoutURL($url);

+        phpCAS :: traceEnd();

+    }

+

+    /**

+     * This method is used to logout from CAS.

+     * @params $params an array that contains the optional url and service parameters that will be passed to the CAS server

+     * @public

+     */

+    function logout($params = "") {

+        global $PHPCAS_CLIENT;

+        phpCAS :: traceBegin();

+        if (!is_object($PHPCAS_CLIENT)) {

+            phpCAS :: error('this method should only be called after ' . __CLASS__ . '::client() or' . __CLASS__ . '::proxy()');

+        }

+        $parsedParams = array ();

+        if ($params != "") {

+            if (is_string($params)) {

+                phpCAS :: error('method `phpCAS::logout($url)\' is now deprecated, use `phpCAS::logoutWithUrl($url)\' instead');

+            }

+            if (!is_array($params)) {

+                phpCAS :: error('type mismatched for parameter $params (should be `array\')');

+            }

+            foreach ($params as $key => $value) {

+                if ($key != "service" && $key != "url") {

+                    phpCAS :: error('only `url\' and `service\' parameters are allowed for method `phpCAS::logout($params)\'');

+                }

+                $parsedParams[$key] = $value;

+            }

+        }

+        $PHPCAS_CLIENT->logout($parsedParams);

+        // never reached

+        phpCAS :: traceEnd();

+    }

+

+    /**

+     * This method is used to logout from CAS. Halts by redirecting to the CAS server.

+     * @param $service a URL that will be transmitted to the CAS server

+     */

+    function logoutWithRedirectService($service) {

+        global $PHPCAS_CLIENT;

+        phpCAS :: traceBegin();

+        if (!is_object($PHPCAS_CLIENT)) {

+            phpCAS :: error('this method should only be called after ' . __CLASS__ . '::client() or' . __CLASS__ . '::proxy()');

+        }

+        if (!is_string($service)) {

+            phpCAS :: error('type mismatched for parameter $service (should be `string\')');

+        }

+        $PHPCAS_CLIENT->logout(array (

+            "service" => $service

+        ));

+        // never reached

+        phpCAS :: traceEnd();

+    }

+

+    /**

+     * This method is used to logout from CAS. Halts by redirecting to the CAS server.

+     * @param $url a URL that will be transmitted to the CAS server

+     */

+    function logoutWithUrl($url) {

+        global $PHPCAS_CLIENT;

+        phpCAS :: traceBegin();

+        if (!is_object($PHPCAS_CLIENT)) {

+            phpCAS :: error('this method should only be called after ' . __CLASS__ . '::client() or' . __CLASS__ . '::proxy()');

+        }

+        if (!is_string($url)) {

+            phpCAS :: error('type mismatched for parameter $url (should be `string\')');

+        }

+        $PHPCAS_CLIENT->logout(array (

+            "url" => $url

+        ));

+        // never reached

+        phpCAS :: traceEnd();

+    }

+

+    /**

+     * This method is used to logout from CAS. Halts by redirecting to the CAS server.

+     * @param $service a URL that will be transmitted to the CAS server

+     * @param $url a URL that will be transmitted to the CAS server

+     */

+    function logoutWithRedirectServiceAndUrl($service, $url) {

+        global $PHPCAS_CLIENT;

+        phpCAS :: traceBegin();

+        if (!is_object($PHPCAS_CLIENT)) {

+            phpCAS :: error('this method should only be called after ' . __CLASS__ . '::client() or' . __CLASS__ . '::proxy()');

+        }

+        if (!is_string($service)) {

+            phpCAS :: error('type mismatched for parameter $service (should be `string\')');

+        }

+        if (!is_string($url)) {

+            phpCAS :: error('type mismatched for parameter $url (should be `string\')');

+        }

+        $PHPCAS_CLIENT->logout(array (

+            "service" => $service,

+            "url" => $url

+        ));

+        // never reached

+        phpCAS :: traceEnd();

+    }

+

+    /**

+     * Set the fixed URL that will be used by the CAS server to transmit the PGT.

+     * When this method is not called, a phpCAS script uses its own URL for the callback.

+     *

+     * @param $url the URL

+     */

+    function setFixedCallbackURL($url = '') {

+        global $PHPCAS_CLIENT;

+        phpCAS :: traceBegin();

+        if (!is_object($PHPCAS_CLIENT)) {

+            phpCAS :: error('this method should only be called after ' . __CLASS__ . '::proxy()');

+        }

+        if (!$PHPCAS_CLIENT->isProxy()) {

+            phpCAS :: error('this method should only be called after ' . __CLASS__ . '::proxy()');

+        }

+        if (gettype($url) != 'string') {

+            phpCAS :: error('type mismatched for parameter $url (should be `string\')');

+        }

+        $PHPCAS_CLIENT->setCallbackURL($url);

+        phpCAS :: traceEnd();

+    }

+

+    /**

+     * Set the fixed URL that will be set as the CAS service parameter. When this

+     * method is not called, a phpCAS script uses its own URL.

+     *

+     * @param $url the URL

+     */

+    function setFixedServiceURL($url) {

+        global $PHPCAS_CLIENT;

+        phpCAS :: traceBegin();

+        if (!is_object($PHPCAS_CLIENT)) {

+            phpCAS :: error('this method should only be called after ' . __CLASS__ . '::proxy()');

+        }

+        if (gettype($url) != 'string') {

+            phpCAS :: error('type mismatched for parameter $url (should be `string\')');

+        }

+        $PHPCAS_CLIENT->setURL($url);

+        phpCAS :: traceEnd();

+    }

+

+    /**

+     * Get the URL that is set as the CAS service parameter.

+     */

+    function getServiceURL() {

+        global $PHPCAS_CLIENT;

+        if (!is_object($PHPCAS_CLIENT)) {

+            phpCAS :: error('this method should only be called after ' . __CLASS__ . '::proxy()');

+        }

+        return ($PHPCAS_CLIENT->getURL());

+    }

+

+    /**

+     * Retrieve a Proxy Ticket from the CAS server.

+     */

+    function retrievePT($target_service, & $err_code, & $err_msg) {

+        global $PHPCAS_CLIENT;

+        if (!is_object($PHPCAS_CLIENT)) {

+            phpCAS :: error('this method should only be called after ' . __CLASS__ . '::proxy()');

+        }

+        if (gettype($target_service) != 'string') {

+            phpCAS :: error('type mismatched for parameter $target_service(should be `string\')');

+        }

+        return ($PHPCAS_CLIENT->retrievePT($target_service, $err_code, $err_msg));

+    }

+

+    /**

+     * Set the certificate of the CAS server.

+     *

+     * @param $cert the PEM certificate

+     */

+    function setCasServerCert($cert) {

+        global $PHPCAS_CLIENT;

+        phpCAS :: traceBegin();

+        if (!is_object($PHPCAS_CLIENT)) {

+            phpCAS :: error('this method should only be called after ' . __CLASS__ . '::client() or' . __CLASS__ . '::proxy()');

+        }

+        if (gettype($cert) != 'string') {

+            phpCAS :: error('type mismatched for parameter $cert (should be `string\')');

+        }

+        $PHPCAS_CLIENT->setCasServerCert($cert);

+        phpCAS :: traceEnd();

+    }

+

+    /**

+     * Set the certificate of the CAS server CA.

+     *

+     * @param $cert the CA certificate

+     */

+    function setCasServerCACert($cert) {

+        global $PHPCAS_CLIENT;

+        phpCAS :: traceBegin();

+        if (!is_object($PHPCAS_CLIENT)) {

+            phpCAS :: error('this method should only be called after ' . __CLASS__ . '::client() or' . __CLASS__ . '::proxy()');

+        }

+        if (gettype($cert) != 'string') {

+            phpCAS :: error('type mismatched for parameter $cert (should be `string\')');

+        }

+        $PHPCAS_CLIENT->setCasServerCACert($cert);

+        phpCAS :: traceEnd();

+    }

+

+    /**

+     * Set no SSL validation for the CAS server.

+     */

+    function setNoCasServerValidation() {

+        global $PHPCAS_CLIENT;

+        phpCAS :: traceBegin();

+        if (!is_object($PHPCAS_CLIENT)) {

+            phpCAS :: error('this method should only be called after ' . __CLASS__ . '::client() or' . __CLASS__ . '::proxy()');

+        }

+        $PHPCAS_CLIENT->setNoCasServerValidation();

+        phpCAS :: traceEnd();

+    }

+

+    /** @} */

+

+    /**

+     * Change CURL options.

+     * CURL is used to connect through HTTPS to CAS server

+     * @param $key the option key

+     * @param $value the value to set

+     */

+    function setExtraCurlOption($key, $value) {

+        global $PHPCAS_CLIENT;

+        phpCAS :: traceBegin();

+        if (!is_object($PHPCAS_CLIENT)) {

+            phpCAS :: error('this method should only be called after ' . __CLASS__ . '::client() or' . __CLASS__ . '::proxy()');

+        }

+        $PHPCAS_CLIENT->setExtraCurlOption($key, $value);

+        phpCAS :: traceEnd();

+    }

 

 }