chamilo / chamilo-lms

main/inc/lib/usergroup.lib.php

Doc Comments +12 added lines, -6 removed lines

@@ -1013,7 +1013,7 @@ 
      * @param int    $groupId
      * @param string $picture
      *
-     * @return bool|string
+     * @return false|string
      */
     public function manageFileUpload($groupId, $picture)
     {
@@ -1155,7 +1155,7 @@ 
     }
 
     /**
-     * @return mixed
+     * @return integer
      */
     public function getGroupType()
     {
@@ -1359,6 +1359,8 @@ 
      * @param string height
      * @param string picture size it can be small_,  medium_  or  big_
      * @param string style css
+     * @param integer $height
+     * @param integer $size_picture
      * @return array with the file and the style of an image i.e $array['file'] $array['style']
      */
     public function get_picture_group($id, $picture_file, $height, $size_picture = GROUP_IMAGE_SIZE_MEDIUM , $style = '')
@@ -1420,7 +1422,7 @@ 
      * @param	string	Type of path to return (can be 'none', 'system', 'rel', 'web')
      * @param	bool	Whether we want to have the directory name returned 'as if' there was a file or not (in the case we want to know which directory to create - otherwise no file means no split subdir)
      * @param	bool	If we want that the function returns the /main/img/unknown.jpg image set it at true
-     * @return	array 	Array of 2 elements: 'dir' and 'file' which contain the dir and file as the name implies if image does not exist it will return the unknow image if anonymous parameter is true if not it returns an empty er's
+     * @return	integer 	Array of 2 elements: 'dir' and 'file' which contain the dir and file as the name implies if image does not exist it will return the unknow image if anonymous parameter is true if not it returns an empty er's
      */
     public function get_group_picture_path_by_id($id, $type = 'none', $preview = false, $anonymous = false)
     {
@@ -1470,7 +1472,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public function getAllowedPictureExtensions()
     {
@@ -1660,7 +1662,7 @@ 
      * @author Julio Montoya
      * @param  int  $user_id
      * @param  int $group_id
-     * @return boolean true if success
+     * @return Doctrine\DBAL\Driver\Statement|null true if success
      * */
     public function delete_user_rel_group($user_id, $group_id)
     {
@@ -1872,6 +1874,8 @@ 
      * @param int from value
      * @param int limit
      * @param array image configuration, i.e array('height'=>'20px', 'size'=> '20px')
+     * @param integer $from
+     * @param integer $limit
      * @return array list of users in a group
      */
     public function get_users_by_group(
@@ -1970,6 +1974,8 @@ 
      * Shows the left column of the group page
      * @param int group id
      * @param int user id
+     * @param integer $group_id
+     * @param integer $user_id
      *
      */
     public function show_group_column_information($group_id, $user_id, $show = '')
@@ -2323,7 +2329,7 @@ 
      * @param int $group_id
      * @param int $parent_group_id if 0, we delete the parent_group association
      * @param int $relation_type
-     * @return resource
+     * @return Doctrine\DBAL\Driver\Statement|null
      **/
     public static function set_parent_group($group_id, $parent_group_id, $relation_type = 1)
     {

Braces +3 added lines, -2 removed lines

@@ -1906,8 +1906,9 @@
                 $new_relation_type[] ="'$rel'";
             }
             $relation_type = implode(',', $new_relation_type);
-            if (!empty($relation_type))
-                $where_relation_condition = "AND gu.relation_type IN ($relation_type) ";
+            if (!empty($relation_type)) {
+                            $where_relation_condition = "AND gu.relation_type IN ($relation_type) ";
+            }
         }
 
         $sql = "SELECT picture_uri as image, u.id, u.firstname, u.lastname, relation_type

Spacing +63 added lines, -63 removed lines

@@ -81,7 +81,7 @@ 
             ";
             $result = Database::query($sql);
             if (Database::num_rows($result)) {
-                $row  = Database::fetch_array($result);
+                $row = Database::fetch_array($result);
 
                 return $row['count'];
             }
@@ -101,7 +101,7 @@ 
             ";
             $result = Database::query($sql);
             if (Database::num_rows($result)) {
-                $row  = Database::fetch_array($result);
+                $row = Database::fetch_array($result);
                 return $row['count'];
             }
         }
@@ -126,7 +126,7 @@ 
             ";
             $result = Database::query($sql);
             if (Database::num_rows($result)) {
-                $row  = Database::fetch_array($result);
+                $row = Database::fetch_array($result);
                 return $row['count'];
             }
 
@@ -147,7 +147,7 @@ 
             ";
             $result = Database::query($sql);
             if (Database::num_rows($result)) {
-                $row  = Database::fetch_array($result);
+                $row = Database::fetch_array($result);
                 return $row['count'];
             }
 
@@ -528,13 +528,13 @@ 
                 INNER JOIN {$this->table} g
                 ON (u.usergroup_id = g.id)
                 ";
-            $where =  array('where' => array('user_id = ? AND access_url_id = ? ' => array($userId, $urlId)));
+            $where = array('where' => array('user_id = ? AND access_url_id = ? ' => array($userId, $urlId)));
         } else {
             $from = $this->usergroup_rel_user_table." u
                 INNER JOIN {$this->table} g
                 ON (u.usergroup_id = g.id)
                 ";
-            $where =  array('where' => array('user_id = ?' => $userId));
+            $where = array('where' => array('user_id = ?' => $userId));
         }
 
         if ($filterByType !== null) {
@@ -567,10 +567,10 @@ 
             $urlId = api_get_current_access_url_id();
             $from = $this->usergroup_rel_user_table." u
                     INNER JOIN {$this->access_url_rel_usergroup} a ON (a.usergroup_id AND u.usergroup_id)";
-            $where =  array('where' => array('user_id = ? AND access_url_id = ? ' => array($userId, $urlId)));
+            $where = array('where' => array('user_id = ? AND access_url_id = ? ' => array($userId, $urlId)));
         } else {
             $from = $this->usergroup_rel_user_table." u ";
-            $where =  array('where' => array('user_id = ?' => $userId));
+            $where = array('where' => array('user_id = ?' => $userId));
         }
 
         $results = Database::select(
@@ -856,7 +856,7 @@ 
             }
             $result = $new_result;
         }
-        $columns = array('name', 'users', 'courses','sessions', 'group_type');
+        $columns = array('name', 'users', 'courses', 'sessions', 'group_type');
 
         if (!in_array($sidx, $columns)) {
             $sidx = 'name';
@@ -1260,7 +1260,7 @@ 
                 }
             }
         }
-        $response->addAssign('ajax_list_courses','innerHTML', api_utf8_encode($return));
+        $response->addAssign('ajax_list_courses', 'innerHTML', api_utf8_encode($return));
 
         return $response;
     }
@@ -1367,7 +1367,7 @@ 
      * @param string style css
      * @return array with the file and the style of an image i.e $array['file'] $array['style']
      */
-    public function get_picture_group($id, $picture_file, $height, $size_picture = GROUP_IMAGE_SIZE_MEDIUM , $style = '')
+    public function get_picture_group($id, $picture_file, $height, $size_picture = GROUP_IMAGE_SIZE_MEDIUM, $style = '')
     {
         $picture = array();
         $picture['style'] = $style;
@@ -1480,7 +1480,7 @@ 
      */
     public function getAllowedPictureExtensions()
     {
-        return $allowed_picture_types = array ('jpg', 'jpeg', 'png', 'gif');
+        return $allowed_picture_types = array('jpg', 'jpeg', 'png', 'gif');
     }
 
     /**
@@ -1514,7 +1514,7 @@ 
         if (empty($user_id)) {
             $user_id = api_get_user_id();
         }
-        $user_role	= $this->get_user_group_role($user_id, $group_id);
+        $user_role = $this->get_user_group_role($user_id, $group_id);
         if (in_array($user_role, array(GROUP_USER_PERMISSION_ADMIN))) {
             return true;
         } else {
@@ -1532,7 +1532,7 @@ 
         if (empty($user_id)) {
             $user_id = api_get_user_id();
         }
-        $user_role	= $this->get_user_group_role($user_id, $group_id);
+        $user_role = $this->get_user_group_role($user_id, $group_id);
         if (in_array($user_role, array(GROUP_USER_PERMISSION_ADMIN, GROUP_USER_PERMISSION_MODERATOR))) {
             return true;
         } else {
@@ -1559,7 +1559,7 @@ 
             GROUP_USER_PERMISSION_READER,
             GROUP_USER_PERMISSION_HRM,
         );
-        $user_role	= self::get_user_group_role($user_id, $group_id);
+        $user_role = self::get_user_group_role($user_id, $group_id);
         if (in_array($user_role, $roles)) {
             return true;
         } else {
@@ -1576,7 +1576,7 @@ 
      * */
     public function get_user_group_role($user_id, $group_id)
     {
-        $table_group_rel_user= $this->usergroup_rel_user_table;
+        $table_group_rel_user = $this->usergroup_rel_user_table;
         $return_value = 0;
         if (!empty($user_id) && !empty($group_id)) {
             $sql = "SELECT relation_type FROM $table_group_rel_user
@@ -1584,8 +1584,8 @@ 
                         usergroup_id = ".intval($group_id)." AND
                         user_id = ".intval($user_id)." ";
             $result = Database::query($sql);
-            if (Database::num_rows($result)>0) {
-                $row = Database::fetch_array($result,'ASSOC');
+            if (Database::num_rows($result) > 0) {
+                $row = Database::fetch_array($result, 'ASSOC');
                 $return_value = $row['relation_type'];
             }
         }
@@ -1640,7 +1640,7 @@ 
         if (is_array($user_list) && is_array($group_list)) {
             foreach ($group_list as $group_id) {
                 foreach ($user_list as $user_id) {
-                    $role = self::get_user_group_role($user_id,$group_id);
+                    $role = self::get_user_group_role($user_id, $group_id);
                     if ($role == 0) {
                         $sql = "INSERT INTO $table_url_rel_group
 		               			SET
@@ -1671,7 +1671,7 @@ 
     public function delete_user_rel_group($user_id, $group_id)
     {
         $table = $this->usergroup_rel_user_table;
-        $sql= "DELETE FROM $table
+        $sql = "DELETE FROM $table
                WHERE
                 user_id = ".intval($user_id)." AND
                 usergroup_id = ".intval($group_id)."  ";
@@ -1727,7 +1727,7 @@ 
 
         $sql = "UPDATE $table_group_rel_user
    				SET relation_type = ".intval($relation_type)."
-                WHERE user_id = $user_id AND usergroup_id = $group_id" ;
+                WHERE user_id = $user_id AND usergroup_id = $group_id";
         Database::query($sql);
     }
 
@@ -1769,7 +1769,7 @@ 
         if (Database::num_rows($result) > 0) {
             while ($row = Database::fetch_array($result, 'ASSOC')) {
                 if ($with_image) {
-                    $picture = self::get_picture_group($row['id'], $row['picture'],80);
+                    $picture = self::get_picture_group($row['id'], $row['picture'], 80);
                     $img = '<img src="'.$picture['file'].'" />';
                     $row['picture'] = $img;
                 }
@@ -1805,11 +1805,11 @@ 
 				ORDER BY count DESC
 				LIMIT $num";
 
-        $result=Database::query($sql);
+        $result = Database::query($sql);
         $array = array();
         while ($row = Database::fetch_array($result, 'ASSOC')) {
             if ($with_image) {
-                $picture = self::get_picture_group($row['id'], $row['picture'],80);
+                $picture = self::get_picture_group($row['id'], $row['picture'], 80);
                 $img = '<img src="'.$picture['file'].'" />';
                 $row['picture'] = $img;
             }
@@ -1854,11 +1854,11 @@ 
                 ORDER BY created_at DESC
                 LIMIT $num ";
 
-        $result=Database::query($sql);
+        $result = Database::query($sql);
         $array = array();
         while ($row = Database::fetch_array($result, 'ASSOC')) {
             if ($with_image) {
-                $picture = self::get_picture_group($row['id'], $row['picture'],80);
+                $picture = self::get_picture_group($row['id'], $row['picture'], 80);
                 $img = '<img src="'.$picture['file'].'" />';
                 $row['picture'] = $img;
             }
@@ -1892,7 +1892,7 @@ 
         $tbl_user = Database::get_main_table(TABLE_MAIN_USER);
         $group_id = intval($group_id);
 
-        if (empty($group_id)){
+        if (empty($group_id)) {
             return array();
         }
 
@@ -1907,9 +1907,9 @@ 
             $where_relation_condition = '';
         } else {
             $new_relation_type = array();
-            foreach($relation_type as $rel) {
+            foreach ($relation_type as $rel) {
                 $rel = intval($rel);
-                $new_relation_type[] ="'$rel'";
+                $new_relation_type[] = "'$rel'";
             }
             $relation_type = implode(',', $new_relation_type);
             if (!empty($relation_type))
@@ -1953,7 +1953,7 @@ 
         $tbl_user = Database::get_main_table(TABLE_MAIN_USER);
         $group_id = intval($group_id);
 
-        if (empty($group_id)){
+        if (empty($group_id)) {
             return array();
         }
 
@@ -1964,7 +1964,7 @@ 
 			    WHERE gu.usergroup_id= $group_id
 			    ORDER BY relation_type, firstname";
 
-        $result=Database::query($sql);
+        $result = Database::query($sql);
         $array = array();
         while ($row = Database::fetch_array($result, 'ASSOC')) {
             $array[$row['id']] = $row;
@@ -1993,27 +1993,27 @@ 
             case GROUP_USER_PERMISSION_READER:
                 // I'm just a reader
                 $relation_group_title = get_lang('IAmAReader');
-                $links .=  '<li><a href="group_invitation.php?id='.$group_id.'">'.
-                            Display::return_icon('invitation_friend.png', get_lang('InviteFriends'), array('hspace'=>'6')).'<span class="'.($show=='invite_friends'?'social-menu-text-active':'social-menu-text4').'" >'.get_lang('InviteFriends').'</span></a></li>';
-                $links .=  '<li><a href="group_view.php?id='.$group_id.'&action=leave&u='.api_get_user_id().'">'.
+                $links .= '<li><a href="group_invitation.php?id='.$group_id.'">'.
+                            Display::return_icon('invitation_friend.png', get_lang('InviteFriends'), array('hspace'=>'6')).'<span class="'.($show == 'invite_friends' ? 'social-menu-text-active' : 'social-menu-text4').'" >'.get_lang('InviteFriends').'</span></a></li>';
+                $links .= '<li><a href="group_view.php?id='.$group_id.'&action=leave&u='.api_get_user_id().'">'.
                             Display::return_icon('group_leave.png', get_lang('LeaveGroup'), array('hspace'=>'6')).'<span class="social-menu-text4" >'.get_lang('LeaveGroup').'</span></a></li>';
                 break;
             case GROUP_USER_PERMISSION_ADMIN:
                 $relation_group_title = get_lang('IAmAnAdmin');
-                $links .=  '<li><a href="group_edit.php?id='.$group_id.'">'.
-                            Display::return_icon('group_edit.png', get_lang('EditGroup'), array('hspace'=>'6')).'<span class="'.($show=='group_edit'?'social-menu-text-active':'social-menu-text4').'" >'.get_lang('EditGroup').'</span></a></li>';
-                $links .=  '<li><a href="group_waiting_list.php?id='.$group_id.'">'.
-                            Display::return_icon('waiting_list.png', get_lang('WaitingList'), array('hspace'=>'6')).'<span class="'.($show=='waiting_list'?'social-menu-text-active':'social-menu-text4').'" >'.get_lang('WaitingList').'</span></a></li>';
-                $links .=  '<li><a href="group_invitation.php?id='.$group_id.'">'.
-                            Display::return_icon('invitation_friend.png', get_lang('InviteFriends'), array('hspace'=>'6')).'<span class="'.($show=='invite_friends'?'social-menu-text-active':'social-menu-text4').'" >'.get_lang('InviteFriends').'</span></a></li>';
-                $links .=  '<li><a href="group_view.php?id='.$group_id.'&action=leave&u='.api_get_user_id().'">'.
+                $links .= '<li><a href="group_edit.php?id='.$group_id.'">'.
+                            Display::return_icon('group_edit.png', get_lang('EditGroup'), array('hspace'=>'6')).'<span class="'.($show == 'group_edit' ? 'social-menu-text-active' : 'social-menu-text4').'" >'.get_lang('EditGroup').'</span></a></li>';
+                $links .= '<li><a href="group_waiting_list.php?id='.$group_id.'">'.
+                            Display::return_icon('waiting_list.png', get_lang('WaitingList'), array('hspace'=>'6')).'<span class="'.($show == 'waiting_list' ? 'social-menu-text-active' : 'social-menu-text4').'" >'.get_lang('WaitingList').'</span></a></li>';
+                $links .= '<li><a href="group_invitation.php?id='.$group_id.'">'.
+                            Display::return_icon('invitation_friend.png', get_lang('InviteFriends'), array('hspace'=>'6')).'<span class="'.($show == 'invite_friends' ? 'social-menu-text-active' : 'social-menu-text4').'" >'.get_lang('InviteFriends').'</span></a></li>';
+                $links .= '<li><a href="group_view.php?id='.$group_id.'&action=leave&u='.api_get_user_id().'">'.
                             Display::return_icon('group_leave.png', get_lang('LeaveGroup'), array('hspace'=>'6')).'<span class="social-menu-text4" >'.get_lang('LeaveGroup').'</span></a></li>';
                 break;
             case GROUP_USER_PERMISSION_PENDING_INVITATION:
 //				$links .=  '<li><a href="groups.php?id='.$group_id.'&action=join&u='.api_get_user_id().'">'.Display::return_icon('addd.gif', get_lang('YouHaveBeenInvitedJoinNow'), array('hspace'=>'6')).'<span class="social-menu-text4" >'.get_lang('YouHaveBeenInvitedJoinNow').'</span></a></li>';
                 break;
             case GROUP_USER_PERMISSION_PENDING_INVITATION_SENT_BY_USER:
-                $relation_group_title =  get_lang('WaitingForAdminResponse');
+                $relation_group_title = get_lang('WaitingForAdminResponse');
                 break;
             case GROUP_USER_PERMISSION_MODERATOR:
                 $relation_group_title = get_lang('IAmAModerator');
@@ -2021,25 +2021,25 @@ 
                 //$links .=  '<li><a href="groups.php?id='.$group_id.'">'.				Display::return_icon('message_list.png', get_lang('MessageList'), array('hspace'=>'6')).'<span class="'.($show=='messages_list'?'social-menu-text-active':'social-menu-text4').'" >'.get_lang('MessageList').'</span></a></li>';
                 //$links .=  '<li><a href="group_members.php?id='.$group_id.'">'.		Display::return_icon('member_list.png', get_lang('MemberList'), array('hspace'=>'6')).'<span class="'.($show=='member_list'?'social-menu-text-active':'social-menu-text4').'" >'.get_lang('MemberList').'</span></a></li>';
                 if ($group_info['visibility'] == GROUP_PERMISSION_CLOSED) {
-                    $links .=  '<li><a href="group_waiting_list.php?id='.$group_id.'">'.
-                                Display::return_icon('waiting_list.png', get_lang('WaitingList'), array('hspace'=>'6')).'<span class="'.($show=='waiting_list'?'social-menu-text-active':'social-menu-text4').'" >'.get_lang('WaitingList').'</span></a></li>';
+                    $links .= '<li><a href="group_waiting_list.php?id='.$group_id.'">'.
+                                Display::return_icon('waiting_list.png', get_lang('WaitingList'), array('hspace'=>'6')).'<span class="'.($show == 'waiting_list' ? 'social-menu-text-active' : 'social-menu-text4').'" >'.get_lang('WaitingList').'</span></a></li>';
                 }
-                $links .=  '<li><a href="group_invitation.php?id='.$group_id.'">'.
-                            Display::return_icon('invitation_friend.png', get_lang('InviteFriends'), array('hspace'=>'6')).'<span class="'.($show=='invite_friends'?'social-menu-text-active':'social-menu-text4').'" >'.get_lang('InviteFriends').'</span></a></li>';
-                $links .=  '<li><a href="group_view.php?id='.$group_id.'&action=leave&u='.api_get_user_id().'">'.
+                $links .= '<li><a href="group_invitation.php?id='.$group_id.'">'.
+                            Display::return_icon('invitation_friend.png', get_lang('InviteFriends'), array('hspace'=>'6')).'<span class="'.($show == 'invite_friends' ? 'social-menu-text-active' : 'social-menu-text4').'" >'.get_lang('InviteFriends').'</span></a></li>';
+                $links .= '<li><a href="group_view.php?id='.$group_id.'&action=leave&u='.api_get_user_id().'">'.
                             Display::return_icon('group_leave.png', get_lang('LeaveGroup'), array('hspace'=>'6')).'<span class="social-menu-text4" >'.get_lang('LeaveGroup').'</span></a></li>';
                 break;
             case GROUP_USER_PERMISSION_HRM:
                 $relation_group_title = get_lang('IAmAHRM');
                 $links .= '<li><a href="'.api_get_path(WEB_CODE_PATH).'social/message_for_group_form.inc.php?view_panel=1&height=400&width=610&&user_friend='.api_get_user_id().'&group_id='.$group_id.'&action=add_message_group" class="ajax" title="'.get_lang('ComposeMessage').'" data-size="lg" data-title="'.get_lang('ComposeMessage').'">'.
                             Display::return_icon('new-message.png', get_lang('NewTopic'), array('hspace'=>'6')).'<span class="social-menu-text4" >'.get_lang('NewTopic').'</span></a></li>';
-                $links .=  '<li><a href="group_view.php?id='.$group_id.'">'.
-                            Display::return_icon('message_list.png', get_lang('MessageList'), array('hspace'=>'6')).'<span class="'.($show=='messages_list'?'social-menu-text-active':'social-menu-text4').'" >'.get_lang('MessageList').'</span></a></li>';
-                $links .=  '<li><a href="group_invitation.php?id='.$group_id.'">'.
-                            Display::return_icon('invitation_friend.png', get_lang('InviteFriends'), array('hspace'=>'6')).'<span class="'.($show=='invite_friends'?'social-menu-text-active':'social-menu-text4').'" >'.get_lang('InviteFriends').'</span></a></li>';
-                $links .=  '<li><a href="group_members.php?id='.$group_id.'">'.
-                            Display::return_icon('member_list.png', get_lang('MemberList'), array('hspace'=>'6')).'<span class="'.($show=='member_list'?'social-menu-text-active':'social-menu-text4').'" >'.get_lang('MemberList').'</span></a></li>';
-                $links .=  '<li><a href="group_view.php?id='.$group_id.'&action=leave&u='.api_get_user_id().'">'.
+                $links .= '<li><a href="group_view.php?id='.$group_id.'">'.
+                            Display::return_icon('message_list.png', get_lang('MessageList'), array('hspace'=>'6')).'<span class="'.($show == 'messages_list' ? 'social-menu-text-active' : 'social-menu-text4').'" >'.get_lang('MessageList').'</span></a></li>';
+                $links .= '<li><a href="group_invitation.php?id='.$group_id.'">'.
+                            Display::return_icon('invitation_friend.png', get_lang('InviteFriends'), array('hspace'=>'6')).'<span class="'.($show == 'invite_friends' ? 'social-menu-text-active' : 'social-menu-text4').'" >'.get_lang('InviteFriends').'</span></a></li>';
+                $links .= '<li><a href="group_members.php?id='.$group_id.'">'.
+                            Display::return_icon('member_list.png', get_lang('MemberList'), array('hspace'=>'6')).'<span class="'.($show == 'member_list' ? 'social-menu-text-active' : 'social-menu-text4').'" >'.get_lang('MemberList').'</span></a></li>';
+                $links .= '<li><a href="group_view.php?id='.$group_id.'&action=leave&u='.api_get_user_id().'">'.
                             Display::return_icon('delete_data.gif', get_lang('LeaveGroup'), array('hspace'=>'6')).'<span class="social-menu-text4" >'.get_lang('LeaveGroup').'</span></a></li>';
                 break;
             default:
@@ -2082,14 +2082,14 @@ 
      */
     public function get_groups_by_user_count($user_id = '', $relation_type = GROUP_USER_PERMISSION_READER, $with_image = false)
     {
-        $table_group_rel_user	= $this->usergroup_rel_user_table;
-        $tbl_group				= $this->table;
-        $user_id 				= intval($user_id);
+        $table_group_rel_user = $this->usergroup_rel_user_table;
+        $tbl_group = $this->table;
+        $user_id = intval($user_id);
 
         if ($relation_type == 0) {
             $where_relation_condition = '';
         } else {
-            $relation_type 			= intval($relation_type);
+            $relation_type = intval($relation_type);
             $where_relation_condition = "AND gu.relation_type = $relation_type ";
         }
 
@@ -2162,7 +2162,7 @@ 
         }
 
         $direction = 'ASC';
-        if (!in_array($direction, array('ASC','DESC'))) {
+        if (!in_array($direction, array('ASC', 'DESC'))) {
             $direction = 'ASC';
         }
 
@@ -2173,8 +2173,8 @@ 
         $sql .= " LIMIT $from,$number_of_items";
 
         $res = Database::query($sql);
-        if (Database::num_rows($res)> 0) {
-            while ($row = Database::fetch_array($res,'ASSOC')) {
+        if (Database::num_rows($res) > 0) {
+            while ($row = Database::fetch_array($res, 'ASSOC')) {
                 if (!in_array($row['id'], $return)) {
                     $return[$row['id']] = $row;
                 }
@@ -2199,7 +2199,7 @@ 
             if ($i == $max_level) {
                 $select_part .= "rg$rg_number.group_id as id_$rg_number ";
             } else {
-                $select_part .="rg$rg_number.group_id as id_$rg_number, ";
+                $select_part .= "rg$rg_number.group_id as id_$rg_number, ";
             }
             if ($i == 1) {
                 $cond_part .= "FROM $t_rel_group rg0 LEFT JOIN $t_rel_group rg$i on rg$rg_number.group_id = rg$i.subgroup_id ";
@@ -2387,7 +2387,7 @@ 
         $nameList = '<ul class="list-unstyled">';
 
         foreach ($groupsNameListParsed as $name) {
-            $nameList .= '<li>' . Display::span($name, ['class' => 'label label-info']) . '</li>';
+            $nameList .= '<li>'.Display::span($name, ['class' => 'label label-info']).'</li>';
         }
 
         $nameList .= '</ul>';

main/inc/lib/usermanager.lib.php

Doc Comments +31 added lines, -15 removed lines

@@ -86,7 +86,7 @@ 
     }
 
     /**
-     * @return bool|mixed
+     * @return string
      */
     public static function getPasswordEncryption()
     {
@@ -161,7 +161,7 @@ 
      * @param string $raw
      * @param User   $user
      *
-     * @return bool
+     * @return string
      */
     public static function encryptPassword($raw, User $user)
     {
@@ -965,6 +965,7 @@ 
      * Disables or enables a user
      * @param int user_id
      * @param int Enable or disable
+     * @param integer $active
      * @return void
      * @assert (-1,0) === false
      * @assert (1,1) === true
@@ -995,6 +996,7 @@ 
     /**
      * Disables a user
      * @param int User id
+     * @param integer $user_id
      * @return bool
      * @uses UserManager::change_active_state() to actually disable the user
      * @assert (0) === false
@@ -1011,6 +1013,7 @@ 
     /**
      * Enable a user
      * @param int User id
+     * @param integer $user_id
      * @return bool
      * @uses UserManager::change_active_state() to actually disable the user
      * @assert (0) === false
@@ -1175,6 +1178,7 @@ 
      * Checks whether the user id exists in the database
      *
      * @param int User id
+     * @param integer $userId
      * @return bool True if user id was found, false otherwise
      */
     public static function is_user_id_valid($userId)
@@ -1357,7 +1361,7 @@ 
      * @param   array $userInfo user information to avoid query the DB
      * returns the /main/img/unknown.jpg image set it at true
      *
-     * @return    array     Array of 2 elements: 'dir' and 'file' which contain
+     * @return    integer     Array of 2 elements: 'dir' and 'file' which contain
      * the dir and file as the name implies if image does not exist it will
      * return the unknow image if anonymous parameter is true if not it returns an empty array
      */
@@ -1729,7 +1733,7 @@ 
      * @param    int $user_id    User id
      * @param    $force    Optional parameter to force building after a removal request
      *
-     * @return    A string containing the XHTML code to dipslay the production list, or FALSE
+     * @return    boolean|string string containing the XHTML code to dipslay the production list, or FALSE
      */
     public static function build_production_list($user_id, $force = false, $showdelete = false)
     {
@@ -1765,7 +1769,7 @@ 
     /**
      * Returns an array with the user's productions.
      *
-     * @param    $user_id    User id
+     * @param    integer $user_id    User id
      * @return   array  An array containing the user's productions
      */
     public static function get_user_productions($user_id)
@@ -1920,7 +1924,7 @@ 
 
     /**
      * Build a list of extra file already uploaded in $user_folder/{$extra_field}/
-     * @param $user_id
+     * @param integer $user_id
      * @param $extra_field
      * @param bool $force
      * @param bool $showdelete
@@ -2023,7 +2027,7 @@ 
      * @param    int       $fieldType  Field's type
      * @param    string    $displayText Field's language var name
      * @param    string    $default Field's default value
-     * @return int
+     * @return boolean
      */
     public static function create_extra_field($variable, $fieldType, $displayText, $default)
     {
@@ -2056,6 +2060,7 @@ 
      * @param    boolean    Whether to prefix the fields indexes with "extra_" (might be used by formvalidator)
      * @param    boolean    Whether to return invisible fields as well
      * @param    boolean    Whether to split multiple-selection fields or not
+     * @param boolean $field_filter
      * @return    array    Array of fields => value for the given user
      */
     public static function get_extra_user_data(
@@ -2242,7 +2247,6 @@ 
     /**
      * Get all the extra field information of a certain field (also the options)
      *
-     * @param int $field_name the name of the field we want to know everything of
      * @return array $return containing all th information about the extra profile field
      * @author Julio Montoya
      * @deprecated
@@ -2285,6 +2289,7 @@ 
     /**
      * Get extra user data by field variable
      * @param string    field variable
+     * @param string $field_variable
      * @return array    data
      */
     public static function get_extra_user_data_by_field_variable($field_variable)
@@ -2829,7 +2834,7 @@ 
      * @param    string    User ID
      * @param   string  course directory
      * @param   string  resourcetype: images, all
-     * @return    int        User ID (or false if not found)
+     * @return    string        User ID (or false if not found)
      */
     public static function get_user_upload_files_by_course($user_id, $course, $resourcetype = 'all')
     {
@@ -2909,7 +2914,7 @@ 
     /**
      * Adds a new API key to the users' account
      * @param   int     Optional user ID (defaults to the results of api_get_user_id())
-     * @return  boolean True on success, false on failure
+     * @return  false|string True on success, false on failure
      */
     public static function add_api_key($user_id = null, $api_service = 'dokeos')
     {
@@ -2964,6 +2969,7 @@ 
      * Regenerate an API key from the user's account
      * @param   int     user ID (defaults to the results of api_get_user_id())
      * @param   string  API key's internal ID
+     * @param string $api_service
      * @return  int        num
      */
     public static function update_api_key($user_id, $api_service)
@@ -2993,6 +2999,7 @@ 
     /**
      * @param   int     user ID (defaults to the results of api_get_user_id())
      * @param   string    API key's internal ID
+     * @param string $api_service
      * @return  int    row ID, or return false if not found
      */
     public static function get_api_key_id($user_id, $api_service)
@@ -3204,7 +3211,8 @@ 
      * @param int user_id
      * @param int field_id
      * @param bool show links or not
-     * @return array
+     * @param integer $user_id
+     * @return string
      */
     public static function get_user_tags_to_string($user_id, $field_id, $show_links = true)
     {
@@ -3249,6 +3257,8 @@ 
      * Get the tag id
      * @param int tag
      * @param int field_id
+     * @param string $tag
+     * @param integer $field_id
      * @return int returns 0 if fails otherwise the tag id
      */
     public static function get_tag_id($tag, $field_id)
@@ -3295,7 +3305,7 @@ 
      * @param mixed tag
      * @param int The user id
      * @param int field id of the tag
-     * @return bool
+     * @return boolean|null
      */
     public static function add_tag($tag, $user_id, $field_id)
     {
@@ -4101,7 +4111,7 @@ 
      * Add subscribed users to a user by relation type
      * @param int $userId The user id
      * @param array $subscribedUsersId The id of suscribed users
-     * @param action $relationType The relation type
+     * @param integer $relationType The relation type
      */
     public static function subscribeUsersToUser($userId, $subscribedUsersId, $relationType)
     {
@@ -4158,6 +4168,8 @@ 
      * This function check if an user is followed by human resources manager
      * @param     int     User id
      * @param    int        Human resources manager
+     * @param integer $user_id
+     * @param integer $hr_dept_id
      * @return    bool
      */
     public static function is_user_followed_by_drh($user_id, $hr_dept_id)
@@ -4230,6 +4242,8 @@ 
      * Determines if a user is a gradebook certified
      * @param int The category id of gradebook
      * @param int The user id
+     * @param integer $cat_id
+     * @param integer $user_id
      * @return boolean
      */
     public static function is_user_certified($cat_id, $user_id)
@@ -4252,6 +4266,8 @@ 
      * Gets the info about a gradebook certificate for a user by course
      * @param string The course code
      * @param int The user id
+     * @param integer $course_code
+     * @param integer $user_id
      * @return array  if there is not information return false
      */
     public static function get_info_gradebook_certificate($course_code, $user_id)
@@ -4715,7 +4731,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     static function get_user_field_types()
     {
@@ -4967,7 +4983,7 @@ 
      * Get either a Gravatar URL or complete image tag for a specified email address.
      *
      * @param string $email The email address
-     * @param string $s Size in pixels, defaults to 80px [ 1 - 2048 ]
+     * @param integer $s Size in pixels, defaults to 80px [ 1 - 2048 ]
      * @param string $d Default imageset to use [ 404 | mm | identicon | monsterid | wavatar ]
      * @param string $r Maximum rating (inclusive) [ g | pg | r | x ]
      * @param boole $img True to return a complete IMG tag False for just the URL

Braces +97 added lines, -62 removed lines

@@ -774,10 +774,12 @@ 
     public static function update_openid($user_id, $openid)
     {
         $table_user = Database :: get_main_table(TABLE_MAIN_USER);
-        if ($user_id != strval(intval($user_id)))
-            return false;
-        if ($user_id === false)
-            return false;
+        if ($user_id != strval(intval($user_id))) {
+                    return false;
+        }
+        if ($user_id === false) {
+                    return false;
+        }
         $sql = "UPDATE $table_user SET
                 openid='".Database::escape_string($openid)."'";
         $sql .= " WHERE id= $user_id";
@@ -2069,8 +2071,9 @@ 
         if (empty($user_id)) {
             $user_id = 0;
         } else {
-            if ($user_id != strval(intval($user_id)))
-                return array();
+            if ($user_id != strval(intval($user_id))) {
+                            return array();
+            }
         }
         $extra_data = array();
         $t_uf = Database::get_main_table(TABLE_EXTRA_FIELD);
@@ -2162,8 +2165,9 @@ 
         if (empty($user_id)) {
             $user_id = 0;
         } else {
-            if ($user_id != strval(intval($user_id)))
-                return array();
+            if ($user_id != strval(intval($user_id))) {
+                            return array();
+            }
         }
         $extra_data = array();
         $t_uf = Database::get_main_table(TABLE_EXTRA_FIELD);
@@ -2880,13 +2884,15 @@ 
      */
     public static function get_api_keys($user_id = null, $api_service = 'dokeos')
     {
-        if ($user_id != strval(intval($user_id)))
-            return false;
+        if ($user_id != strval(intval($user_id))) {
+                    return false;
+        }
         if (empty($user_id)) {
             $user_id = api_get_user_id();
         }
-        if ($user_id === false)
-            return false;
+        if ($user_id === false) {
+                    return false;
+        }
         $service_name = Database::escape_string($api_service);
         if (is_string($service_name) === false) {
             return false;
@@ -2894,11 +2900,14 @@ 
         $t_api = Database::get_main_table(TABLE_MAIN_USER_API_KEY);
         $sql = "SELECT * FROM $t_api WHERE user_id = $user_id AND api_service='$api_service';";
         $res = Database::query($sql);
-        if ($res === false)
-            return false; //error during query
+        if ($res === false) {
+                    return false;
+        }
+        //error during query
         $num = Database::num_rows($res);
-        if ($num == 0)
-            return false;
+        if ($num == 0) {
+                    return false;
+        }
         $list = array();
         while ($row = Database::fetch_array($res)) {
             $list[$row['id']] = $row['api_key'];
@@ -2913,13 +2922,15 @@ 
      */
     public static function add_api_key($user_id = null, $api_service = 'dokeos')
     {
-        if ($user_id != strval(intval($user_id)))
-            return false;
+        if ($user_id != strval(intval($user_id))) {
+                    return false;
+        }
         if (empty($user_id)) {
             $user_id = api_get_user_id();
         }
-        if ($user_id === false)
-            return false;
+        if ($user_id === false) {
+                    return false;
+        }
         $service_name = Database::escape_string($api_service);
         if (is_string($service_name) === false) {
             return false;
@@ -2928,8 +2939,10 @@ 
         $md5 = md5((time() + ($user_id * 5)) - rand(10000, 10000)); //generate some kind of random key
         $sql = "INSERT INTO $t_api (user_id, api_key,api_service) VALUES ($user_id,'$md5','$service_name')";
         $res = Database::query($sql);
-        if ($res === false)
-            return false; //error during query
+        if ($res === false) {
+                    return false;
+        }
+        //error during query
         $num = Database::insert_id();
         return ($num == 0) ? false : $num;
     }
@@ -2941,22 +2954,29 @@ 
      */
     public static function delete_api_key($key_id)
     {
-        if ($key_id != strval(intval($key_id)))
-            return false;
-        if ($key_id === false)
-            return false;
+        if ($key_id != strval(intval($key_id))) {
+                    return false;
+        }
+        if ($key_id === false) {
+                    return false;
+        }
         $t_api = Database::get_main_table(TABLE_MAIN_USER_API_KEY);
         $sql = "SELECT * FROM $t_api WHERE id = ".$key_id;
         $res = Database::query($sql);
-        if ($res === false)
-            return false; //error during query
+        if ($res === false) {
+                    return false;
+        }
+        //error during query
         $num = Database::num_rows($res);
-        if ($num !== 1)
-            return false;
+        if ($num !== 1) {
+                    return false;
+        }
         $sql = "DELETE FROM $t_api WHERE id = ".$key_id;
         $res = Database::query($sql);
-        if ($res === false)
-            return false; //error during query
+        if ($res === false) {
+                    return false;
+        }
+        //error during query
         return true;
     }
 
@@ -2968,10 +2988,12 @@ 
      */
     public static function update_api_key($user_id, $api_service)
     {
-        if ($user_id != strval(intval($user_id)))
-            return false;
-        if ($user_id === false)
-            return false;
+        if ($user_id != strval(intval($user_id))) {
+                    return false;
+        }
+        if ($user_id === false) {
+                    return false;
+        }
         $service_name = Database::escape_string($api_service);
         if (is_string($service_name) === false) {
             return false;
@@ -2997,12 +3019,15 @@ 
      */
     public static function get_api_key_id($user_id, $api_service)
     {
-        if ($user_id != strval(intval($user_id)))
-            return false;
-        if ($user_id === false)
-            return false;
-        if (empty($api_service))
-            return false;
+        if ($user_id != strval(intval($user_id))) {
+                    return false;
+        }
+        if ($user_id === false) {
+                    return false;
+        }
+        if (empty($api_service)) {
+                    return false;
+        }
         $t_api = Database::get_main_table(TABLE_MAIN_USER_API_KEY);
         $api_service = Database::escape_string($api_service);
         $sql = "SELECT id FROM $t_api WHERE user_id=".$user_id." AND api_service='".$api_service."'";
@@ -4473,8 +4498,9 @@ 
                     $form->applyFilter('extra_'.$field_details[1], 'stripslashes');
                     $form->applyFilter('extra_'.$field_details[1], 'trim');
                     if (!$admin_permissions) {
-                        if ($field_details[7] == 0)
-                            $form->freeze('extra_'.$field_details[1]);
+                        if ($field_details[7] == 0) {
+                                                    $form->freeze('extra_'.$field_details[1]);
+                        }
                     }
                     break;
                 case ExtraField::FIELD_TYPE_RADIO:
@@ -4491,8 +4517,9 @@ 
                     }
                     $form->addGroup($group, 'extra_'.$field_details[1], $field_details[3], '');
                     if (!$admin_permissions) {
-                        if ($field_details[7] == 0)
-                            $form->freeze('extra_'.$field_details[1]);
+                        if ($field_details[7] == 0) {
+                                                    $form->freeze('extra_'.$field_details[1]);
+                        }
                     }
                     break;
                 case ExtraField::FIELD_TYPE_SELECT:
@@ -4530,8 +4557,9 @@ 
                     );
 
                     if (!$admin_permissions) {
-                        if ($field_details[7] == 0)
-                            $form->freeze('extra_'.$field_details[1]);
+                        if ($field_details[7] == 0) {
+                                                    $form->freeze('extra_'.$field_details[1]);
+                        }
                     }
                     break;
                 case ExtraField::FIELD_TYPE_SELECT_MULTIPLE:
@@ -4547,8 +4575,9 @@ 
                         array('multiple' => 'multiple')
                     );
                     if (!$admin_permissions) {
-                        if ($field_details[7] == 0)
-                            $form->freeze('extra_'.$field_details[1]);
+                        if ($field_details[7] == 0) {
+                                                    $form->freeze('extra_'.$field_details[1]);
+                        }
                     }
                     break;
                 case ExtraField::FIELD_TYPE_DATE:
@@ -4556,8 +4585,9 @@ 
                     $defaults['extra_'.$field_details[1]] = date('Y-m-d 12:00:00');
                     $form->setDefaults($defaults);
                     if (!$admin_permissions) {
-                        if ($field_details[7] == 0)
-                            $form->freeze('extra_'.$field_details[1]);
+                        if ($field_details[7] == 0) {
+                                                    $form->freeze('extra_'.$field_details[1]);
+                        }
                     }
                     $form->applyFilter('theme', 'trim');
                     break;
@@ -4566,8 +4596,9 @@ 
                     $defaults['extra_'.$field_details[1]] = date('Y-m-d 12:00:00');
                     $form->setDefaults($defaults);
                     if (!$admin_permissions) {
-                        if ($field_details[7] == 0)
-                            $form->freeze('extra_'.$field_details[1]);
+                        if ($field_details[7] == 0) {
+                                                    $form->freeze('extra_'.$field_details[1]);
+                        }
                     }
                     $form->applyFilter('theme', 'trim');
                     break;
@@ -4586,8 +4617,9 @@ 
                     $form->addGroup($group, 'extra_'.$field_details[1], $field_details[3], ' ');
 
                     if (!$admin_permissions) {
-                        if ($field_details[7] == 0)
-                            $form->freeze('extra_'.$field_details[1]);
+                        if ($field_details[7] == 0) {
+                                                    $form->freeze('extra_'.$field_details[1]);
+                        }
                     }
 
                     /* Recoding the selected values for double : if the user has
@@ -4647,8 +4679,9 @@ 
                     break;
                 case ExtraField::FIELD_TYPE_TIMEZONE:
                     $form->addElement('select', 'extra_'.$field_details[1], $field_details[3], api_get_timezones(), '');
-                    if ($field_details[7] == 0)
-                        $form->freeze('extra_'.$field_details[1]);
+                    if ($field_details[7] == 0) {
+                                            $form->freeze('extra_'.$field_details[1]);
+                    }
                     break;
                 case ExtraField::FIELD_TYPE_SOCIAL_PROFILE:
                     // get the social network's favicon
@@ -4673,8 +4706,9 @@ 
                     );
                     $form->applyFilter('extra_'.$field_details[1], 'stripslashes');
                     $form->applyFilter('extra_'.$field_details[1], 'trim');
-                    if ($field_details[7] == 0)
-                        $form->freeze('extra_'.$field_details[1]);
+                    if ($field_details[7] == 0) {
+                                            $form->freeze('extra_'.$field_details[1]);
+                    }
                     break;
                 case ExtraField::FIELD_TYPE_FILE:
                     $extra_field = 'extra_'.$field_details[1];
@@ -4991,8 +5025,9 @@ 
         $url .= "?s=$s&d=$d&r=$r";
         if ( $img ) {
             $url = '<img src="' . $url . '"';
-            foreach ( $atts as $key => $val )
-                $url .= ' ' . $key . '="' . $val . '"';
+            foreach ( $atts as $key => $val ) {
+                            $url .= ' ' . $key . '="' . $val . '"';
+            }
             $url .= ' />';
         }
         return $url;

Spacing +37 added lines, -37 removed lines

@@ -34,7 +34,7 @@ 
     const USER_FIELD_TYPE_TIMEZONE = 11;
     const USER_FIELD_TYPE_SOCIAL_PROFILE = 12;
     const USER_FIELD_TYPE_FILE = 13;
-    const USER_FIELD_TYPE_MOBILE_PHONE_NUMBER  = 14;
+    const USER_FIELD_TYPE_MOBILE_PHONE_NUMBER = 14;
 
     private static $encryptionMethod;
 
@@ -280,7 +280,7 @@ 
         }
 
         if (empty($password)) {
-            Display::addFlash(Display::return_message(get_lang('ThisFieldIsRequired').': '.get_lang('Password') , 'warning'));
+            Display::addFlash(Display::return_message(get_lang('ThisFieldIsRequired').': '.get_lang('Password'), 'warning'));
 
             return false;
         }
@@ -494,7 +494,7 @@ 
         $res = Database::query($sql);
         while ($course = Database::fetch_object($res)) {
             $sql = "SELECT id FROM $table_course_user
-                    WHERE status=1 AND c_id = " . intval($course->c_id);
+                    WHERE status=1 AND c_id = ".intval($course->c_id);
             $res2 = Database::query($sql);
             if (Database::num_rows($res2) == 1) {
 
@@ -758,7 +758,7 @@ 
         $sql = "UPDATE $table_user SET active = 1 WHERE id IN ($ids)";
         $r = Database::query($sql);
         if ($r !== false) {
-            Event::addEvent(LOG_USER_ENABLE,LOG_USER_ID,$ids);
+            Event::addEvent(LOG_USER_ENABLE, LOG_USER_ID, $ids);
         }
         return $r;
     }
@@ -1164,7 +1164,7 @@ 
             // 1. Conversion of unacceptable letters (latinian letters with accents for example) into ASCII letters in order they not to be totally removed.
             // 2. Applying the strict purifier.
             // 3. Length limitation.
-            $return  = api_get_setting('login_is_email') == 'true' ? substr(preg_replace(USERNAME_PURIFIER_MAIL, '', $username), 0, USERNAME_MAX_LENGTH) : substr(preg_replace(USERNAME_PURIFIER, '', $username), 0, USERNAME_MAX_LENGTH);
+            $return = api_get_setting('login_is_email') == 'true' ? substr(preg_replace(USERNAME_PURIFIER_MAIL, '', $username), 0, USERNAME_MAX_LENGTH) : substr(preg_replace(USERNAME_PURIFIER, '', $username), 0, USERNAME_MAX_LENGTH);
             $return = URLify::transliterate($return);
             return $return;
         }
@@ -1256,12 +1256,12 @@ 
 
         if (!is_null($order)) {
             $order = Database::escape_string($order);
-            $sql .= ' ORDER BY ' . $order;
+            $sql .= ' ORDER BY '.$order;
         }
 
         if (!is_null($limit)) {
             $limit = Database::escape_string($limit);
-            $sql .= ' LIMIT ' . $limit;
+            $sql .= ' LIMIT '.$limit;
         }
 
         $rs = Database::query($sql);
@@ -1443,7 +1443,7 @@ 
             // In exceptional cases, on some portals, the intermediate base user
             // directory might not have been created. Make sure it is before
             // going further.
-            $rootPath = api_get_path(SYS_UPLOAD_PATH) . 'users/' . substr((string) $id, 0, 1);
+            $rootPath = api_get_path(SYS_UPLOAD_PATH).'users/'.substr((string) $id, 0, 1);
             if (!is_dir($rootPath)) {
                 $perm = api_get_permissions_for_new_directories();
                 try {
@@ -1695,7 +1695,7 @@ 
         $path_info = self::get_user_picture_path_by_id($user_id, 'system');
         $path = $path_info['dir'];
         if (!empty($extra_field)) {
-            $path .= $extra_field . '/';
+            $path .= $extra_field.'/';
         }
         // If this directory does not exist - we create it.
         if (!file_exists($path)) {
@@ -1703,7 +1703,7 @@ 
         }
 
         if (filter_extension($file)) {
-            if (@move_uploaded_file($source_file,$path.$file)) {
+            if (@move_uploaded_file($source_file, $path.$file)) {
                 if ($extra_field) {
                     return $extra_field.'/'.$file;
                 } else {
@@ -1956,10 +1956,10 @@ 
         if (count($extra_files) > 0) {
             $extra_file_list = '<div class="files-production"><ul id="productions">';
             foreach ($extra_files as $file) {
-                $filename = substr($file,strlen($extra_field)+1);
+                $filename = substr($file, strlen($extra_field) + 1);
                 $extra_file_list .= '<li>'.Display::return_icon('archive.png').'<a href="'.$path.$extra_field.'/'.urlencode($filename).'" target="_blank">'.htmlentities($filename).'</a> ';
                 if ($showdelete) {
-                    $extra_file_list .= '<input style="width:16px;" type="image" name="remove_extra_' . $extra_field . '['.urlencode($file).']" src="'.$del_image.'" alt="'.$del_text.'" title="'.$del_text.' '.htmlentities($filename).'" onclick="javascript: return confirmation(\''.htmlentities($filename).'\');" /></li>';
+                    $extra_file_list .= '<input style="width:16px;" type="image" name="remove_extra_'.$extra_field.'['.urlencode($file).']" src="'.$del_image.'" alt="'.$del_text.'" title="'.$del_text.' '.htmlentities($filename).'" onclick="javascript: return confirmation(\''.htmlentities($filename).'\');" /></li>';
                 }
             }
             $extra_file_list .= '</ul></div>';
@@ -2544,7 +2544,7 @@ 
 
         if (api_is_allowed_to_create_course()) {
             $sessionListFromCourseCoach = array();
-            $sql =" SELECT DISTINCT session_id
+            $sql = " SELECT DISTINCT session_id
                     FROM $tbl_session_course_user
                     WHERE user_id = $user_id AND status = 2 ";
 
@@ -2552,7 +2552,7 @@ 
             if (Database::num_rows($result)) {
                 $result = Database::store_result($result);
                 foreach ($result as $session) {
-                    $sessionListFromCourseCoach[]= $session['session_id'];
+                    $sessionListFromCourseCoach[] = $session['session_id'];
                 }
             }
             if (!empty($sessionListFromCourseCoach)) {
@@ -2575,7 +2575,7 @@ 
                 ORDER BY access_start_date, access_end_date, name";
 
         $result = Database::query($sql);
-        if (Database::num_rows($result)>0) {
+        if (Database::num_rows($result) > 0) {
             while ($row = Database::fetch_assoc($result)) {
                 $sessions[$row['id']] = $row;
             }
@@ -2591,7 +2591,7 @@ 
                 ORDER BY access_start_date, access_end_date, name";
 
         $result = Database::query($sql);
-        if (Database::num_rows($result)>0) {
+        if (Database::num_rows($result) > 0) {
             while ($row = Database::fetch_assoc($result)) {
                 if (empty($sessions[$row['id']])) {
                     $sessions[$row['id']] = $row;
@@ -3583,13 +3583,13 @@ 
         $useExtraFields = false;
         $extraFields = UserManager::get_extra_filtrable_fields();
         $extraFieldResult = array();
-        if (is_array($extraFields) && count($extraFields)>0 ) {
+        if (is_array($extraFields) && count($extraFields) > 0) {
             foreach ($extraFields as $extraField) {
                 $varName = 'field_'.$extraField['variable'];
                 //if (UserManager::is_extra_field_available($extraField['variable'])) {
-                    if (isset($_GET[$varName]) && $_GET[$varName]!='0') {
+                    if (isset($_GET[$varName]) && $_GET[$varName] != '0') {
                         $useExtraFields = true;
-                        $extraFieldResult[]= UserManager::get_extra_user_data_by_value(
+                        $extraFieldResult[] = UserManager::get_extra_user_data_by_value(
                             $extraField['variable'],
                             $_GET[$varName]
                         );
@@ -3600,17 +3600,17 @@ 
 
         if ($useExtraFields) {
             $finalResult = array();
-            if (count($extraFieldResult)>1) {
-                for ($i=0; $i < count($extraFieldResult) -1; $i++) {
-                if (is_array($extraFieldResult[$i]) && is_array($extraFieldResult[$i+1])) {
-                        $finalResult  = array_intersect($extraFieldResult[$i], $extraFieldResult[$i+1]);
+            if (count($extraFieldResult) > 1) {
+                for ($i = 0; $i < count($extraFieldResult) - 1; $i++) {
+                if (is_array($extraFieldResult[$i]) && is_array($extraFieldResult[$i + 1])) {
+                        $finalResult = array_intersect($extraFieldResult[$i], $extraFieldResult[$i + 1]);
                     }
                 }
             } else {
                 $finalResult = $extraFieldResult[0];
             }
 
-            if (is_array($finalResult) && count($finalResult)>0) {
+            if (is_array($finalResult) && count($finalResult) > 0) {
                 $whereFilter = " AND u.id IN  ('".implode("','", $finalResult)."') ";
             } else {
                 //no results
@@ -3787,7 +3787,7 @@ 
             $sql = 'DELETE FROM '.$tbl_my_friend.'
                     WHERE relation_type <> '.USER_RELATION_TYPE_RRHH.' AND friend_user_id='.$friend_id.' '.$extra_condition;
             Database::query($sql);
-            $sql= 'DELETE FROM '.$tbl_my_friend.'
+            $sql = 'DELETE FROM '.$tbl_my_friend.'
                    WHERE relation_type <> '.USER_RELATION_TYPE_RRHH.' AND user_id='.$friend_id.' '.$extra_condition;
             Database::query($sql);
         } else {
@@ -3988,7 +3988,7 @@ 
 
         if (!empty($lastConnectionDate)) {
             $lastConnectionDate = Database::escape_string($lastConnectionDate);
-            $userConditions .=  " AND u.last_login <= '$lastConnectionDate' ";
+            $userConditions .= " AND u.last_login <= '$lastConnectionDate' ";
         }
 
         $courseConditions = null;
@@ -4055,7 +4055,7 @@ 
                 break;
             case STUDENT_BOSS :
                 $drhConditions = " AND friend_user_id = $userId AND "
-                . "relation_type = " . USER_RELATION_TYPE_BOSS;
+                . "relation_type = ".USER_RELATION_TYPE_BOSS;
                 break;
         }
 
@@ -4146,7 +4146,7 @@ 
                     WHERE 
                         friend_user_id = $userId AND 
                         relation_type = $relationType AND 
-                        access_url_id = " . api_get_current_access_url_id();
+                        access_url_id = ".api_get_current_access_url_id();
         } else {
             $sql = "SELECT user_id FROM $userRelUserTable 
                     WHERE friend_user_id = $userId 
@@ -4428,7 +4428,7 @@ 
         if (empty($years)) {
             $years = 1;
         }
-        $inactive_time = $years * 31536000;  //1 year
+        $inactive_time = $years * 31536000; //1 year
         $rs = Database::query($sql);
         if (Database::num_rows($rs) > 0) {
             if ($last_login_date = Database::result($rs, 0, 0)) {
@@ -4561,7 +4561,7 @@ 
                         'extra_'.$field_details[1],
                         $field_details[3],
                         $options,
-                        array('id' => 'extra_' . $field_details[1])
+                        array('id' => 'extra_'.$field_details[1])
                     );
 
                     if (!$admin_permissions) {
@@ -4715,7 +4715,7 @@ 
                     $extra_field = 'extra_'.$field_details[1];
                     $form->addElement('file', $extra_field, $field_details[3], null, '');
                     if ($extra_file_list = UserManager::build_user_extra_file_list($user_id, $field_details[1], '', true)) {
-                        $form->addElement('static', $extra_field . '_list', null, $extra_file_list);
+                        $form->addElement('static', $extra_field.'_list', null, $extra_file_list);
                     }
                     if ($field_details[7] == 0) {
                         $form->freeze($extra_field);
@@ -4883,7 +4883,7 @@ 
         $direction = null,
         $active = null,
         $lastConnectionDate = null
-    ){
+    ) {
         return self::getUsersFollowedByUser(
             $userId,
             $userStatus,
@@ -5090,12 +5090,12 @@ 
         if (!empty($_SERVER['HTTPS'])) {
             $url = 'https://secure.gravatar.com/avatar/';
         }
-        $url .= md5( strtolower( trim( $email ) ) );
+        $url .= md5(strtolower(trim($email)));
         $url .= "?s=$s&d=$d&r=$r";
-        if ( $img ) {
-            $url = '<img src="' . $url . '"';
-            foreach ( $atts as $key => $val )
-                $url .= ' ' . $key . '="' . $val . '"';
+        if ($img) {
+            $url = '<img src="'.$url.'"';
+            foreach ($atts as $key => $val)
+                $url .= ' '.$key.'="'.$val.'"';
             $url .= ' />';
         }
         return $url;

Indentation +32 added lines, -32 removed lines

@@ -1231,13 +1231,13 @@ 
     }
 
     /**
-    * Get the users by ID
-    * @param array $ids student ids
-    * @param string $active
-    * @param string $order
-    * @param string $limit
-    * @return array $result student information
-    */
+     * Get the users by ID
+     * @param array $ids student ids
+     * @param string $active
+     * @param string $order
+     * @param string $limit
+     * @return array $result student information
+     */
     public static function get_user_list_by_ids($ids = array(), $active = null, $order = null, $limit = null)
     {
         if (empty($ids)) {
@@ -2275,7 +2275,7 @@ 
      *
      * @return array with extra data info of a user i.e array('field_variable'=>'value');
      */
-     public static function get_extra_user_data_by_value($field_variable, $field_value, $all_visibility = true)
+        public static function get_extra_user_data_by_value($field_variable, $field_value, $all_visibility = true)
     {
         $extraField = new ExtraFieldValue('user');
 
@@ -3352,12 +3352,12 @@ 
         if ($tag_id == 0) {
             //the tag doesn't exist
             $sql = "INSERT INTO $table_user_tag (tag, field_id,count) VALUES ('$tag','$field_id', count + 1)";
-             Database::query($sql);
+                Database::query($sql);
             $last_insert_id = Database::insert_id();
         } else {
             //the tag exists we update it
             $sql = "UPDATE $table_user_tag SET count = count + 1 WHERE id  = $tag_id";
-             Database::query($sql);
+                Database::query($sql);
             $last_insert_id = $tag_id;
         }
 
@@ -3552,9 +3552,9 @@ 
     }
 
     /**
-      * Get extra filtrable user fields (only type select)
-      * @return array
-      */
+     * Get extra filtrable user fields (only type select)
+     * @return array
+     */
     public static function get_extra_filtrable_fields()
     {
         $extraFieldList = UserManager::get_extra_fields();
@@ -3579,9 +3579,9 @@ 
     }
 
     /**
-      * Get extra where clauses for finding users based on extra filtrable user fields (type select)
-      * @return string With AND clauses based on user's ID which have the values to search in extra user fields
-      */
+     * Get extra where clauses for finding users based on extra filtrable user fields (type select)
+     * @return string With AND clauses based on user's ID which have the values to search in extra user fields
+     */
     public static function get_search_form_where_extra_fields()
     {
         $useExtraFields = false;
@@ -3900,23 +3900,23 @@ 
     }
 
     /**
-    * Get users followed by human resource manager
-    * @param int $userId
-    * @param int  $userStatus Filter users by status (STUDENT, COURSEMANAGER, etc)
-    * @param bool $getOnlyUserId
-    * @param bool $getSql
-    * @param bool $getCount
-    * @param int $from
-    * @param int $numberItems
-    * @param int $column
-    * @param string $direction
-    * @param int $active
-    * @param string $lastConnectionDate
-    * @param int $status the function is called by who? COURSEMANAGER, DRH?
-    * @param string $keyword
+     * Get users followed by human resource manager
+     * @param int $userId
+     * @param int  $userStatus Filter users by status (STUDENT, COURSEMANAGER, etc)
+     * @param bool $getOnlyUserId
+     * @param bool $getSql
+     * @param bool $getCount
+     * @param int $from
+     * @param int $numberItems
+     * @param int $column
+     * @param string $direction
+     * @param int $active
+     * @param string $lastConnectionDate
+     * @param int $status the function is called by who? COURSEMANAGER, DRH?
+     * @param string $keyword
      *
-    * @return array user list
-    */
+     * @return array user list
+     */
     public static function getUsersFollowedByUser(
         $userId,
         $userStatus = null,

main/inc/lib/VideoChat.php

Doc Comments +1 added lines, -1 removed lines

@@ -43,7 +43,7 @@
      * Create a video chat
      * @param int $fromUser The sender user
      * @param int $toUser The receiver user
-     * @return int The created video chat id. Otherwise return false
+     * @return false|string The created video chat id. Otherwise return false
      */
     public static function createRoom($fromUser, $toUser)
     {

main/inc/lib/xajax/xajax.inc.php

Doc Comments +2 added lines, -1 removed lines

@@ -500,7 +500,7 @@ 
 	 * Returns the current request mode (XAJAX_GET or XAJAX_POST), or -1 if
 	 * there is none.
 	 *
-	 * @return mixed
+	 * @return integer
 	 */
 	function getRequestMode()
 	{
@@ -1018,6 +1018,7 @@ 
 	 *
 	 * @param string the root tag of the XML
 	 * @param string XML to convert
+	 * @param string $rootTag
 	 * @access private
 	 * @return array
 	 */

Braces +84 added lines, -86 removed lines

@@ -173,8 +173,9 @@ 
 		$this->aObjects = array();
 		$this->aFunctionIncludeFiles = array();
 		$this->sRequestURI = $sRequestURI;
-		if ($this->sRequestURI == "")
-			$this->sRequestURI = $this->_detectURI();
+		if ($this->sRequestURI == "") {
+					$this->sRequestURI = $this->_detectURI();
+		}
 		$this->sWrapperPrefix = $sWrapperPrefix;
 		$this->bDebug = $bDebug;
 		$this->bStatusMessages = false;
@@ -399,8 +400,7 @@ 
 			$this->aFunctions[$mFunction[0]] = 1;
 			$this->aFunctionRequestTypes[$mFunction[0]] = $sRequestType;
 			$this->aObjects[$mFunction[0]] = array_slice($mFunction, 1);
-		}
-		else {
+		} else {
 			$this->aFunctions[$mFunction] = 1;
 			$this->aFunctionRequestTypes[$mFunction] = $sRequestType;
 		}
@@ -426,8 +426,7 @@ 
 
 		if (is_array($mFunction)) {
 			$this->aFunctionIncludeFiles[$mFunction[0]] = $sIncludeFile;
-		}
-		else {
+		} else {
 			$this->aFunctionIncludeFiles[$mFunction] = $sIncludeFile;
 		}
 	}
@@ -451,8 +450,7 @@ 
 		if (is_array($mFunction)) {
 			$this->sCatchAllFunction = $mFunction[0];
 			$this->aObjects[$mFunction[0]] = array_slice($mFunction, 1);
-		}
-		else {
+		} else {
 			$this->sCatchAllFunction = $mFunction;
 		}
 	}
@@ -477,8 +475,7 @@ 
 		if (is_array($mFunction)) {
 			$this->sPreFunction = $mFunction[0];
 			$this->aObjects[$mFunction[0]] = array_slice($mFunction, 1);
-		}
-		else {
+		} else {
 			$this->sPreFunction = $mFunction;
 		}
 	}
@@ -492,7 +489,9 @@ 
 	 */
 	function canProcessRequests()
 	{
-		if ($this->getRequestMode() != -1) return true;
+		if ($this->getRequestMode() != -1) {
+		    return true;
+		}
 		return false;
 	}
 
@@ -504,11 +503,13 @@ 
 	 */
 	function getRequestMode()
 	{
-		if (!empty($_GET["xajax"]))
-			return XAJAX_GET;
+		if (!empty($_GET["xajax"])) {
+					return XAJAX_GET;
+		}
 
-		if (!empty($_POST["xajax"]))
-			return XAJAX_POST;
+		if (!empty($_POST["xajax"])) {
+					return XAJAX_POST;
+		}
 
 		return -1;
 	}
@@ -535,16 +536,18 @@ 
 		$sResponse = "";
 
 		$requestMode = $this->getRequestMode();
-		if ($requestMode == -1) return;
+		if ($requestMode == -1) {
+		    return;
+		}
 
 		if ($requestMode == XAJAX_POST)
 		{
 			$sFunctionName = $_POST["xajax"];
 
-			if (!empty($_POST["xajaxargs"]))
-				$aArgs = $_POST["xajaxargs"];
-		}
-		else
+			if (!empty($_POST["xajaxargs"])) {
+							$aArgs = $_POST["xajaxargs"];
+			}
+		} else
 		{
 			header ("Expires: Mon, 26 Jul 1997 05:00:00 GMT");
 			header ("Last-Modified: " . gmdate("D, d M Y H:i:s") . " GMT");
@@ -553,8 +556,9 @@ 
 
 			$sFunctionName = $_GET["xajax"];
 
-			if (!empty($_GET["xajaxargs"]))
-				$aArgs = $_GET["xajaxargs"];
+			if (!empty($_GET["xajaxargs"])) {
+							$aArgs = $_GET["xajaxargs"];
+			}
 		}
 
 		// Use xajax error handler if necessary
@@ -586,15 +590,13 @@ 
 				if ($this->sCatchAllFunction) {
 					$sFunctionName = $this->sCatchAllFunction;
 					$bFunctionIsCatchAll = true;
-				}
-				else {
+				} else {
 					$bFoundFunction = false;
 					$objResponse = new xajaxResponse();
 					$objResponse->addAlert("Unknown Function $sFunctionName.");
 					$sResponse = $objResponse->getXML();
 				}
-			}
-			else if ($this->aFunctionRequestTypes[$sFunctionName] != $requestMode)
+			} else if ($this->aFunctionRequestTypes[$sFunctionName] != $requestMode)
 			{
 				$bFoundFunction = false;
 				$objResponse = new xajaxResponse();
@@ -615,12 +617,10 @@ 
 				if (stristr($aArgs[$i],"<xjxobj>") != false)
 				{
 					$aArgs[$i] = $this->_xmlToArray("xjxobj",$aArgs[$i]);
-				}
-				else if (stristr($aArgs[$i],"<xjxquery>") != false)
+				} else if (stristr($aArgs[$i],"<xjxquery>") != false)
 				{
 					$aArgs[$i] = $this->_xmlToArray("xjxquery",$aArgs[$i]);
-				}
-				else if ($this->bDecodeUTF8Input)
+				} else if ($this->bDecodeUTF8Input)
 				{
 					$aArgs[$i] = $this->_decodeUTF8Data($aArgs[$i]);
 				}
@@ -631,14 +631,15 @@ 
 				if (is_array($mPreResponse) && $mPreResponse[0] === false) {
 					$bEndRequest = true;
 					$sPreResponse = $mPreResponse[1];
-				}
-				else {
+				} else {
 					$sPreResponse = $mPreResponse;
 				}
 				if (is_a($sPreResponse, "xajaxResponse")) {
 					$sPreResponse = $sPreResponse->getXML();
 				}
-				if ($bEndRequest) $sResponse = $sPreResponse;
+				if ($bEndRequest) {
+				    $sResponse = $sPreResponse;
+				}
 			}
 
 			if (!$bEndRequest) {
@@ -646,8 +647,7 @@ 
 					$objResponse = new xajaxResponse();
 					$objResponse->addAlert("The Registered Function $sFunctionName Could Not Be Found.");
 					$sResponse = $objResponse->getXML();
-				}
-				else {
+				} else {
 					if ($bFunctionIsCatchAll) {
 						$aArgs = array($sFunctionNameForSpecial, $aArgs);
 					}
@@ -660,8 +660,7 @@ 
 					$objResponse = new xajaxResponse();
 					$objResponse->addAlert("No XML Response Was Returned By Function $sFunctionName.");
 					$sResponse = $objResponse->getXML();
-				}
-				else if ($sPreResponse != "") {
+				} else if ($sPreResponse != "") {
 					$sNewResponse = new xajaxResponse($this->sEncoding, $this->bOutputEntities);
 					$sNewResponse->loadXML($sPreResponse);
 					$sNewResponse->loadXML($sResponse);
@@ -671,8 +670,9 @@ 
 		}
 
 		$sContentHeader = "Content-type: text/xml;";
-		if ($this->sEncoding && strlen(trim($this->sEncoding)) > 0)
-			$sContentHeader .= " charset=".$this->sEncoding;
+		if ($this->sEncoding && strlen(trim($this->sEncoding)) > 0) {
+					$sContentHeader .= " charset=".$this->sEncoding;
+		}
 		header($sContentHeader);
 		if ($this->bErrorHandler && !empty( $GLOBALS['xajaxErrorHandlerText'] )) {
 			$sErrorResponse = new xajaxResponse();
@@ -681,8 +681,7 @@ 
 				$fH = @fopen($this->sLogFile, "a");
 				if (!$fH) {
 					$sErrorResponse->addAlert("** Logging Error **\n\nxajax was unable to write to the error log file:\n" . $this->sLogFile);
-				}
-				else {
+				} else {
 					fwrite($fH, "** xajax Error Log - " . strftime("%b %e %Y %I:%M:%S %p") . " **" . $GLOBALS['xajaxErrorHandlerText'] . "\n\n\n");
 					fclose($fH);
 				}
@@ -692,12 +691,17 @@ 
 			$sResponse = $sErrorResponse->getXML();
 
 		}
-		if ($this->bCleanBuffer) while (@ob_end_clean());
+		if ($this->bCleanBuffer) {
+		    while (@ob_end_clean());
+		}
 		print $sResponse;
-		if ($this->bErrorHandler) restore_error_handler();
+		if ($this->bErrorHandler) {
+		    restore_error_handler();
+		}
 
-		if ($this->bExitAllowed)
-			exit();
+		if ($this->bExitAllowed) {
+					exit();
+		}
 	}
 
 	/**
@@ -806,9 +810,13 @@ 
 	 */
 	function getJavascriptInclude($sJsURI="", $sJsFile=NULL)
 	{
-		if ($sJsFile == NULL) $sJsFile = "xajax_js/xajax.js";
+		if ($sJsFile == NULL) {
+		    $sJsFile = "xajax_js/xajax.js";
+		}
 
-		if ($sJsURI != "" && substr($sJsURI, -1) != "/") $sJsURI .= "/";
+		if ($sJsURI != "" && substr($sJsURI, -1) != "/") {
+		    $sJsURI .= "/";
+		}
 
 		$html = "\t<script type=\"text/javascript\" src=\"" . $sJsURI . $sJsFile . "\"></script>\n";
 		$html .= "\t<script type=\"text/javascript\">\n";
@@ -831,8 +839,7 @@ 
 
 		if ($sJsFullFilename) {
 			$realJsFile = $sJsFullFilename;
-		}
-		else {
+		} else {
 			$realPath = realpath(dirname(__FILE__));
 			$realJsFile = $realPath . "/". $sJsFile;
 		}
@@ -849,8 +856,7 @@ 
 			$fH = @fopen($realJsFile, "w");
 			if (!$fH) {
 				trigger_error("The xajax compressed javascript file could not be written in the <b>" . dirname($realJsFile) . "</b> folder. Error ", E_USER_ERROR);
-			}
-			else {
+			} else {
 				fwrite($fH, $compressedScript);
 				fclose($fH);
 			}
@@ -950,7 +956,9 @@ 
 	 */
 	function _isObjectCallback($sFunction)
 	{
-		if (array_key_exists($sFunction, $this->aObjects)) return true;
+		if (array_key_exists($sFunction, $this->aObjects)) {
+		    return true;
+		}
 		return false;
 	}
 
@@ -967,12 +975,10 @@ 
 		if ($this->_isObjectCallback($sFunction)) {
 			if (is_object($this->aObjects[$sFunction][0])) {
 				return method_exists($this->aObjects[$sFunction][0], $this->aObjects[$sFunction][1]);
-			}
-			else {
+			} else {
 				return is_callable($this->aObjects[$sFunction]);
 			}
-		}
-		else {
+		} else {
 			return function_exists($sFunction);
 		}
 	}
@@ -990,8 +996,7 @@ 
 	{
 		if ($this->_isObjectCallback($sFunction)) {
 			$mReturn = call_user_func_array($this->aObjects[$sFunction], $aArgs);
-		}
-		else {
+		} else {
 			$mReturn = call_user_func_array($sFunction, $aArgs);
 		}
 		return $mReturn;
@@ -1086,8 +1091,7 @@ 
 								{
 									$value = $this->_parseObjXml("xjxobj");
 									$this->iPos++;
-								}
-								else
+								} else
 								{
 									$value .= $this->aObjArray[$this->iPos];
 									if ($this->bDecodeUTF8Input)
@@ -1134,10 +1138,11 @@ 
 			if (get_magic_quotes_gpc() == 1) {
 				$newArray = array();
 				foreach ($aArray as $sKey => $sValue) {
-					if (is_string($sValue))
-						$newArray[$sKey] = stripslashes($sValue);
-					else
-						$newArray[$sKey] = $sValue;
+					if (is_string($sValue)) {
+											$newArray[$sKey] = stripslashes($sValue);
+					} else {
+											$newArray[$sKey] = $sValue;
+					}
 				}
 				$aArray = $newArray;
 			}
@@ -1166,20 +1171,18 @@ 
 				$sFuncToUse = "api_convert_encoding";
 			}
 			//if (function_exists('iconv'))
-			elseif (function_exists('iconv'))
-			//
+			elseif (function_exists('iconv')) {
+						//
 			{
 				$sFuncToUse = "iconv";
 			}
-			else if (function_exists('mb_convert_encoding'))
+			} else if (function_exists('mb_convert_encoding'))
 			{
 				$sFuncToUse = "mb_convert_encoding";
-			}
-			else if ($this->sEncoding == "ISO-8859-1")
+			} else if ($this->sEncoding == "ISO-8859-1")
 			{
 				$sFuncToUse = "utf8_decode";
-			}
-			else
+			} else
 			{
 				trigger_error("The incoming xajax data could not be converted from UTF-8", E_USER_NOTICE);
 			}
@@ -1191,8 +1194,7 @@ 
 					if ($sFuncToUse == "iconv")
 					{
 						$sValue = iconv("UTF-8", $this->sEncoding.'//TRANSLIT', $sValue);
-					}
-					else if ($sFuncToUse == "mb_convert_encoding")
+					} else if ($sFuncToUse == "mb_convert_encoding")
 					{
 						$sValue = mb_convert_encoding($sValue, $this->sEncoding, "UTF-8");
 					}
@@ -1221,27 +1223,23 @@ 
 function xajaxErrorHandler($errno, $errstr, $errfile, $errline)
 {
 	$errorReporting = error_reporting();
-	if (($errno & $errorReporting) == 0) return;
+	if (($errno & $errorReporting) == 0) {
+	    return;
+	}
 
 	if ($errno == E_NOTICE) {
 		$errTypeStr = "NOTICE";
-	}
-	else if ($errno == E_WARNING) {
+	} else if ($errno == E_WARNING) {
 		$errTypeStr = "WARNING";
-	}
-	else if ($errno == E_USER_NOTICE) {
+	} else if ($errno == E_USER_NOTICE) {
 		$errTypeStr = "USER NOTICE";
-	}
-	else if ($errno == E_USER_WARNING) {
+	} else if ($errno == E_USER_WARNING) {
 		$errTypeStr = "USER WARNING";
-	}
-	else if ($errno == E_USER_ERROR) {
+	} else if ($errno == E_USER_ERROR) {
 		$errTypeStr = "USER FATAL ERROR";
-	}
-	else if ($errno == E_STRICT) {
+	} else if ($errno == E_STRICT) {
 		return;
-	}
-	else {
+	} else {
 		$errTypeStr = "UNKNOWN: $errno";
 	}
 	$GLOBALS['xajaxErrorHandlerText'] .= "\n----\n[$errTypeStr] $errstr\nerror in line $errline of file $errfile";

Spacing +68 added lines, -68 removed lines

@@ -45,21 +45,21 @@ 
  * Define XAJAX_DEFAULT_CHAR_ENCODING that is used by both
  * the xajax and xajaxResponse classes
  */
-if (!defined ('XAJAX_DEFAULT_CHAR_ENCODING'))
+if (!defined('XAJAX_DEFAULT_CHAR_ENCODING'))
 {
-	define ('XAJAX_DEFAULT_CHAR_ENCODING', 'utf-8' );
+	define('XAJAX_DEFAULT_CHAR_ENCODING', 'utf-8');
 }
 
 /**
  * Communication Method Defines
  */
-if (!defined ('XAJAX_GET'))
+if (!defined('XAJAX_GET'))
 {
-	define ('XAJAX_GET', 0);
+	define('XAJAX_GET', 0);
 }
-if (!defined ('XAJAX_POST'))
+if (!defined('XAJAX_POST'))
 {
-	define ('XAJAX_POST', 1);
+	define('XAJAX_POST', 1);
 }
 
 /**
@@ -167,7 +167,7 @@ 
 	 * @param string  defaults to XAJAX_DEFAULT_CHAR_ENCODING defined above
 	 * @param boolean defaults to false
 	 */
-	public function __construct($sRequestURI="",$sWrapperPrefix="xajax_",$sEncoding=XAJAX_DEFAULT_CHAR_ENCODING,$bDebug=false)
+	public function __construct($sRequestURI = "", $sWrapperPrefix = "xajax_", $sEncoding = XAJAX_DEFAULT_CHAR_ENCODING, $bDebug = false)
 	{
 		$this->aFunctions = array();
 		$this->aObjects = array();
@@ -393,7 +393,7 @@ 
 	 * @param mixed  request type (XAJAX_GET/XAJAX_POST) that should be used
 	 *               for this function.  Defaults to XAJAX_POST.
 	 */
-	function registerFunction($mFunction,$sRequestType=XAJAX_POST)
+	function registerFunction($mFunction, $sRequestType = XAJAX_POST)
 	{
 		if (is_array($mFunction)) {
 			$this->aFunctions[$mFunction[0]] = 1;
@@ -420,7 +420,7 @@ 
 	 * @param mixed  the RequestType (XAJAX_GET/XAJAX_POST) that should be used
 	 *		          for this function. Defaults to XAJAX_POST.
 	 */
-	function registerExternalFunction($mFunction,$sIncludeFile,$sRequestType=XAJAX_POST)
+	function registerExternalFunction($mFunction, $sIncludeFile, $sRequestType = XAJAX_POST)
 	{
 		$this->registerFunction($mFunction, $sRequestType);
 
@@ -545,10 +545,10 @@ 
 		}
 		else
 		{
-			header ("Expires: Mon, 26 Jul 1997 05:00:00 GMT");
-			header ("Last-Modified: " . gmdate("D, d M Y H:i:s") . " GMT");
-			header ("Cache-Control: no-cache, must-revalidate");
-			header ("Pragma: no-cache");
+			header("Expires: Mon, 26 Jul 1997 05:00:00 GMT");
+			header("Last-Modified: ".gmdate("D, d M Y H:i:s")." GMT");
+			header("Cache-Control: no-cache, must-revalidate");
+			header("Pragma: no-cache");
 
 			$sFunctionName = $_GET["xajax"];
 
@@ -566,12 +566,12 @@ 
 			if (!$this->_isFunctionCallable($this->sPreFunction)) {
 				$bFoundFunction = false;
 				$objResponse = new xajaxResponse();
-				$objResponse->addAlert("Unknown Pre-Function ". $this->sPreFunction);
+				$objResponse->addAlert("Unknown Pre-Function ".$this->sPreFunction);
 				$sResponse = $objResponse->getXML();
 			}
 		}
 		//include any external dependencies associated with this function name
-		if (array_key_exists($sFunctionName,$this->aFunctionIncludeFiles))
+		if (array_key_exists($sFunctionName, $this->aFunctionIncludeFiles))
 		{
 			ob_start();
 			include_once($this->aFunctionIncludeFiles[$sFunctionName]);
@@ -611,13 +611,13 @@ 
 
 					$aArgs[$i] = stripslashes($aArgs[$i]);
 				}
-				if (stristr($aArgs[$i],"<xjxobj>") != false)
+				if (stristr($aArgs[$i], "<xjxobj>") != false)
 				{
-					$aArgs[$i] = $this->_xmlToArray("xjxobj",$aArgs[$i]);
+					$aArgs[$i] = $this->_xmlToArray("xjxobj", $aArgs[$i]);
 				}
-				else if (stristr($aArgs[$i],"<xjxquery>") != false)
+				else if (stristr($aArgs[$i], "<xjxquery>") != false)
 				{
-					$aArgs[$i] = $this->_xmlToArray("xjxquery",$aArgs[$i]);
+					$aArgs[$i] = $this->_xmlToArray("xjxquery", $aArgs[$i]);
 				}
 				else if ($this->bDecodeUTF8Input)
 				{
@@ -673,16 +673,16 @@ 
 		if ($this->sEncoding && strlen(trim($this->sEncoding)) > 0)
 			$sContentHeader .= " charset=".$this->sEncoding;
 		header($sContentHeader);
-		if ($this->bErrorHandler && !empty( $GLOBALS['xajaxErrorHandlerText'] )) {
+		if ($this->bErrorHandler && !empty($GLOBALS['xajaxErrorHandlerText'])) {
 			$sErrorResponse = new xajaxResponse();
-			$sErrorResponse->addAlert("** PHP Error Messages: **" . $GLOBALS['xajaxErrorHandlerText']);
+			$sErrorResponse->addAlert("** PHP Error Messages: **".$GLOBALS['xajaxErrorHandlerText']);
 			if ($this->sLogFile) {
 				$fH = @fopen($this->sLogFile, "a");
 				if (!$fH) {
-					$sErrorResponse->addAlert("** Logging Error **\n\nxajax was unable to write to the error log file:\n" . $this->sLogFile);
+					$sErrorResponse->addAlert("** Logging Error **\n\nxajax was unable to write to the error log file:\n".$this->sLogFile);
 				}
 				else {
-					fwrite($fH, "** xajax Error Log - " . strftime("%b %e %Y %I:%M:%S %p") . " **" . $GLOBALS['xajaxErrorHandlerText'] . "\n\n\n");
+					fwrite($fH, "** xajax Error Log - ".strftime("%b %e %Y %I:%M:%S %p")." **".$GLOBALS['xajaxErrorHandlerText']."\n\n\n");
 					fclose($fH);
 				}
 			}
@@ -724,7 +724,7 @@ 
 	 *               engine located within the xajax installation folder.
 	 *               Defaults to xajax_js/xajax.js.
 	 */
-	function printJavascript($sJsURI="", $sJsFile=NULL)
+	function printJavascript($sJsURI = "", $sJsFile = NULL)
 	{
 		print $this->getJavascript($sJsURI, $sJsFile);
 	}
@@ -753,7 +753,7 @@ 
 	 *               Defaults to xajax_js/xajax.js.
 	 * @return string
 	 */
-	function getJavascript($sJsURI="", $sJsFile=NULL)
+	function getJavascript($sJsURI = "", $sJsFile = NULL)
 	{
 		$html = $this->getJavascriptConfig();
 		$html .= $this->getJavascriptInclude($sJsURI, $sJsFile);
@@ -771,15 +771,15 @@ 
 	{
 		$html  = "\t<script type=\"text/javascript\">\n";
 		$html .= "var xajaxRequestUri=\"".$this->sRequestURI."\";\n";
-		$html .= "var xajaxDebug=".($this->bDebug?"true":"false").";\n";
-		$html .= "var xajaxStatusMessages=".($this->bStatusMessages?"true":"false").";\n";
-		$html .= "var xajaxWaitCursor=".($this->bWaitCursor?"true":"false").";\n";
+		$html .= "var xajaxDebug=".($this->bDebug ? "true" : "false").";\n";
+		$html .= "var xajaxStatusMessages=".($this->bStatusMessages ? "true" : "false").";\n";
+		$html .= "var xajaxWaitCursor=".($this->bWaitCursor ? "true" : "false").";\n";
 		$html .= "var xajaxDefinedGet=".XAJAX_GET.";\n";
 		$html .= "var xajaxDefinedPost=".XAJAX_POST.";\n";
 		$html .= "var xajaxLoaded=false;\n";
 
-		foreach($this->aFunctions as $sFunction => $bExists) {
-			$html .= $this->_wrap($sFunction,$this->aFunctionRequestTypes[$sFunction]);
+		foreach ($this->aFunctions as $sFunction => $bExists) {
+			$html .= $this->_wrap($sFunction, $this->aFunctionRequestTypes[$sFunction]);
 		}
 
 		$html .= "\t</script>\n";
@@ -803,7 +803,7 @@ 
 	 *               Defaults to xajax_js/xajax.js.
 	 * @return string
 	 */
-	function getJavascriptInclude($sJsURI="", $sJsFile=NULL)
+	function getJavascriptInclude($sJsURI = "", $sJsFile = NULL)
 	{
         //if ($sJsFile == NULL) $sJsFile = "xajax_js/xajax.js";
         $sJsFile = "xajax_js/xajax.js";
@@ -811,7 +811,7 @@ 
         //if ($sJsURI != "" && substr($sJsURI, -1) != "/") $sJsURI .= "/";
         $sJsURI = api_get_path(WEB_LIBRARY_JS_PATH);
 
-		$html = "\t<script type=\"text/javascript\" src=\"" . $sJsURI . $sJsFile . "\"></script>\n";
+		$html = "\t<script type=\"text/javascript\" src=\"".$sJsURI.$sJsFile."\"></script>\n";
 		$html .= "\t<script type=\"text/javascript\">\n";
 		$html .= "window.setTimeout(function () { if (!xajaxLoaded) { alert('Error: the xajax Javascript file could not be included. Perhaps the URL is incorrect?\\nURL: {$sJsURI}{$sJsFile}'); } }, 6000);\n";
 		$html .= "\t</script>\n";
@@ -826,7 +826,7 @@ 
 	 * @param string an optional argument containing the full server file path
 	 *               of xajax.js.
 	 */
-	function autoCompressJavascript($sJsFullFilename=NULL)
+	function autoCompressJavascript($sJsFullFilename = NULL)
 	{
 		$sJsFile = "xajax_js/xajax.js";
 
@@ -835,21 +835,21 @@ 
 		}
 		else {
 			$realPath = realpath(dirname(__FILE__));
-			$realJsFile = $realPath . "/". $sJsFile;
+			$realJsFile = $realPath."/".$sJsFile;
 		}
 
 		// Create a compressed file if necessary
 		if (!file_exists($realJsFile)) {
 			$srcFile = str_replace(".js", "_uncompressed.js", $realJsFile);
 			if (!file_exists($srcFile)) {
-				trigger_error("The xajax uncompressed Javascript file could not be found in the <b>" . dirname($realJsFile) . "</b> folder. Error ", E_USER_ERROR);
+				trigger_error("The xajax uncompressed Javascript file could not be found in the <b>".dirname($realJsFile)."</b> folder. Error ", E_USER_ERROR);
 			}
 			require(dirname(__FILE__)."/xajaxCompress.php");
 			$javaScript = implode('', file($srcFile));
 			$compressedScript = xajaxCompressJavascript($javaScript);
 			$fH = @fopen($realJsFile, "w");
 			if (!$fH) {
-				trigger_error("The xajax compressed javascript file could not be written in the <b>" . dirname($realJsFile) . "</b> folder. Error ", E_USER_ERROR);
+				trigger_error("The xajax compressed javascript file could not be written in the <b>".dirname($realJsFile)."</b> folder. Error ", E_USER_ERROR);
 			}
 			else {
 				fwrite($fH, $compressedScript);
@@ -918,23 +918,23 @@ 
 		// Build the URL: Start with scheme, user and pass
 		$sURL = $aURL['scheme'].'://';
 		if (!empty($aURL['user'])) {
-			$sURL.= $aURL['user'];
+			$sURL .= $aURL['user'];
 			if (!empty($aURL['pass'])) {
-				$sURL.= ':'.$aURL['pass'];
+				$sURL .= ':'.$aURL['pass'];
 			}
-			$sURL.= '@';
+			$sURL .= '@';
 		}
 
 		// Add the host
-		$sURL.= $aURL['host'];
+		$sURL .= $aURL['host'];
 
 		// Add the port if needed
 		if (!empty($aURL['port']) && (($aURL['scheme'] == 'http' && $aURL['port'] != 80) || ($aURL['scheme'] == 'https' && $aURL['port'] != 443))) {
-			$sURL.= ':'.$aURL['port'];
+			$sURL .= ':'.$aURL['port'];
 		}
 
 		// Add the path and the query string
-		$sURL.= $aURL['path'].@$aURL['query'];
+		$sURL .= $aURL['path'].@$aURL['query'];
 
 		// Clean up
 		unset($aURL);
@@ -1006,7 +1006,7 @@ 
 	 * @access private
 	 * @return string
 	 */
-	function _wrap($sFunction,$sRequestType=XAJAX_POST)
+	function _wrap($sFunction, $sRequestType = XAJAX_POST)
 	{
 		$js = "function ".$this->sWrapperPrefix."$sFunction(){return xajax.call(\"$sFunction\", arguments, ".$sRequestType.");}\n";
 		return $js;
@@ -1025,18 +1025,18 @@ 
 	function _xmlToArray($rootTag, $sXml)
 	{
 		$aArray = array();
-		$sXml = str_replace("<$rootTag>","<$rootTag>|~|",$sXml);
-		$sXml = str_replace("</$rootTag>","</$rootTag>|~|",$sXml);
-		$sXml = str_replace("<e>","<e>|~|",$sXml);
-		$sXml = str_replace("</e>","</e>|~|",$sXml);
-		$sXml = str_replace("<k>","<k>|~|",$sXml);
-		$sXml = str_replace("</k>","|~|</k>|~|",$sXml);
-		$sXml = str_replace("<v>","<v>|~|",$sXml);
-		$sXml = str_replace("</v>","|~|</v>|~|",$sXml);
-		$sXml = str_replace("<q>","<q>|~|",$sXml);
-		$sXml = str_replace("</q>","|~|</q>|~|",$sXml);
-
-		$this->aObjArray = explode("|~|",$sXml);
+		$sXml = str_replace("<$rootTag>", "<$rootTag>|~|", $sXml);
+		$sXml = str_replace("</$rootTag>", "</$rootTag>|~|", $sXml);
+		$sXml = str_replace("<e>", "<e>|~|", $sXml);
+		$sXml = str_replace("</e>", "</e>|~|", $sXml);
+		$sXml = str_replace("<k>", "<k>|~|", $sXml);
+		$sXml = str_replace("</k>", "|~|</k>|~|", $sXml);
+		$sXml = str_replace("<v>", "<v>|~|", $sXml);
+		$sXml = str_replace("</v>", "|~|</v>|~|", $sXml);
+		$sXml = str_replace("<q>", "<q>|~|", $sXml);
+		$sXml = str_replace("</q>", "|~|</q>|~|", $sXml);
+
+		$this->aObjArray = explode("|~|", $sXml);
 
 		$this->iPos = 0;
 		$aArray = $this->_parseObjXml($rootTag);
@@ -1058,32 +1058,32 @@ 
 
 		if ($rootTag == "xjxobj")
 		{
-			while(!stristr($this->aObjArray[$this->iPos],"</xjxobj>"))
+			while (!stristr($this->aObjArray[$this->iPos], "</xjxobj>"))
 			{
 				$this->iPos++;
-				if(stristr($this->aObjArray[$this->iPos],"<e>"))
+				if (stristr($this->aObjArray[$this->iPos], "<e>"))
 				{
 					$key = "";
 					$value = null;
 
 					$this->iPos++;
-					while(!stristr($this->aObjArray[$this->iPos],"</e>"))
+					while (!stristr($this->aObjArray[$this->iPos], "</e>"))
 					{
-						if(stristr($this->aObjArray[$this->iPos],"<k>"))
+						if (stristr($this->aObjArray[$this->iPos], "<k>"))
 						{
 							$this->iPos++;
-							while(!stristr($this->aObjArray[$this->iPos],"</k>"))
+							while (!stristr($this->aObjArray[$this->iPos], "</k>"))
 							{
 								$key .= $this->aObjArray[$this->iPos];
 								$this->iPos++;
 							}
 						}
-						if(stristr($this->aObjArray[$this->iPos],"<v>"))
+						if (stristr($this->aObjArray[$this->iPos], "<v>"))
 						{
 							$this->iPos++;
-							while(!stristr($this->aObjArray[$this->iPos],"</v>"))
+							while (!stristr($this->aObjArray[$this->iPos], "</v>"))
 							{
-								if(stristr($this->aObjArray[$this->iPos],"<xjxobj>"))
+								if (stristr($this->aObjArray[$this->iPos], "<xjxobj>"))
 								{
 									$value = $this->_parseObjXml("xjxobj");
 									$this->iPos++;
@@ -1102,7 +1102,7 @@ 
 						$this->iPos++;
 					}
 
-					$aArray[$key]=$value;
+					$aArray[$key] = $value;
 				}
 			}
 		}
@@ -1111,21 +1111,21 @@ 
 		{
 			$sQuery = "";
 			$this->iPos++;
-			while(!stristr($this->aObjArray[$this->iPos],"</xjxquery>"))
+			while (!stristr($this->aObjArray[$this->iPos], "</xjxquery>"))
 			{
-				if (stristr($this->aObjArray[$this->iPos],"<q>") || stristr($this->aObjArray[$this->iPos],"</q>"))
+				if (stristr($this->aObjArray[$this->iPos], "<q>") || stristr($this->aObjArray[$this->iPos], "</q>"))
 				{
 					$this->iPos++;
 					continue;
 				}
-				$sQuery	.= $this->aObjArray[$this->iPos];
+				$sQuery .= $this->aObjArray[$this->iPos];
 				$this->iPos++;
 			}
 
 			parse_str($sQuery, $aArray);
 			if ($this->bDecodeUTF8Input)
 			{
-				foreach($aArray as $key => $value)
+				foreach ($aArray as $key => $value)
 				{
 					$aArray[$key] = $this->_decodeUTF8Data($value);
 				}

Indentation +1165 added lines, -1165 removed lines

@@ -47,7 +47,7 @@ 
  */
 if (!defined ('XAJAX_DEFAULT_CHAR_ENCODING'))
 {
-	define ('XAJAX_DEFAULT_CHAR_ENCODING', 'utf-8' );
+    define ('XAJAX_DEFAULT_CHAR_ENCODING', 'utf-8' );
 }
 
 /**
@@ -55,11 +55,11 @@ 
  */
 if (!defined ('XAJAX_GET'))
 {
-	define ('XAJAX_GET', 0);
+    define ('XAJAX_GET', 0);
 }
 if (!defined ('XAJAX_POST'))
 {
-	define ('XAJAX_POST', 1);
+    define ('XAJAX_POST', 1);
 }
 
 /**
@@ -72,1145 +72,1145 @@ 
  */
 class xajax
 {
-	/**#@+
+    /**#@+
 	 * @access protected
 	 */
-	/**
-	 * @var array Array of PHP functions that will be callable through javascript wrappers
-	 */
-	var $aFunctions;
-	/**
-	 * @var array Array of object callbacks that will allow Javascript to call PHP methods (key=function name)
-	 */
-	var $aObjects;
-	/**
-	 * @var array Array of RequestTypes to be used with each function (key=function name)
-	 */
-	var $aFunctionRequestTypes;
-	/**
-	 * @var array Array of Include Files for any external functions (key=function name)
-	 */
-	var $aFunctionIncludeFiles;
-	/**
-	 * @var string Name of the PHP function to call if no callable function was found
-	 */
-	var $sCatchAllFunction;
-	/**
-	 * @var string Name of the PHP function to call before any other function
-	 */
-	var $sPreFunction;
-	/**
-	 * @var string The URI for making requests to the xajax object
-	 */
-	var $sRequestURI;
-	/**
-	 * @var string The prefix to prepend to the javascript wraper function name
-	 */
-	var $sWrapperPrefix;
-	/**
-	 * @var boolean Show debug messages (default false)
-	 */
-	var $bDebug;
-	/**
-	 * @var boolean Show messages in the client browser's status bar (default false)
-	 */
-	var $bStatusMessages;
-	/**
-	 * @var boolean Allow xajax to exit after processing a request (default true)
-	 */
-	var $bExitAllowed;
-	/**
-	 * @var boolean Use wait cursor in browser (default true)
-	 */
-	var $bWaitCursor;
-	/**
-	 * @var boolean Use an special xajax error handler so the errors are sent to the browser properly (default false)
-	 */
-	var $bErrorHandler;
-	/**
-	 * @var string Specify what, if any, file xajax should log errors to (and more information in a future release)
-	 */
-	var $sLogFile;
-	/**
-	 * @var boolean Clean all output buffers before outputting response (default false)
-	 */
-	var $bCleanBuffer;
-	/**
-	 * @var string String containing the character encoding used
-	 */
-	var $sEncoding;
-	/**
-	 * @var boolean Decode input request args from UTF-8 (default false)
-	 */
-	var $bDecodeUTF8Input;
-	/**
-	 * @var boolean Convert special characters to HTML entities (default false)
-	 */
-	var $bOutputEntities;
-	/**
-	 * @var array Array for parsing complex objects
-	 */
-	var $aObjArray;
-	/**
-	 * @var integer Position in $aObjArray
-	 */
-	var $iPos;
-
-	/**#@-*/
-
-	/**
-	 * Constructor. You can set some extra xajax options right away or use
-	 * individual methods later to set options.
-	 *
-	 * @param string  defaults to the current browser URI
-	 * @param string  defaults to "xajax_";
-	 * @param string  defaults to XAJAX_DEFAULT_CHAR_ENCODING defined above
-	 * @param boolean defaults to false
-	 */
-	public function __construct($sRequestURI="",$sWrapperPrefix="xajax_",$sEncoding=XAJAX_DEFAULT_CHAR_ENCODING,$bDebug=false)
-	{
-		$this->aFunctions = array();
-		$this->aObjects = array();
-		$this->aFunctionIncludeFiles = array();
-		$this->sRequestURI = $sRequestURI;
-		if ($this->sRequestURI == "")
-			$this->sRequestURI = $this->_detectURI();
-		$this->sWrapperPrefix = $sWrapperPrefix;
-		$this->bDebug = $bDebug;
-		$this->bStatusMessages = false;
-		$this->bWaitCursor = true;
-		$this->bExitAllowed = true;
-		$this->bErrorHandler = false;
-		$this->sLogFile = "";
-		$this->bCleanBuffer = false;
-		$this->setCharEncoding($sEncoding);
-		$this->bDecodeUTF8Input = false;
-		$this->bOutputEntities = false;
-	}
-
-	/**
-	 * Sets the URI to which requests will be made.
-	 * <i>Usage:</i> <kbd>$xajax->setRequestURI("http://www.xajaxproject.org");</kbd>
-	 *
-	 * @param string the URI (can be absolute or relative) of the PHP script
-	 *               that will be accessed when an xajax request occurs
-	 */
-	function setRequestURI($sRequestURI)
-	{
-		$this->sRequestURI = $sRequestURI;
-	}
-
-	/**
-	 * Sets the prefix that will be appended to the Javascript wrapper
-	 * functions (default is "xajax_").
-	 *
-	 * @param string
-	 */
-	//
-	function setWrapperPrefix($sPrefix)
-	{
-		$this->sWrapperPrefix = $sPrefix;
-	}
-
-	/**
-	 * Enables debug messages for xajax.
-	 * */
-	function debugOn()
-	{
-		$this->bDebug = true;
-	}
-
-	/**
-	 * Disables debug messages for xajax (default behavior).
-	 */
-	function debugOff()
-	{
-		$this->bDebug = false;
-	}
-
-	/**
-	 * Enables messages in the browser's status bar for xajax.
-	 */
-	function statusMessagesOn()
-	{
-		$this->bStatusMessages = true;
-	}
-
-	/**
-	 * Disables messages in the browser's status bar for xajax (default behavior).
-	 */
-	function statusMessagesOff()
-	{
-		$this->bStatusMessages = false;
-	}
-
-	/**
-	 * Enables the wait cursor to be displayed in the browser (default behavior).
-	 */
-	function waitCursorOn()
-	{
-		$this->bWaitCursor = true;
-	}
-
-	/**
-	 * Disables the wait cursor to be displayed in the browser.
-	 */
-	function waitCursorOff()
-	{
-		$this->bWaitCursor = false;
-	}
-
-	/**
-	 * Enables xajax to exit immediately after processing a request and
-	 * sending the response back to the browser (default behavior).
-	 */
-	function exitAllowedOn()
-	{
-		$this->bExitAllowed = true;
-	}
-
-	/**
-	 * Disables xajax's default behavior of exiting immediately after
-	 * processing a request and sending the response back to the browser.
-	 */
-	function exitAllowedOff()
-	{
-		$this->bExitAllowed = false;
-	}
-
-	/**
-	 * Turns on xajax's error handling system so that PHP errors that occur
-	 * during a request are trapped and pushed to the browser in the form of
-	 * a Javascript alert.
-	 */
-	function errorHandlerOn()
-	{
-		$this->bErrorHandler = true;
-	}
-
-	/**
-	 * Turns off xajax's error handling system (default behavior).
-	 */
-	function errorHandlerOff()
-	{
-		$this->bErrorHandler = false;
-	}
-
-	/**
-	 * Specifies a log file that will be written to by xajax during a request
-	 * (used only by the error handling system at present). If you don't invoke
-	 * this method, or you pass in "", then no log file will be written to.
-	 * <i>Usage:</i> <kbd>$xajax->setLogFile("/xajax_logs/errors.log");</kbd>
-	 */
-	function setLogFile($sFilename)
-	{
-		$this->sLogFile = $sFilename;
-	}
-
-	/**
-	 * Causes xajax to clean out all output buffers before outputting a
-	 * response (default behavior).
-	 */
-	function cleanBufferOn()
-	{
-		$this->bCleanBuffer = true;
-	}
-	/**
-	 * Turns off xajax's output buffer cleaning.
-	 */
-	function cleanBufferOff()
-	{
-		$this->bCleanBuffer = false;
-	}
-
-	/**
-	 * Sets the character encoding for the HTTP output based on
-	 * <kbd>$sEncoding</kbd>, which is a string containing the character
-	 * encoding to use. You don't need to use this method normally, since the
-	 * character encoding for the response gets set automatically based on the
-	 * <kbd>XAJAX_DEFAULT_CHAR_ENCODING</kbd> constant.
-	 * <i>Usage:</i> <kbd>$xajax->setCharEncoding("utf-8");</kbd>
-	 *
-	 * @param string the encoding type to use (utf-8, iso-8859-1, etc.)
-	 */
-	function setCharEncoding($sEncoding)
-	{
-		$this->sEncoding = $sEncoding;
-	}
-
-	/**
-	 * Causes xajax to decode the input request args from UTF-8 to the current
-	 * encoding if possible. Either the iconv or mb_string extension must be
-	 * present for optimal functionality.
-	 */
-	function decodeUTF8InputOn()
-	{
-		$this->bDecodeUTF8Input = true;
-	}
-
-	/**
-	 * Turns off decoding the input request args from UTF-8 (default behavior).
-	 */
-	function decodeUTF8InputOff()
-	{
-		$this->bDecodeUTF8Input = false;
-	}
-
-	/**
-	 * Tells the response object to convert special characters to HTML entities
-	 * automatically (only works if the mb_string extension is available).
-	 */
-	function outputEntitiesOn()
-	{
-		$this->bOutputEntities = true;
-	}
-
-	/**
-	 * Tells the response object to output special characters intact. (default
-	 * behavior).
-	 */
-	function outputEntitiesOff()
-	{
-		$this->bOutputEntities = false;
-	}
-
-	/**
-	 * Registers a PHP function or method to be callable through xajax in your
-	 * Javascript. If you want to register a function, pass in the name of that
-	 * function. If you want to register a static class method, pass in an
-	 * array like so:
-	 * <kbd>array("myFunctionName", "myClass", "myMethod")</kbd>
-	 * For an object instance method, use an object variable for the second
-	 * array element (and in PHP 4 make sure you put an & before the variable
-	 * to pass the object by reference). Note: the function name is what you
-	 * call via Javascript, so it can be anything as long as it doesn't
-	 * conflict with any other registered function name.
-	 *
-	 * <i>Usage:</i> <kbd>$xajax->registerFunction("myFunction");</kbd>
-	 * or: <kbd>$xajax->registerFunction(array("myFunctionName", &$myObject, "myMethod"));</kbd>
-	 *
-	 * @param mixed  contains the function name or an object callback array
-	 * @param mixed  request type (XAJAX_GET/XAJAX_POST) that should be used
-	 *               for this function.  Defaults to XAJAX_POST.
-	 */
-	function registerFunction($mFunction,$sRequestType=XAJAX_POST)
-	{
-		if (is_array($mFunction)) {
-			$this->aFunctions[$mFunction[0]] = 1;
-			$this->aFunctionRequestTypes[$mFunction[0]] = $sRequestType;
-			$this->aObjects[$mFunction[0]] = array_slice($mFunction, 1);
-		}
-		else {
-			$this->aFunctions[$mFunction] = 1;
-			$this->aFunctionRequestTypes[$mFunction] = $sRequestType;
-		}
-	}
-
-	/**
-	 * Registers a PHP function to be callable through xajax which is located
-	 * in some other file.  If the function is requested the external file will
-	 * be included to define the function before the function is called.
-	 *
-	 * <i>Usage:</i> <kbd>$xajax->registerExternalFunction("myFunction","myFunction.inc.php",XAJAX_POST);</kbd>
-	 *
-	 * @param string contains the function name or an object callback array
-	 *               ({@link xajax::registerFunction() see registerFunction} for
-	 *               more info on object callback arrays)
-	 * @param string contains the path and filename of the include file
-	 * @param mixed  the RequestType (XAJAX_GET/XAJAX_POST) that should be used
-	 *		          for this function. Defaults to XAJAX_POST.
-	 */
-	function registerExternalFunction($mFunction,$sIncludeFile,$sRequestType=XAJAX_POST)
-	{
-		$this->registerFunction($mFunction, $sRequestType);
-
-		if (is_array($mFunction)) {
-			$this->aFunctionIncludeFiles[$mFunction[0]] = $sIncludeFile;
-		}
-		else {
-			$this->aFunctionIncludeFiles[$mFunction] = $sIncludeFile;
-		}
-	}
-
-	/**
-	 * Registers a PHP function to be called when xajax cannot find the
-	 * function being called via Javascript. Because this is technically
-	 * impossible when using "wrapped" functions, the catch-all feature is
-	 * only useful when you're directly using the xajax.call() Javascript
-	 * method. Use the catch-all feature when you want more dynamic ability to
-	 * intercept unknown calls and handle them in a custom way.
-	 *
-	 * <i>Usage:</i> <kbd>$xajax->registerCatchAllFunction("myCatchAllFunction");</kbd>
-	 *
-	 * @param string contains the function name or an object callback array
-	 *               ({@link xajax::registerFunction() see registerFunction} for
-	 *               more info on object callback arrays)
-	 */
-	function registerCatchAllFunction($mFunction)
-	{
-		if (is_array($mFunction)) {
-			$this->sCatchAllFunction = $mFunction[0];
-			$this->aObjects[$mFunction[0]] = array_slice($mFunction, 1);
-		}
-		else {
-			$this->sCatchAllFunction = $mFunction;
-		}
-	}
-
-	/**
-	 * Registers a PHP function to be called before xajax calls the requested
-	 * function. xajax will automatically add the request function's response
-	 * to the pre-function's response to create a single response. Another
-	 * feature is the ability to return not just a response, but an array with
-	 * the first element being false (a boolean) and the second being the
-	 * response. In this case, the pre-function's response will be returned to
-	 * the browser without xajax calling the requested function.
-	 *
-	 * <i>Usage:</i> <kbd>$xajax->registerPreFunction("myPreFunction");</kbd>
-	 *
-	 * @param string contains the function name or an object callback array
-	 *               ({@link xajax::registerFunction() see registerFunction} for
-	 *               more info on object callback arrays)
-	 */
-	function registerPreFunction($mFunction)
-	{
-		if (is_array($mFunction)) {
-			$this->sPreFunction = $mFunction[0];
-			$this->aObjects[$mFunction[0]] = array_slice($mFunction, 1);
-		}
-		else {
-			$this->sPreFunction = $mFunction;
-		}
-	}
-
-	/**
-	 * Returns true if xajax can process the request, false if otherwise.
-	 * You can use this to determine if xajax needs to process the request or
-	 * not.
-	 *
-	 * @return boolean
-	 */
-	function canProcessRequests()
-	{
-		if ($this->getRequestMode() != -1) return true;
-		return false;
-	}
-
-	/**
-	 * Returns the current request mode (XAJAX_GET or XAJAX_POST), or -1 if
-	 * there is none.
-	 *
-	 * @return mixed
-	 */
-	function getRequestMode()
-	{
-		if (!empty($_GET["xajax"]))
-			return XAJAX_GET;
-
-		if (!empty($_POST["xajax"]))
-			return XAJAX_POST;
-
-		return -1;
-	}
-
-	/**
-	 * This is the main communications engine of xajax. The engine handles all
-	 * incoming xajax requests, calls the apporiate PHP functions (or
-	 * class/object methods) and passes the XML responses back to the
-	 * Javascript response handler. If your RequestURI is the same as your Web
-	 * page then this function should be called before any headers or HTML has
-	 * been sent.
-	 */
-	function processRequests()
-	{
-
-		$requestMode = -1;
-		$sFunctionName = "";
-		$bFoundFunction = true;
-		$bFunctionIsCatchAll = false;
-		$sFunctionNameForSpecial = "";
-		$aArgs = array();
-		$sPreResponse = "";
-		$bEndRequest = false;
-		$sResponse = "";
-
-		$requestMode = $this->getRequestMode();
-		if ($requestMode == -1) return;
-
-		if ($requestMode == XAJAX_POST)
-		{
-			$sFunctionName = $_POST["xajax"];
-
-			if (!empty($_POST["xajaxargs"]))
-				$aArgs = $_POST["xajaxargs"];
-		}
-		else
-		{
-			header ("Expires: Mon, 26 Jul 1997 05:00:00 GMT");
-			header ("Last-Modified: " . gmdate("D, d M Y H:i:s") . " GMT");
-			header ("Cache-Control: no-cache, must-revalidate");
-			header ("Pragma: no-cache");
-
-			$sFunctionName = $_GET["xajax"];
-
-			if (!empty($_GET["xajaxargs"]))
-				$aArgs = $_GET["xajaxargs"];
-		}
-
-		// Use xajax error handler if necessary
-		if ($this->bErrorHandler) {
-			$GLOBALS['xajaxErrorHandlerText'] = "";
-			set_error_handler("xajaxErrorHandler");
-		}
-
-		if ($this->sPreFunction) {
-			if (!$this->_isFunctionCallable($this->sPreFunction)) {
-				$bFoundFunction = false;
-				$objResponse = new xajaxResponse();
-				$objResponse->addAlert("Unknown Pre-Function ". $this->sPreFunction);
-				$sResponse = $objResponse->getXML();
-			}
-		}
-		//include any external dependencies associated with this function name
-		if (array_key_exists($sFunctionName,$this->aFunctionIncludeFiles))
-		{
-			ob_start();
-			include_once($this->aFunctionIncludeFiles[$sFunctionName]);
-			ob_end_clean();
-		}
-
-		if ($bFoundFunction) {
-			$sFunctionNameForSpecial = $sFunctionName;
-			if (!array_key_exists($sFunctionName, $this->aFunctions))
-			{
-				if ($this->sCatchAllFunction) {
-					$sFunctionName = $this->sCatchAllFunction;
-					$bFunctionIsCatchAll = true;
-				}
-				else {
-					$bFoundFunction = false;
-					$objResponse = new xajaxResponse();
-					$objResponse->addAlert("Unknown Function $sFunctionName.");
-					$sResponse = $objResponse->getXML();
-				}
-			}
-			else if ($this->aFunctionRequestTypes[$sFunctionName] != $requestMode)
-			{
-				$bFoundFunction = false;
-				$objResponse = new xajaxResponse();
-				$objResponse->addAlert("Incorrect Request Type.");
-				$sResponse = $objResponse->getXML();
-			}
-		}
-
-		if ($bFoundFunction)
-		{
-			for ($i = 0; $i < sizeof($aArgs); $i++)
-			{
-				// If magic quotes is on, then we need to strip the slashes from the args
-				if (get_magic_quotes_gpc() == 1 && is_string($aArgs[$i])) {
-
-					$aArgs[$i] = stripslashes($aArgs[$i]);
-				}
-				if (stristr($aArgs[$i],"<xjxobj>") != false)
-				{
-					$aArgs[$i] = $this->_xmlToArray("xjxobj",$aArgs[$i]);
-				}
-				else if (stristr($aArgs[$i],"<xjxquery>") != false)
-				{
-					$aArgs[$i] = $this->_xmlToArray("xjxquery",$aArgs[$i]);
-				}
-				else if ($this->bDecodeUTF8Input)
-				{
-					$aArgs[$i] = $this->_decodeUTF8Data($aArgs[$i]);
-				}
-			}
-
-			if ($this->sPreFunction) {
-				$mPreResponse = $this->_callFunction($this->sPreFunction, array($sFunctionNameForSpecial, $aArgs));
-				if (is_array($mPreResponse) && $mPreResponse[0] === false) {
-					$bEndRequest = true;
-					$sPreResponse = $mPreResponse[1];
-				}
-				else {
-					$sPreResponse = $mPreResponse;
-				}
-				if (is_a($sPreResponse, "xajaxResponse")) {
-					$sPreResponse = $sPreResponse->getXML();
-				}
-				if ($bEndRequest) $sResponse = $sPreResponse;
-			}
-
-			if (!$bEndRequest) {
-				if (!$this->_isFunctionCallable($sFunctionName)) {
-					$objResponse = new xajaxResponse();
-					$objResponse->addAlert("The Registered Function $sFunctionName Could Not Be Found.");
-					$sResponse = $objResponse->getXML();
-				}
-				else {
-					if ($bFunctionIsCatchAll) {
-						$aArgs = array($sFunctionNameForSpecial, $aArgs);
-					}
-					$sResponse = $this->_callFunction($sFunctionName, $aArgs);
-				}
-				if (is_a($sResponse, "xajaxResponse")) {
-					$sResponse = $sResponse->getXML();
-				}
-				if (!is_string($sResponse) || strpos($sResponse, "<xjx>") === FALSE) {
-					$objResponse = new xajaxResponse();
-					$objResponse->addAlert("No XML Response Was Returned By Function $sFunctionName.");
-					$sResponse = $objResponse->getXML();
-				}
-				else if ($sPreResponse != "") {
-					$sNewResponse = new xajaxResponse($this->sEncoding, $this->bOutputEntities);
-					$sNewResponse->loadXML($sPreResponse);
-					$sNewResponse->loadXML($sResponse);
-					$sResponse = $sNewResponse->getXML();
-				}
-			}
-		}
-
-		$sContentHeader = "Content-type: text/xml;";
-		if ($this->sEncoding && strlen(trim($this->sEncoding)) > 0)
-			$sContentHeader .= " charset=".$this->sEncoding;
-		header($sContentHeader);
-		if ($this->bErrorHandler && !empty( $GLOBALS['xajaxErrorHandlerText'] )) {
-			$sErrorResponse = new xajaxResponse();
-			$sErrorResponse->addAlert("** PHP Error Messages: **" . $GLOBALS['xajaxErrorHandlerText']);
-			if ($this->sLogFile) {
-				$fH = @fopen($this->sLogFile, "a");
-				if (!$fH) {
-					$sErrorResponse->addAlert("** Logging Error **\n\nxajax was unable to write to the error log file:\n" . $this->sLogFile);
-				}
-				else {
-					fwrite($fH, "** xajax Error Log - " . strftime("%b %e %Y %I:%M:%S %p") . " **" . $GLOBALS['xajaxErrorHandlerText'] . "\n\n\n");
-					fclose($fH);
-				}
-			}
-
-			$sErrorResponse->loadXML($sResponse);
-			$sResponse = $sErrorResponse->getXML();
-
-		}
-		if ($this->bCleanBuffer) while (@ob_end_clean());
-		print $sResponse;
-		if ($this->bErrorHandler) restore_error_handler();
-
-		if ($this->bExitAllowed)
-			exit();
-	}
-
-	/**
-	 * Prints the xajax Javascript header and wrapper code into your page by
-	 * printing the output of the getJavascript() method. It should only be
-	 * called between the <pre><head> </head></pre> tags in your HTML page.
-	 * Remember, if you only want to obtain the result of this function, use
-	 * {@link xajax::getJavascript()} instead.
-	 *
-	 * <i>Usage:</i>
-	 * <code>
-	 *  <head>
-	 *		...
-	 *		< ?php $xajax->printJavascript(); ? >
-	 * </code>
-	 *
-	 * @param string the relative address of the folder where xajax has been
-	 *               installed. For instance, if your PHP file is
-	 *               "http://www.myserver.com/myfolder/mypage.php"
-	 *               and xajax was installed in
-	 *               "http://www.myserver.com/anotherfolder", then $sJsURI
-	 *               should be set to "../anotherfolder". Defaults to assuming
-	 *               xajax is in the same folder as your PHP file.
-	 * @param string the relative folder/file pair of the xajax Javascript
-	 *               engine located within the xajax installation folder.
-	 *               Defaults to xajax_js/xajax.js.
-	 */
-	function printJavascript($sJsURI="", $sJsFile=NULL)
-	{
-		print $this->getJavascript($sJsURI, $sJsFile);
-	}
-
-	/**
-	 * Returns the xajax Javascript code that should be added to your HTML page
-	 * between the <kbd><head> </head></kbd> tags.
-	 *
-	 * <i>Usage:</i>
-	 * <code>
-	 *  < ?php $xajaxJSHead = $xajax->getJavascript(); ? >
-	 *	<head>
-	 *		...
-	 *		< ?php echo $xajaxJSHead; ? >
-	 * </code>
-	 *
-	 * @param string the relative address of the folder where xajax has been
-	 *               installed. For instance, if your PHP file is
-	 *               "http://www.myserver.com/myfolder/mypage.php"
-	 *               and xajax was installed in
-	 *               "http://www.myserver.com/anotherfolder", then $sJsURI
-	 *               should be set to "../anotherfolder". Defaults to assuming
-	 *               xajax is in the same folder as your PHP file.
-	 * @param string the relative folder/file pair of the xajax Javascript
-	 *               engine located within the xajax installation folder.
-	 *               Defaults to xajax_js/xajax.js.
-	 * @return string
-	 */
-	function getJavascript($sJsURI="", $sJsFile=NULL)
-	{
-		$html = $this->getJavascriptConfig();
-		$html .= $this->getJavascriptInclude($sJsURI, $sJsFile);
-
-		return $html;
-	}
-
-	/**
-	 * Returns a string containing inline Javascript that sets up the xajax
-	 * runtime (typically called internally by xajax from get/printJavascript).
-	 *
-	 * @return string
-	 */
-	function getJavascriptConfig()
-	{
-		$html  = "\t<script type=\"text/javascript\">\n";
-		$html .= "var xajaxRequestUri=\"".$this->sRequestURI."\";\n";
-		$html .= "var xajaxDebug=".($this->bDebug?"true":"false").";\n";
-		$html .= "var xajaxStatusMessages=".($this->bStatusMessages?"true":"false").";\n";
-		$html .= "var xajaxWaitCursor=".($this->bWaitCursor?"true":"false").";\n";
-		$html .= "var xajaxDefinedGet=".XAJAX_GET.";\n";
-		$html .= "var xajaxDefinedPost=".XAJAX_POST.";\n";
-		$html .= "var xajaxLoaded=false;\n";
-
-		foreach($this->aFunctions as $sFunction => $bExists) {
-			$html .= $this->_wrap($sFunction,$this->aFunctionRequestTypes[$sFunction]);
-		}
-
-		$html .= "\t</script>\n";
-		return $html;
-	}
-
-	/**
-	 * Returns a string containing a Javascript include of the xajax.js file
-	 * along with a check to see if the file loaded after six seconds
-	 * (typically called internally by xajax from get/printJavascript).
-	 *
-	 * @param string the relative address of the folder where xajax has been
-	 *               installed. For instance, if your PHP file is
-	 *               "http://www.myserver.com/myfolder/mypage.php"
-	 *               and xajax was installed in
-	 *               "http://www.myserver.com/anotherfolder", then $sJsURI
-	 *               should be set to "../anotherfolder". Defaults to assuming
-	 *               xajax is in the same folder as your PHP file.
-	 * @param string the relative folder/file pair of the xajax Javascript
-	 *               engine located within the xajax installation folder.
-	 *               Defaults to xajax_js/xajax.js.
-	 * @return string
-	 */
-	function getJavascriptInclude($sJsURI="", $sJsFile=NULL)
-	{
-		if ($sJsFile == NULL) $sJsFile = "xajax_js/xajax.js";
-
-		if ($sJsURI != "" && substr($sJsURI, -1) != "/") $sJsURI .= "/";
-
-		$html = "\t<script type=\"text/javascript\" src=\"" . $sJsURI . $sJsFile . "\"></script>\n";
-		$html .= "\t<script type=\"text/javascript\">\n";
-		$html .= "window.setTimeout(function () { if (!xajaxLoaded) { alert('Error: the xajax Javascript file could not be included. Perhaps the URL is incorrect?\\nURL: {$sJsURI}{$sJsFile}'); } }, 6000);\n";
-		$html .= "\t</script>\n";
-		return $html;
-	}
-
-	/**
-	 * This method can be used to create a new xajax.js file out of the
-	 * xajax_uncompressed.js file (which will only happen if xajax.js doesn't
-	 * already exist on the filesystem).
-	 *
-	 * @param string an optional argument containing the full server file path
-	 *               of xajax.js.
-	 */
-	function autoCompressJavascript($sJsFullFilename=NULL)
-	{
-		$sJsFile = "xajax_js/xajax.js";
-
-		if ($sJsFullFilename) {
-			$realJsFile = $sJsFullFilename;
-		}
-		else {
-			$realPath = realpath(dirname(__FILE__));
-			$realJsFile = $realPath . "/". $sJsFile;
-		}
-
-		// Create a compressed file if necessary
-		if (!file_exists($realJsFile)) {
-			$srcFile = str_replace(".js", "_uncompressed.js", $realJsFile);
-			if (!file_exists($srcFile)) {
-				trigger_error("The xajax uncompressed Javascript file could not be found in the <b>" . dirname($realJsFile) . "</b> folder. Error ", E_USER_ERROR);
-			}
-			require(dirname(__FILE__)."/xajaxCompress.php");
-			$javaScript = implode('', file($srcFile));
-			$compressedScript = xajaxCompressJavascript($javaScript);
-			$fH = @fopen($realJsFile, "w");
-			if (!$fH) {
-				trigger_error("The xajax compressed javascript file could not be written in the <b>" . dirname($realJsFile) . "</b> folder. Error ", E_USER_ERROR);
-			}
-			else {
-				fwrite($fH, $compressedScript);
-				fclose($fH);
-			}
-		}
-	}
-
-	/**
-	 * Returns the current URL based upon the SERVER vars.
-	 *
-	 * @access private
-	 * @return string
-	 */
-	function _detectURI() {
-		$aURL = array();
-
-		// Try to get the request URL
-		if (!empty($_SERVER['REQUEST_URI'])) {
-			$aURL = parse_url($_SERVER['REQUEST_URI']);
-		}
-
-		// Fill in the empty values
-		if (empty($aURL['scheme'])) {
-			if (!empty($_SERVER['HTTP_SCHEME'])) {
-				$aURL['scheme'] = $_SERVER['HTTP_SCHEME'];
-			} else {
-				$aURL['scheme'] = (!empty($_SERVER['HTTPS']) && strtolower($_SERVER['HTTPS']) != 'off') ? 'https' : 'http';
-			}
-		}
-
-		if (empty($aURL['host'])) {
-			if (!empty($_SERVER['HTTP_HOST'])) {
-				if (strpos($_SERVER['HTTP_HOST'], ':') > 0) {
-					list($aURL['host'], $aURL['port']) = explode(':', $_SERVER['HTTP_HOST']);
-				} else {
-					$aURL['host'] = $_SERVER['HTTP_HOST'];
-				}
-			} else if (!empty($_SERVER['SERVER_NAME'])) {
-				$aURL['host'] = $_SERVER['SERVER_NAME'];
-			} else {
-				print "xajax Error: xajax failed to automatically identify your Request URI.";
-				print "Please set the Request URI explicitly when you instantiate the xajax object.";
-				exit();
-			}
-		}
-
-		if (empty($aURL['port']) && !empty($_SERVER['SERVER_PORT'])) {
-			$aURL['port'] = $_SERVER['SERVER_PORT'];
-		}
-
-		if (empty($aURL['path'])) {
-			if (!empty($_SERVER['PATH_INFO'])) {
-				$sPath = parse_url($_SERVER['PATH_INFO']);
-			} else {
-				$sPath = parse_url(api_get_self());
-			}
-			$aURL['path'] = $sPath['path'];
-			unset($sPath);
-		}
-
-		if (!empty($aURL['query'])) {
-			$aURL['query'] = '?'.$aURL['query'];
-		}
-
-		// Build the URL: Start with scheme, user and pass
-		$sURL = $aURL['scheme'].'://';
-		if (!empty($aURL['user'])) {
-			$sURL.= $aURL['user'];
-			if (!empty($aURL['pass'])) {
-				$sURL.= ':'.$aURL['pass'];
-			}
-			$sURL.= '@';
-		}
-
-		// Add the host
-		$sURL.= $aURL['host'];
-
-		// Add the port if needed
-		if (!empty($aURL['port']) && (($aURL['scheme'] == 'http' && $aURL['port'] != 80) || ($aURL['scheme'] == 'https' && $aURL['port'] != 443))) {
-			$sURL.= ':'.$aURL['port'];
-		}
-
-		// Add the path and the query string
-		$sURL.= $aURL['path'].@$aURL['query'];
-
-		// Clean up
-		unset($aURL);
-		return $sURL;
-	}
-
-	/**
-	 * Returns true if the function name is associated with an object callback,
-	 * false if not.
-	 *
-	 * @param string the name of the function
-	 * @access private
-	 * @return boolean
-	 */
-	function _isObjectCallback($sFunction)
-	{
-		if (array_key_exists($sFunction, $this->aObjects)) return true;
-		return false;
-	}
-
-	/**
-	 * Returns true if the function or object callback can be called, false if
-	 * not.
-	 *
-	 * @param string the name of the function
-	 * @access private
-	 * @return boolean
-	 */
-	function _isFunctionCallable($sFunction)
-	{
-		if ($this->_isObjectCallback($sFunction)) {
-			if (is_object($this->aObjects[$sFunction][0])) {
-				return method_exists($this->aObjects[$sFunction][0], $this->aObjects[$sFunction][1]);
-			}
-			else {
-				return is_callable($this->aObjects[$sFunction]);
-			}
-		}
-		else {
-			return function_exists($sFunction);
-		}
-	}
-
-	/**
-	 * Calls the function, class method, or object method with the supplied
-	 * arguments.
-	 *
-	 * @param string the name of the function
-	 * @param array  arguments to pass to the function
-	 * @access private
-	 * @return mixed the output of the called function or method
-	 */
-	function _callFunction($sFunction, $aArgs)
-	{
-		if ($this->_isObjectCallback($sFunction)) {
-			$mReturn = call_user_func_array($this->aObjects[$sFunction], $aArgs);
-		}
-		else {
-			$mReturn = call_user_func_array($sFunction, $aArgs);
-		}
-		return $mReturn;
-	}
-
-	/**
-	 * Generates the Javascript wrapper for the specified PHP function.
-	 *
-	 * @param string the name of the function
-	 * @param mixed  the request type
-	 * @access private
-	 * @return string
-	 */
-	function _wrap($sFunction,$sRequestType=XAJAX_POST)
-	{
-		$js = "function ".$this->sWrapperPrefix."$sFunction(){return xajax.call(\"$sFunction\", arguments, ".$sRequestType.");}\n";
-		return $js;
-	}
-
-	/**
-	 * Takes a string containing xajax xjxobj XML or xjxquery XML and builds an
-	 * array representation of it to pass as an argument to the PHP function
-	 * being called.
-	 *
-	 * @param string the root tag of the XML
-	 * @param string XML to convert
-	 * @access private
-	 * @return array
-	 */
-	function _xmlToArray($rootTag, $sXml)
-	{
-		$aArray = array();
-		$sXml = str_replace("<$rootTag>","<$rootTag>|~|",$sXml);
-		$sXml = str_replace("</$rootTag>","</$rootTag>|~|",$sXml);
-		$sXml = str_replace("<e>","<e>|~|",$sXml);
-		$sXml = str_replace("</e>","</e>|~|",$sXml);
-		$sXml = str_replace("<k>","<k>|~|",$sXml);
-		$sXml = str_replace("</k>","|~|</k>|~|",$sXml);
-		$sXml = str_replace("<v>","<v>|~|",$sXml);
-		$sXml = str_replace("</v>","|~|</v>|~|",$sXml);
-		$sXml = str_replace("<q>","<q>|~|",$sXml);
-		$sXml = str_replace("</q>","|~|</q>|~|",$sXml);
-
-		$this->aObjArray = explode("|~|",$sXml);
-
-		$this->iPos = 0;
-		$aArray = $this->_parseObjXml($rootTag);
-
-		return $aArray;
-	}
-
-	/**
-	 * A recursive function that generates an array from the contents of
-	 * $this->aObjArray.
-	 *
-	 * @param string the root tag of the XML
-	 * @access private
-	 * @return array
-	 */
-	function _parseObjXml($rootTag)
-	{
-		$aArray = array();
-
-		if ($rootTag == "xjxobj")
-		{
-			while(!stristr($this->aObjArray[$this->iPos],"</xjxobj>"))
-			{
-				$this->iPos++;
-				if(stristr($this->aObjArray[$this->iPos],"<e>"))
-				{
-					$key = "";
-					$value = null;
-
-					$this->iPos++;
-					while(!stristr($this->aObjArray[$this->iPos],"</e>"))
-					{
-						if(stristr($this->aObjArray[$this->iPos],"<k>"))
-						{
-							$this->iPos++;
-							while(!stristr($this->aObjArray[$this->iPos],"</k>"))
-							{
-								$key .= $this->aObjArray[$this->iPos];
-								$this->iPos++;
-							}
-						}
-						if(stristr($this->aObjArray[$this->iPos],"<v>"))
-						{
-							$this->iPos++;
-							while(!stristr($this->aObjArray[$this->iPos],"</v>"))
-							{
-								if(stristr($this->aObjArray[$this->iPos],"<xjxobj>"))
-								{
-									$value = $this->_parseObjXml("xjxobj");
-									$this->iPos++;
-								}
-								else
-								{
-									$value .= $this->aObjArray[$this->iPos];
-									if ($this->bDecodeUTF8Input)
-									{
-										$value = $this->_decodeUTF8Data($value);
-									}
-								}
-								$this->iPos++;
-							}
-						}
-						$this->iPos++;
-					}
-
-					$aArray[$key]=$value;
-				}
-			}
-		}
-
-		if ($rootTag == "xjxquery")
-		{
-			$sQuery = "";
-			$this->iPos++;
-			while(!stristr($this->aObjArray[$this->iPos],"</xjxquery>"))
-			{
-				if (stristr($this->aObjArray[$this->iPos],"<q>") || stristr($this->aObjArray[$this->iPos],"</q>"))
-				{
-					$this->iPos++;
-					continue;
-				}
-				$sQuery	.= $this->aObjArray[$this->iPos];
-				$this->iPos++;
-			}
-
-			parse_str($sQuery, $aArray);
-			if ($this->bDecodeUTF8Input)
-			{
-				foreach($aArray as $key => $value)
-				{
-					$aArray[$key] = $this->_decodeUTF8Data($value);
-				}
-			}
-			// If magic quotes is on, then we need to strip the slashes from the
-			// array values because of the parse_str pass which adds slashes
-			if (get_magic_quotes_gpc() == 1) {
-				$newArray = array();
-				foreach ($aArray as $sKey => $sValue) {
-					if (is_string($sValue))
-						$newArray[$sKey] = stripslashes($sValue);
-					else
-						$newArray[$sKey] = $sValue;
-				}
-				$aArray = $newArray;
-			}
-		}
-
-		return $aArray;
-	}
-
-	/**
-	 * Decodes string data from UTF-8 to the current xajax encoding.
-	 *
-	 * @param string data to convert
-	 * @access private
-	 * @return string converted data
-	 */
-	function _decodeUTF8Data($sData)
-	{
-		$sValue = $sData;
-		if ($this->bDecodeUTF8Input)
-		{
-			$sFuncToUse = NULL;
-
-			// An adaptation for the Dokeos LMS, 22-AUG-2009.
-			if (function_exists('api_convert_encoding'))
-			{
-				$sFuncToUse = "api_convert_encoding";
-			}
-			//if (function_exists('iconv'))
-			elseif (function_exists('iconv'))
-			//
-			{
-				$sFuncToUse = "iconv";
-			}
-			else if (function_exists('mb_convert_encoding'))
-			{
-				$sFuncToUse = "mb_convert_encoding";
-			}
-			else if ($this->sEncoding == "ISO-8859-1")
-			{
-				$sFuncToUse = "utf8_decode";
-			}
-			else
-			{
-				trigger_error("The incoming xajax data could not be converted from UTF-8", E_USER_NOTICE);
-			}
-
-			if ($sFuncToUse)
-			{
-				if (is_string($sValue))
-				{
-					if ($sFuncToUse == "iconv")
-					{
-						$sValue = iconv("UTF-8", $this->sEncoding.'//TRANSLIT', $sValue);
-					}
-					else if ($sFuncToUse == "mb_convert_encoding")
-					{
-						$sValue = mb_convert_encoding($sValue, $this->sEncoding, "UTF-8");
-					}
-					// Added code, an adaptation for the Dokeos LMS, 22-AUG-2009.
-					else if ($sFuncToUse == "api_convert_encoding")
-					{
-						$sValue = api_convert_encoding($sValue, $this->sEncoding, "UTF-8");
-					}
-					//
-					else
-					{
-						$sValue = utf8_decode($sValue);
-					}
-				}
-			}
-		}
-		return $sValue;
-	}
+    /**
+     * @var array Array of PHP functions that will be callable through javascript wrappers
+     */
+    var $aFunctions;
+    /**
+     * @var array Array of object callbacks that will allow Javascript to call PHP methods (key=function name)
+     */
+    var $aObjects;
+    /**
+     * @var array Array of RequestTypes to be used with each function (key=function name)
+     */
+    var $aFunctionRequestTypes;
+    /**
+     * @var array Array of Include Files for any external functions (key=function name)
+     */
+    var $aFunctionIncludeFiles;
+    /**
+     * @var string Name of the PHP function to call if no callable function was found
+     */
+    var $sCatchAllFunction;
+    /**
+     * @var string Name of the PHP function to call before any other function
+     */
+    var $sPreFunction;
+    /**
+     * @var string The URI for making requests to the xajax object
+     */
+    var $sRequestURI;
+    /**
+     * @var string The prefix to prepend to the javascript wraper function name
+     */
+    var $sWrapperPrefix;
+    /**
+     * @var boolean Show debug messages (default false)
+     */
+    var $bDebug;
+    /**
+     * @var boolean Show messages in the client browser's status bar (default false)
+     */
+    var $bStatusMessages;
+    /**
+     * @var boolean Allow xajax to exit after processing a request (default true)
+     */
+    var $bExitAllowed;
+    /**
+     * @var boolean Use wait cursor in browser (default true)
+     */
+    var $bWaitCursor;
+    /**
+     * @var boolean Use an special xajax error handler so the errors are sent to the browser properly (default false)
+     */
+    var $bErrorHandler;
+    /**
+     * @var string Specify what, if any, file xajax should log errors to (and more information in a future release)
+     */
+    var $sLogFile;
+    /**
+     * @var boolean Clean all output buffers before outputting response (default false)
+     */
+    var $bCleanBuffer;
+    /**
+     * @var string String containing the character encoding used
+     */
+    var $sEncoding;
+    /**
+     * @var boolean Decode input request args from UTF-8 (default false)
+     */
+    var $bDecodeUTF8Input;
+    /**
+     * @var boolean Convert special characters to HTML entities (default false)
+     */
+    var $bOutputEntities;
+    /**
+     * @var array Array for parsing complex objects
+     */
+    var $aObjArray;
+    /**
+     * @var integer Position in $aObjArray
+     */
+    var $iPos;
+
+    /**#@-*/
+
+    /**
+     * Constructor. You can set some extra xajax options right away or use
+     * individual methods later to set options.
+     *
+     * @param string  defaults to the current browser URI
+     * @param string  defaults to "xajax_";
+     * @param string  defaults to XAJAX_DEFAULT_CHAR_ENCODING defined above
+     * @param boolean defaults to false
+     */
+    public function __construct($sRequestURI="",$sWrapperPrefix="xajax_",$sEncoding=XAJAX_DEFAULT_CHAR_ENCODING,$bDebug=false)
+    {
+        $this->aFunctions = array();
+        $this->aObjects = array();
+        $this->aFunctionIncludeFiles = array();
+        $this->sRequestURI = $sRequestURI;
+        if ($this->sRequestURI == "")
+            $this->sRequestURI = $this->_detectURI();
+        $this->sWrapperPrefix = $sWrapperPrefix;
+        $this->bDebug = $bDebug;
+        $this->bStatusMessages = false;
+        $this->bWaitCursor = true;
+        $this->bExitAllowed = true;
+        $this->bErrorHandler = false;
+        $this->sLogFile = "";
+        $this->bCleanBuffer = false;
+        $this->setCharEncoding($sEncoding);
+        $this->bDecodeUTF8Input = false;
+        $this->bOutputEntities = false;
+    }
+
+    /**
+     * Sets the URI to which requests will be made.
+     * <i>Usage:</i> <kbd>$xajax->setRequestURI("http://www.xajaxproject.org");</kbd>
+     *
+     * @param string the URI (can be absolute or relative) of the PHP script
+     *               that will be accessed when an xajax request occurs
+     */
+    function setRequestURI($sRequestURI)
+    {
+        $this->sRequestURI = $sRequestURI;
+    }
+
+    /**
+     * Sets the prefix that will be appended to the Javascript wrapper
+     * functions (default is "xajax_").
+     *
+     * @param string
+     */
+    //
+    function setWrapperPrefix($sPrefix)
+    {
+        $this->sWrapperPrefix = $sPrefix;
+    }
+
+    /**
+     * Enables debug messages for xajax.
+     * */
+    function debugOn()
+    {
+        $this->bDebug = true;
+    }
+
+    /**
+     * Disables debug messages for xajax (default behavior).
+     */
+    function debugOff()
+    {
+        $this->bDebug = false;
+    }
+
+    /**
+     * Enables messages in the browser's status bar for xajax.
+     */
+    function statusMessagesOn()
+    {
+        $this->bStatusMessages = true;
+    }
+
+    /**
+     * Disables messages in the browser's status bar for xajax (default behavior).
+     */
+    function statusMessagesOff()
+    {
+        $this->bStatusMessages = false;
+    }
+
+    /**
+     * Enables the wait cursor to be displayed in the browser (default behavior).
+     */
+    function waitCursorOn()
+    {
+        $this->bWaitCursor = true;
+    }
+
+    /**
+     * Disables the wait cursor to be displayed in the browser.
+     */
+    function waitCursorOff()
+    {
+        $this->bWaitCursor = false;
+    }
+
+    /**
+     * Enables xajax to exit immediately after processing a request and
+     * sending the response back to the browser (default behavior).
+     */
+    function exitAllowedOn()
+    {
+        $this->bExitAllowed = true;
+    }
+
+    /**
+     * Disables xajax's default behavior of exiting immediately after
+     * processing a request and sending the response back to the browser.
+     */
+    function exitAllowedOff()
+    {
+        $this->bExitAllowed = false;
+    }
+
+    /**
+     * Turns on xajax's error handling system so that PHP errors that occur
+     * during a request are trapped and pushed to the browser in the form of
+     * a Javascript alert.
+     */
+    function errorHandlerOn()
+    {
+        $this->bErrorHandler = true;
+    }
+
+    /**
+     * Turns off xajax's error handling system (default behavior).
+     */
+    function errorHandlerOff()
+    {
+        $this->bErrorHandler = false;
+    }
+
+    /**
+     * Specifies a log file that will be written to by xajax during a request
+     * (used only by the error handling system at present). If you don't invoke
+     * this method, or you pass in "", then no log file will be written to.
+     * <i>Usage:</i> <kbd>$xajax->setLogFile("/xajax_logs/errors.log");</kbd>
+     */
+    function setLogFile($sFilename)
+    {
+        $this->sLogFile = $sFilename;
+    }
+
+    /**
+     * Causes xajax to clean out all output buffers before outputting a
+     * response (default behavior).
+     */
+    function cleanBufferOn()
+    {
+        $this->bCleanBuffer = true;
+    }
+    /**
+     * Turns off xajax's output buffer cleaning.
+     */
+    function cleanBufferOff()
+    {
+        $this->bCleanBuffer = false;
+    }
+
+    /**
+     * Sets the character encoding for the HTTP output based on
+     * <kbd>$sEncoding</kbd>, which is a string containing the character
+     * encoding to use. You don't need to use this method normally, since the
+     * character encoding for the response gets set automatically based on the
+     * <kbd>XAJAX_DEFAULT_CHAR_ENCODING</kbd> constant.
+     * <i>Usage:</i> <kbd>$xajax->setCharEncoding("utf-8");</kbd>
+     *
+     * @param string the encoding type to use (utf-8, iso-8859-1, etc.)
+     */
+    function setCharEncoding($sEncoding)
+    {
+        $this->sEncoding = $sEncoding;
+    }
+
+    /**
+     * Causes xajax to decode the input request args from UTF-8 to the current
+     * encoding if possible. Either the iconv or mb_string extension must be
+     * present for optimal functionality.
+     */
+    function decodeUTF8InputOn()
+    {
+        $this->bDecodeUTF8Input = true;
+    }
+
+    /**
+     * Turns off decoding the input request args from UTF-8 (default behavior).
+     */
+    function decodeUTF8InputOff()
+    {
+        $this->bDecodeUTF8Input = false;
+    }
+
+    /**
+     * Tells the response object to convert special characters to HTML entities
+     * automatically (only works if the mb_string extension is available).
+     */
+    function outputEntitiesOn()
+    {
+        $this->bOutputEntities = true;
+    }
+
+    /**
+     * Tells the response object to output special characters intact. (default
+     * behavior).
+     */
+    function outputEntitiesOff()
+    {
+        $this->bOutputEntities = false;
+    }
+
+    /**
+     * Registers a PHP function or method to be callable through xajax in your
+     * Javascript. If you want to register a function, pass in the name of that
+     * function. If you want to register a static class method, pass in an
+     * array like so:
+     * <kbd>array("myFunctionName", "myClass", "myMethod")</kbd>
+     * For an object instance method, use an object variable for the second
+     * array element (and in PHP 4 make sure you put an & before the variable
+     * to pass the object by reference). Note: the function name is what you
+     * call via Javascript, so it can be anything as long as it doesn't
+     * conflict with any other registered function name.
+     *
+     * <i>Usage:</i> <kbd>$xajax->registerFunction("myFunction");</kbd>
+     * or: <kbd>$xajax->registerFunction(array("myFunctionName", &$myObject, "myMethod"));</kbd>
+     *
+     * @param mixed  contains the function name or an object callback array
+     * @param mixed  request type (XAJAX_GET/XAJAX_POST) that should be used
+     *               for this function.  Defaults to XAJAX_POST.
+     */
+    function registerFunction($mFunction,$sRequestType=XAJAX_POST)
+    {
+        if (is_array($mFunction)) {
+            $this->aFunctions[$mFunction[0]] = 1;
+            $this->aFunctionRequestTypes[$mFunction[0]] = $sRequestType;
+            $this->aObjects[$mFunction[0]] = array_slice($mFunction, 1);
+        }
+        else {
+            $this->aFunctions[$mFunction] = 1;
+            $this->aFunctionRequestTypes[$mFunction] = $sRequestType;
+        }
+    }
+
+    /**
+     * Registers a PHP function to be callable through xajax which is located
+     * in some other file.  If the function is requested the external file will
+     * be included to define the function before the function is called.
+     *
+     * <i>Usage:</i> <kbd>$xajax->registerExternalFunction("myFunction","myFunction.inc.php",XAJAX_POST);</kbd>
+     *
+     * @param string contains the function name or an object callback array
+     *               ({@link xajax::registerFunction() see registerFunction} for
+     *               more info on object callback arrays)
+     * @param string contains the path and filename of the include file
+     * @param mixed  the RequestType (XAJAX_GET/XAJAX_POST) that should be used
+     *		          for this function. Defaults to XAJAX_POST.
+     */
+    function registerExternalFunction($mFunction,$sIncludeFile,$sRequestType=XAJAX_POST)
+    {
+        $this->registerFunction($mFunction, $sRequestType);
+
+        if (is_array($mFunction)) {
+            $this->aFunctionIncludeFiles[$mFunction[0]] = $sIncludeFile;
+        }
+        else {
+            $this->aFunctionIncludeFiles[$mFunction] = $sIncludeFile;
+        }
+    }
+
+    /**
+     * Registers a PHP function to be called when xajax cannot find the
+     * function being called via Javascript. Because this is technically
+     * impossible when using "wrapped" functions, the catch-all feature is
+     * only useful when you're directly using the xajax.call() Javascript
+     * method. Use the catch-all feature when you want more dynamic ability to
+     * intercept unknown calls and handle them in a custom way.
+     *
+     * <i>Usage:</i> <kbd>$xajax->registerCatchAllFunction("myCatchAllFunction");</kbd>
+     *
+     * @param string contains the function name or an object callback array
+     *               ({@link xajax::registerFunction() see registerFunction} for
+     *               more info on object callback arrays)
+     */
+    function registerCatchAllFunction($mFunction)
+    {
+        if (is_array($mFunction)) {
+            $this->sCatchAllFunction = $mFunction[0];
+            $this->aObjects[$mFunction[0]] = array_slice($mFunction, 1);
+        }
+        else {
+            $this->sCatchAllFunction = $mFunction;
+        }
+    }
+
+    /**
+     * Registers a PHP function to be called before xajax calls the requested
+     * function. xajax will automatically add the request function's response
+     * to the pre-function's response to create a single response. Another
+     * feature is the ability to return not just a response, but an array with
+     * the first element being false (a boolean) and the second being the
+     * response. In this case, the pre-function's response will be returned to
+     * the browser without xajax calling the requested function.
+     *
+     * <i>Usage:</i> <kbd>$xajax->registerPreFunction("myPreFunction");</kbd>
+     *
+     * @param string contains the function name or an object callback array
+     *               ({@link xajax::registerFunction() see registerFunction} for
+     *               more info on object callback arrays)
+     */
+    function registerPreFunction($mFunction)
+    {
+        if (is_array($mFunction)) {
+            $this->sPreFunction = $mFunction[0];
+            $this->aObjects[$mFunction[0]] = array_slice($mFunction, 1);
+        }
+        else {
+            $this->sPreFunction = $mFunction;
+        }
+    }
+
+    /**
+     * Returns true if xajax can process the request, false if otherwise.
+     * You can use this to determine if xajax needs to process the request or
+     * not.
+     *
+     * @return boolean
+     */
+    function canProcessRequests()
+    {
+        if ($this->getRequestMode() != -1) return true;
+        return false;
+    }
+
+    /**
+     * Returns the current request mode (XAJAX_GET or XAJAX_POST), or -1 if
+     * there is none.
+     *
+     * @return mixed
+     */
+    function getRequestMode()
+    {
+        if (!empty($_GET["xajax"]))
+            return XAJAX_GET;
+
+        if (!empty($_POST["xajax"]))
+            return XAJAX_POST;
+
+        return -1;
+    }
+
+    /**
+     * This is the main communications engine of xajax. The engine handles all
+     * incoming xajax requests, calls the apporiate PHP functions (or
+     * class/object methods) and passes the XML responses back to the
+     * Javascript response handler. If your RequestURI is the same as your Web
+     * page then this function should be called before any headers or HTML has
+     * been sent.
+     */
+    function processRequests()
+    {
+
+        $requestMode = -1;
+        $sFunctionName = "";
+        $bFoundFunction = true;
+        $bFunctionIsCatchAll = false;
+        $sFunctionNameForSpecial = "";
+        $aArgs = array();
+        $sPreResponse = "";
+        $bEndRequest = false;
+        $sResponse = "";
+
+        $requestMode = $this->getRequestMode();
+        if ($requestMode == -1) return;
+
+        if ($requestMode == XAJAX_POST)
+        {
+            $sFunctionName = $_POST["xajax"];
+
+            if (!empty($_POST["xajaxargs"]))
+                $aArgs = $_POST["xajaxargs"];
+        }
+        else
+        {
+            header ("Expires: Mon, 26 Jul 1997 05:00:00 GMT");
+            header ("Last-Modified: " . gmdate("D, d M Y H:i:s") . " GMT");
+            header ("Cache-Control: no-cache, must-revalidate");
+            header ("Pragma: no-cache");
+
+            $sFunctionName = $_GET["xajax"];
+
+            if (!empty($_GET["xajaxargs"]))
+                $aArgs = $_GET["xajaxargs"];
+        }
+
+        // Use xajax error handler if necessary
+        if ($this->bErrorHandler) {
+            $GLOBALS['xajaxErrorHandlerText'] = "";
+            set_error_handler("xajaxErrorHandler");
+        }
+
+        if ($this->sPreFunction) {
+            if (!$this->_isFunctionCallable($this->sPreFunction)) {
+                $bFoundFunction = false;
+                $objResponse = new xajaxResponse();
+                $objResponse->addAlert("Unknown Pre-Function ". $this->sPreFunction);
+                $sResponse = $objResponse->getXML();
+            }
+        }
+        //include any external dependencies associated with this function name
+        if (array_key_exists($sFunctionName,$this->aFunctionIncludeFiles))
+        {
+            ob_start();
+            include_once($this->aFunctionIncludeFiles[$sFunctionName]);
+            ob_end_clean();
+        }
+
+        if ($bFoundFunction) {
+            $sFunctionNameForSpecial = $sFunctionName;
+            if (!array_key_exists($sFunctionName, $this->aFunctions))
+            {
+                if ($this->sCatchAllFunction) {
+                    $sFunctionName = $this->sCatchAllFunction;
+                    $bFunctionIsCatchAll = true;
+                }
+                else {
+                    $bFoundFunction = false;
+                    $objResponse = new xajaxResponse();
+                    $objResponse->addAlert("Unknown Function $sFunctionName.");
+                    $sResponse = $objResponse->getXML();
+                }
+            }
+            else if ($this->aFunctionRequestTypes[$sFunctionName] != $requestMode)
+            {
+                $bFoundFunction = false;
+                $objResponse = new xajaxResponse();
+                $objResponse->addAlert("Incorrect Request Type.");
+                $sResponse = $objResponse->getXML();
+            }
+        }
+
+        if ($bFoundFunction)
+        {
+            for ($i = 0; $i < sizeof($aArgs); $i++)
+            {
+                // If magic quotes is on, then we need to strip the slashes from the args
+                if (get_magic_quotes_gpc() == 1 && is_string($aArgs[$i])) {
+
+                    $aArgs[$i] = stripslashes($aArgs[$i]);
+                }
+                if (stristr($aArgs[$i],"<xjxobj>") != false)
+                {
+                    $aArgs[$i] = $this->_xmlToArray("xjxobj",$aArgs[$i]);
+                }
+                else if (stristr($aArgs[$i],"<xjxquery>") != false)
+                {
+                    $aArgs[$i] = $this->_xmlToArray("xjxquery",$aArgs[$i]);
+                }
+                else if ($this->bDecodeUTF8Input)
+                {
+                    $aArgs[$i] = $this->_decodeUTF8Data($aArgs[$i]);
+                }
+            }
+
+            if ($this->sPreFunction) {
+                $mPreResponse = $this->_callFunction($this->sPreFunction, array($sFunctionNameForSpecial, $aArgs));
+                if (is_array($mPreResponse) && $mPreResponse[0] === false) {
+                    $bEndRequest = true;
+                    $sPreResponse = $mPreResponse[1];
+                }
+                else {
+                    $sPreResponse = $mPreResponse;
+                }
+                if (is_a($sPreResponse, "xajaxResponse")) {
+                    $sPreResponse = $sPreResponse->getXML();
+                }
+                if ($bEndRequest) $sResponse = $sPreResponse;
+            }
+
+            if (!$bEndRequest) {
+                if (!$this->_isFunctionCallable($sFunctionName)) {
+                    $objResponse = new xajaxResponse();
+                    $objResponse->addAlert("The Registered Function $sFunctionName Could Not Be Found.");
+                    $sResponse = $objResponse->getXML();
+                }
+                else {
+                    if ($bFunctionIsCatchAll) {
+                        $aArgs = array($sFunctionNameForSpecial, $aArgs);
+                    }
+                    $sResponse = $this->_callFunction($sFunctionName, $aArgs);
+                }
+                if (is_a($sResponse, "xajaxResponse")) {
+                    $sResponse = $sResponse->getXML();
+                }
+                if (!is_string($sResponse) || strpos($sResponse, "<xjx>") === FALSE) {
+                    $objResponse = new xajaxResponse();
+                    $objResponse->addAlert("No XML Response Was Returned By Function $sFunctionName.");
+                    $sResponse = $objResponse->getXML();
+                }
+                else if ($sPreResponse != "") {
+                    $sNewResponse = new xajaxResponse($this->sEncoding, $this->bOutputEntities);
+                    $sNewResponse->loadXML($sPreResponse);
+                    $sNewResponse->loadXML($sResponse);
+                    $sResponse = $sNewResponse->getXML();
+                }
+            }
+        }
+
+        $sContentHeader = "Content-type: text/xml;";
+        if ($this->sEncoding && strlen(trim($this->sEncoding)) > 0)
+            $sContentHeader .= " charset=".$this->sEncoding;
+        header($sContentHeader);
+        if ($this->bErrorHandler && !empty( $GLOBALS['xajaxErrorHandlerText'] )) {
+            $sErrorResponse = new xajaxResponse();
+            $sErrorResponse->addAlert("** PHP Error Messages: **" . $GLOBALS['xajaxErrorHandlerText']);
+            if ($this->sLogFile) {
+                $fH = @fopen($this->sLogFile, "a");
+                if (!$fH) {
+                    $sErrorResponse->addAlert("** Logging Error **\n\nxajax was unable to write to the error log file:\n" . $this->sLogFile);
+                }
+                else {
+                    fwrite($fH, "** xajax Error Log - " . strftime("%b %e %Y %I:%M:%S %p") . " **" . $GLOBALS['xajaxErrorHandlerText'] . "\n\n\n");
+                    fclose($fH);
+                }
+            }
+
+            $sErrorResponse->loadXML($sResponse);
+            $sResponse = $sErrorResponse->getXML();
+
+        }
+        if ($this->bCleanBuffer) while (@ob_end_clean());
+        print $sResponse;
+        if ($this->bErrorHandler) restore_error_handler();
+
+        if ($this->bExitAllowed)
+            exit();
+    }
+
+    /**
+     * Prints the xajax Javascript header and wrapper code into your page by
+     * printing the output of the getJavascript() method. It should only be
+     * called between the <pre><head> </head></pre> tags in your HTML page.
+     * Remember, if you only want to obtain the result of this function, use
+     * {@link xajax::getJavascript()} instead.
+     *
+     * <i>Usage:</i>
+     * <code>
+     *  <head>
+     *		...
+     *		< ?php $xajax->printJavascript(); ? >
+     * </code>
+     *
+     * @param string the relative address of the folder where xajax has been
+     *               installed. For instance, if your PHP file is
+     *               "http://www.myserver.com/myfolder/mypage.php"
+     *               and xajax was installed in
+     *               "http://www.myserver.com/anotherfolder", then $sJsURI
+     *               should be set to "../anotherfolder". Defaults to assuming
+     *               xajax is in the same folder as your PHP file.
+     * @param string the relative folder/file pair of the xajax Javascript
+     *               engine located within the xajax installation folder.
+     *               Defaults to xajax_js/xajax.js.
+     */
+    function printJavascript($sJsURI="", $sJsFile=NULL)
+    {
+        print $this->getJavascript($sJsURI, $sJsFile);
+    }
+
+    /**
+     * Returns the xajax Javascript code that should be added to your HTML page
+     * between the <kbd><head> </head></kbd> tags.
+     *
+     * <i>Usage:</i>
+     * <code>
+     *  < ?php $xajaxJSHead = $xajax->getJavascript(); ? >
+     *	<head>
+     *		...
+     *		< ?php echo $xajaxJSHead; ? >
+     * </code>
+     *
+     * @param string the relative address of the folder where xajax has been
+     *               installed. For instance, if your PHP file is
+     *               "http://www.myserver.com/myfolder/mypage.php"
+     *               and xajax was installed in
+     *               "http://www.myserver.com/anotherfolder", then $sJsURI
+     *               should be set to "../anotherfolder". Defaults to assuming
+     *               xajax is in the same folder as your PHP file.
+     * @param string the relative folder/file pair of the xajax Javascript
+     *               engine located within the xajax installation folder.
+     *               Defaults to xajax_js/xajax.js.
+     * @return string
+     */
+    function getJavascript($sJsURI="", $sJsFile=NULL)
+    {
+        $html = $this->getJavascriptConfig();
+        $html .= $this->getJavascriptInclude($sJsURI, $sJsFile);
+
+        return $html;
+    }
+
+    /**
+     * Returns a string containing inline Javascript that sets up the xajax
+     * runtime (typically called internally by xajax from get/printJavascript).
+     *
+     * @return string
+     */
+    function getJavascriptConfig()
+    {
+        $html  = "\t<script type=\"text/javascript\">\n";
+        $html .= "var xajaxRequestUri=\"".$this->sRequestURI."\";\n";
+        $html .= "var xajaxDebug=".($this->bDebug?"true":"false").";\n";
+        $html .= "var xajaxStatusMessages=".($this->bStatusMessages?"true":"false").";\n";
+        $html .= "var xajaxWaitCursor=".($this->bWaitCursor?"true":"false").";\n";
+        $html .= "var xajaxDefinedGet=".XAJAX_GET.";\n";
+        $html .= "var xajaxDefinedPost=".XAJAX_POST.";\n";
+        $html .= "var xajaxLoaded=false;\n";
+
+        foreach($this->aFunctions as $sFunction => $bExists) {
+            $html .= $this->_wrap($sFunction,$this->aFunctionRequestTypes[$sFunction]);
+        }
+
+        $html .= "\t</script>\n";
+        return $html;
+    }
+
+    /**
+     * Returns a string containing a Javascript include of the xajax.js file
+     * along with a check to see if the file loaded after six seconds
+     * (typically called internally by xajax from get/printJavascript).
+     *
+     * @param string the relative address of the folder where xajax has been
+     *               installed. For instance, if your PHP file is
+     *               "http://www.myserver.com/myfolder/mypage.php"
+     *               and xajax was installed in
+     *               "http://www.myserver.com/anotherfolder", then $sJsURI
+     *               should be set to "../anotherfolder". Defaults to assuming
+     *               xajax is in the same folder as your PHP file.
+     * @param string the relative folder/file pair of the xajax Javascript
+     *               engine located within the xajax installation folder.
+     *               Defaults to xajax_js/xajax.js.
+     * @return string
+     */
+    function getJavascriptInclude($sJsURI="", $sJsFile=NULL)
+    {
+        if ($sJsFile == NULL) $sJsFile = "xajax_js/xajax.js";
+
+        if ($sJsURI != "" && substr($sJsURI, -1) != "/") $sJsURI .= "/";
+
+        $html = "\t<script type=\"text/javascript\" src=\"" . $sJsURI . $sJsFile . "\"></script>\n";
+        $html .= "\t<script type=\"text/javascript\">\n";
+        $html .= "window.setTimeout(function () { if (!xajaxLoaded) { alert('Error: the xajax Javascript file could not be included. Perhaps the URL is incorrect?\\nURL: {$sJsURI}{$sJsFile}'); } }, 6000);\n";
+        $html .= "\t</script>\n";
+        return $html;
+    }
+
+    /**
+     * This method can be used to create a new xajax.js file out of the
+     * xajax_uncompressed.js file (which will only happen if xajax.js doesn't
+     * already exist on the filesystem).
+     *
+     * @param string an optional argument containing the full server file path
+     *               of xajax.js.
+     */
+    function autoCompressJavascript($sJsFullFilename=NULL)
+    {
+        $sJsFile = "xajax_js/xajax.js";
+
+        if ($sJsFullFilename) {
+            $realJsFile = $sJsFullFilename;
+        }
+        else {
+            $realPath = realpath(dirname(__FILE__));
+            $realJsFile = $realPath . "/". $sJsFile;
+        }
+
+        // Create a compressed file if necessary
+        if (!file_exists($realJsFile)) {
+            $srcFile = str_replace(".js", "_uncompressed.js", $realJsFile);
+            if (!file_exists($srcFile)) {
+                trigger_error("The xajax uncompressed Javascript file could not be found in the <b>" . dirname($realJsFile) . "</b> folder. Error ", E_USER_ERROR);
+            }
+            require(dirname(__FILE__)."/xajaxCompress.php");
+            $javaScript = implode('', file($srcFile));
+            $compressedScript = xajaxCompressJavascript($javaScript);
+            $fH = @fopen($realJsFile, "w");
+            if (!$fH) {
+                trigger_error("The xajax compressed javascript file could not be written in the <b>" . dirname($realJsFile) . "</b> folder. Error ", E_USER_ERROR);
+            }
+            else {
+                fwrite($fH, $compressedScript);
+                fclose($fH);
+            }
+        }
+    }
+
+    /**
+     * Returns the current URL based upon the SERVER vars.
+     *
+     * @access private
+     * @return string
+     */
+    function _detectURI() {
+        $aURL = array();
+
+        // Try to get the request URL
+        if (!empty($_SERVER['REQUEST_URI'])) {
+            $aURL = parse_url($_SERVER['REQUEST_URI']);
+        }
+
+        // Fill in the empty values
+        if (empty($aURL['scheme'])) {
+            if (!empty($_SERVER['HTTP_SCHEME'])) {
+                $aURL['scheme'] = $_SERVER['HTTP_SCHEME'];
+            } else {
+                $aURL['scheme'] = (!empty($_SERVER['HTTPS']) && strtolower($_SERVER['HTTPS']) != 'off') ? 'https' : 'http';
+            }
+        }
+
+        if (empty($aURL['host'])) {
+            if (!empty($_SERVER['HTTP_HOST'])) {
+                if (strpos($_SERVER['HTTP_HOST'], ':') > 0) {
+                    list($aURL['host'], $aURL['port']) = explode(':', $_SERVER['HTTP_HOST']);
+                } else {
+                    $aURL['host'] = $_SERVER['HTTP_HOST'];
+                }
+            } else if (!empty($_SERVER['SERVER_NAME'])) {
+                $aURL['host'] = $_SERVER['SERVER_NAME'];
+            } else {
+                print "xajax Error: xajax failed to automatically identify your Request URI.";
+                print "Please set the Request URI explicitly when you instantiate the xajax object.";
+                exit();
+            }
+        }
+
+        if (empty($aURL['port']) && !empty($_SERVER['SERVER_PORT'])) {
+            $aURL['port'] = $_SERVER['SERVER_PORT'];
+        }
+
+        if (empty($aURL['path'])) {
+            if (!empty($_SERVER['PATH_INFO'])) {
+                $sPath = parse_url($_SERVER['PATH_INFO']);
+            } else {
+                $sPath = parse_url(api_get_self());
+            }
+            $aURL['path'] = $sPath['path'];
+            unset($sPath);
+        }
+
+        if (!empty($aURL['query'])) {
+            $aURL['query'] = '?'.$aURL['query'];
+        }
+
+        // Build the URL: Start with scheme, user and pass
+        $sURL = $aURL['scheme'].'://';
+        if (!empty($aURL['user'])) {
+            $sURL.= $aURL['user'];
+            if (!empty($aURL['pass'])) {
+                $sURL.= ':'.$aURL['pass'];
+            }
+            $sURL.= '@';
+        }
+
+        // Add the host
+        $sURL.= $aURL['host'];
+
+        // Add the port if needed
+        if (!empty($aURL['port']) && (($aURL['scheme'] == 'http' && $aURL['port'] != 80) || ($aURL['scheme'] == 'https' && $aURL['port'] != 443))) {
+            $sURL.= ':'.$aURL['port'];
+        }
+
+        // Add the path and the query string
+        $sURL.= $aURL['path'].@$aURL['query'];
+
+        // Clean up
+        unset($aURL);
+        return $sURL;
+    }
+
+    /**
+     * Returns true if the function name is associated with an object callback,
+     * false if not.
+     *
+     * @param string the name of the function
+     * @access private
+     * @return boolean
+     */
+    function _isObjectCallback($sFunction)
+    {
+        if (array_key_exists($sFunction, $this->aObjects)) return true;
+        return false;
+    }
+
+    /**
+     * Returns true if the function or object callback can be called, false if
+     * not.
+     *
+     * @param string the name of the function
+     * @access private
+     * @return boolean
+     */
+    function _isFunctionCallable($sFunction)
+    {
+        if ($this->_isObjectCallback($sFunction)) {
+            if (is_object($this->aObjects[$sFunction][0])) {
+                return method_exists($this->aObjects[$sFunction][0], $this->aObjects[$sFunction][1]);
+            }
+            else {
+                return is_callable($this->aObjects[$sFunction]);
+            }
+        }
+        else {
+            return function_exists($sFunction);
+        }
+    }
+
+    /**
+     * Calls the function, class method, or object method with the supplied
+     * arguments.
+     *
+     * @param string the name of the function
+     * @param array  arguments to pass to the function
+     * @access private
+     * @return mixed the output of the called function or method
+     */
+    function _callFunction($sFunction, $aArgs)
+    {
+        if ($this->_isObjectCallback($sFunction)) {
+            $mReturn = call_user_func_array($this->aObjects[$sFunction], $aArgs);
+        }
+        else {
+            $mReturn = call_user_func_array($sFunction, $aArgs);
+        }
+        return $mReturn;
+    }
+
+    /**
+     * Generates the Javascript wrapper for the specified PHP function.
+     *
+     * @param string the name of the function
+     * @param mixed  the request type
+     * @access private
+     * @return string
+     */
+    function _wrap($sFunction,$sRequestType=XAJAX_POST)
+    {
+        $js = "function ".$this->sWrapperPrefix."$sFunction(){return xajax.call(\"$sFunction\", arguments, ".$sRequestType.");}\n";
+        return $js;
+    }
+
+    /**
+     * Takes a string containing xajax xjxobj XML or xjxquery XML and builds an
+     * array representation of it to pass as an argument to the PHP function
+     * being called.
+     *
+     * @param string the root tag of the XML
+     * @param string XML to convert
+     * @access private
+     * @return array
+     */
+    function _xmlToArray($rootTag, $sXml)
+    {
+        $aArray = array();
+        $sXml = str_replace("<$rootTag>","<$rootTag>|~|",$sXml);
+        $sXml = str_replace("</$rootTag>","</$rootTag>|~|",$sXml);
+        $sXml = str_replace("<e>","<e>|~|",$sXml);
+        $sXml = str_replace("</e>","</e>|~|",$sXml);
+        $sXml = str_replace("<k>","<k>|~|",$sXml);
+        $sXml = str_replace("</k>","|~|</k>|~|",$sXml);
+        $sXml = str_replace("<v>","<v>|~|",$sXml);
+        $sXml = str_replace("</v>","|~|</v>|~|",$sXml);
+        $sXml = str_replace("<q>","<q>|~|",$sXml);
+        $sXml = str_replace("</q>","|~|</q>|~|",$sXml);
+
+        $this->aObjArray = explode("|~|",$sXml);
+
+        $this->iPos = 0;
+        $aArray = $this->_parseObjXml($rootTag);
+
+        return $aArray;
+    }
+
+    /**
+     * A recursive function that generates an array from the contents of
+     * $this->aObjArray.
+     *
+     * @param string the root tag of the XML
+     * @access private
+     * @return array
+     */
+    function _parseObjXml($rootTag)
+    {
+        $aArray = array();
+
+        if ($rootTag == "xjxobj")
+        {
+            while(!stristr($this->aObjArray[$this->iPos],"</xjxobj>"))
+            {
+                $this->iPos++;
+                if(stristr($this->aObjArray[$this->iPos],"<e>"))
+                {
+                    $key = "";
+                    $value = null;
+
+                    $this->iPos++;
+                    while(!stristr($this->aObjArray[$this->iPos],"</e>"))
+                    {
+                        if(stristr($this->aObjArray[$this->iPos],"<k>"))
+                        {
+                            $this->iPos++;
+                            while(!stristr($this->aObjArray[$this->iPos],"</k>"))
+                            {
+                                $key .= $this->aObjArray[$this->iPos];
+                                $this->iPos++;
+                            }
+                        }
+                        if(stristr($this->aObjArray[$this->iPos],"<v>"))
+                        {
+                            $this->iPos++;
+                            while(!stristr($this->aObjArray[$this->iPos],"</v>"))
+                            {
+                                if(stristr($this->aObjArray[$this->iPos],"<xjxobj>"))
+                                {
+                                    $value = $this->_parseObjXml("xjxobj");
+                                    $this->iPos++;
+                                }
+                                else
+                                {
+                                    $value .= $this->aObjArray[$this->iPos];
+                                    if ($this->bDecodeUTF8Input)
+                                    {
+                                        $value = $this->_decodeUTF8Data($value);
+                                    }
+                                }
+                                $this->iPos++;
+                            }
+                        }
+                        $this->iPos++;
+                    }
+
+                    $aArray[$key]=$value;
+                }
+            }
+        }
+
+        if ($rootTag == "xjxquery")
+        {
+            $sQuery = "";
+            $this->iPos++;
+            while(!stristr($this->aObjArray[$this->iPos],"</xjxquery>"))
+            {
+                if (stristr($this->aObjArray[$this->iPos],"<q>") || stristr($this->aObjArray[$this->iPos],"</q>"))
+                {
+                    $this->iPos++;
+                    continue;
+                }
+                $sQuery	.= $this->aObjArray[$this->iPos];
+                $this->iPos++;
+            }
+
+            parse_str($sQuery, $aArray);
+            if ($this->bDecodeUTF8Input)
+            {
+                foreach($aArray as $key => $value)
+                {
+                    $aArray[$key] = $this->_decodeUTF8Data($value);
+                }
+            }
+            // If magic quotes is on, then we need to strip the slashes from the
+            // array values because of the parse_str pass which adds slashes
+            if (get_magic_quotes_gpc() == 1) {
+                $newArray = array();
+                foreach ($aArray as $sKey => $sValue) {
+                    if (is_string($sValue))
+                        $newArray[$sKey] = stripslashes($sValue);
+                    else
+                        $newArray[$sKey] = $sValue;
+                }
+                $aArray = $newArray;
+            }
+        }
+
+        return $aArray;
+    }
+
+    /**
+     * Decodes string data from UTF-8 to the current xajax encoding.
+     *
+     * @param string data to convert
+     * @access private
+     * @return string converted data
+     */
+    function _decodeUTF8Data($sData)
+    {
+        $sValue = $sData;
+        if ($this->bDecodeUTF8Input)
+        {
+            $sFuncToUse = NULL;
+
+            // An adaptation for the Dokeos LMS, 22-AUG-2009.
+            if (function_exists('api_convert_encoding'))
+            {
+                $sFuncToUse = "api_convert_encoding";
+            }
+            //if (function_exists('iconv'))
+            elseif (function_exists('iconv'))
+            //
+            {
+                $sFuncToUse = "iconv";
+            }
+            else if (function_exists('mb_convert_encoding'))
+            {
+                $sFuncToUse = "mb_convert_encoding";
+            }
+            else if ($this->sEncoding == "ISO-8859-1")
+            {
+                $sFuncToUse = "utf8_decode";
+            }
+            else
+            {
+                trigger_error("The incoming xajax data could not be converted from UTF-8", E_USER_NOTICE);
+            }
+
+            if ($sFuncToUse)
+            {
+                if (is_string($sValue))
+                {
+                    if ($sFuncToUse == "iconv")
+                    {
+                        $sValue = iconv("UTF-8", $this->sEncoding.'//TRANSLIT', $sValue);
+                    }
+                    else if ($sFuncToUse == "mb_convert_encoding")
+                    {
+                        $sValue = mb_convert_encoding($sValue, $this->sEncoding, "UTF-8");
+                    }
+                    // Added code, an adaptation for the Dokeos LMS, 22-AUG-2009.
+                    else if ($sFuncToUse == "api_convert_encoding")
+                    {
+                        $sValue = api_convert_encoding($sValue, $this->sEncoding, "UTF-8");
+                    }
+                    //
+                    else
+                    {
+                        $sValue = utf8_decode($sValue);
+                    }
+                }
+            }
+        }
+        return $sValue;
+    }
 
 }// end class xajax
 
@@ -1220,31 +1220,31 @@ 
  */
 function xajaxErrorHandler($errno, $errstr, $errfile, $errline)
 {
-	$errorReporting = error_reporting();
-	if (($errno & $errorReporting) == 0) return;
-
-	if ($errno == E_NOTICE) {
-		$errTypeStr = "NOTICE";
-	}
-	else if ($errno == E_WARNING) {
-		$errTypeStr = "WARNING";
-	}
-	else if ($errno == E_USER_NOTICE) {
-		$errTypeStr = "USER NOTICE";
-	}
-	else if ($errno == E_USER_WARNING) {
-		$errTypeStr = "USER WARNING";
-	}
-	else if ($errno == E_USER_ERROR) {
-		$errTypeStr = "USER FATAL ERROR";
-	}
-	else if ($errno == E_STRICT) {
-		return;
-	}
-	else {
-		$errTypeStr = "UNKNOWN: $errno";
-	}
-	$GLOBALS['xajaxErrorHandlerText'] .= "\n----\n[$errTypeStr] $errstr\nerror in line $errline of file $errfile";
+    $errorReporting = error_reporting();
+    if (($errno & $errorReporting) == 0) return;
+
+    if ($errno == E_NOTICE) {
+        $errTypeStr = "NOTICE";
+    }
+    else if ($errno == E_WARNING) {
+        $errTypeStr = "WARNING";
+    }
+    else if ($errno == E_USER_NOTICE) {
+        $errTypeStr = "USER NOTICE";
+    }
+    else if ($errno == E_USER_WARNING) {
+        $errTypeStr = "USER WARNING";
+    }
+    else if ($errno == E_USER_ERROR) {
+        $errTypeStr = "USER FATAL ERROR";
+    }
+    else if ($errno == E_STRICT) {
+        return;
+    }
+    else {
+        $errTypeStr = "UNKNOWN: $errno";
+    }
+    $GLOBALS['xajaxErrorHandlerText'] .= "\n----\n[$errTypeStr] $errstr\nerror in line $errline of file $errfile";
 }
 
 ?>

main/inc/lib/xajax/xajaxCompress.php

Doc Comments +1 added lines

@@ -39,6 +39,7 @@
  * (used internally)
  *
  * @param string contains the Javascript code to compress
+ * @param string $sJS
  */
 function xajaxCompressJavascript($sJS)
 {

Indentation +136 added lines, -136 removed lines

@@ -42,141 +42,141 @@
  */
 function xajaxCompressJavascript($sJS)
 {
-	//remove windows cariage returns
-	$sJS = str_replace("\r","",$sJS);
-
-	//array to store replaced literal strings
-	$literal_strings = array();
-
-	//explode the string into lines
-	$lines = explode("\n",$sJS);
-	//loop through all the lines, building a new string at the same time as removing literal strings
-	$clean = "";
-	$inComment = false;
-	$literal = "";
-	$inQuote = false;
-	$escaped = false;
-	$quoteChar = "";
-
-	for($i=0;$i<count($lines);$i++)
-	{
-		$line = $lines[$i];
-		$inNormalComment = false;
-
-		//loop through line's characters and take out any literal strings, replace them with ___i___ where i is the index of this string
-		for($j=0;$j<strlen($line);$j++)
-		{
-			$c = substr($line,$j,1);
-			$d = substr($line,$j,2);
-
-			//look for start of quote
-			if(!$inQuote && !$inComment)
-			{
-				//is this character a quote or a comment
-				if(($c=="\"" || $c=="'") && !$inComment && !$inNormalComment)
-				{
-					$inQuote = true;
-					$inComment = false;
-					$escaped = false;
-					$quoteChar = $c;
-					$literal = $c;
-				}
-				else if($d=="/*" && !$inNormalComment)
-				{
-					$inQuote = false;
-					$inComment = true;
-					$escaped = false;
-					$quoteChar = $d;
-					$literal = $d;
-					$j++;
-				}
-				else if($d=="//") //ignore string markers that are found inside comments
-				{
-					$inNormalComment = true;
-					$clean .= $c;
-				}
-				else
-				{
-					$clean .= $c;
-				}
-			}
-			else //allready in a string so find end quote
-			{
-				if($c == $quoteChar && !$escaped && !$inComment)
-				{
-					$inQuote = false;
-					$literal .= $c;
-
-					//subsitute in a marker for the string
-					$clean .= "___" . count($literal_strings) . "___";
-
-					//push the string onto our array
-					array_push($literal_strings,$literal);
-
-				}
-				else if($inComment && $d=="*/")
-				{
-					$inComment = false;
-					$literal .= $d;
-
-					//subsitute in a marker for the string
-					$clean .= "___" . count($literal_strings) . "___";
-
-					//push the string onto our array
-					array_push($literal_strings,$literal);
-
-					$j++;
-				}
-				else if($c == "\\" && !$escaped)
-					$escaped = true;
-				else
-					$escaped = false;
-
-				$literal .= $c;
-			}
-		}
-		if($inComment) $literal .= "\n";
-		$clean .= "\n";
-	}
-	//explode the clean string into lines again
-	$lines = explode("\n",$clean);
-
-	//now process each line at a time
-	for($i=0;$i<count($lines);$i++)
-	{
-		$line = $lines[$i];
-
-		//remove comments
-		$line = preg_replace("/\/\/(.*)/","",$line);
-
-		//strip leading and trailing whitespace
-		$line = trim($line);
-
-		//remove all whitespace with a single space
-		$line = preg_replace("/\s+/"," ",$line);
-
-		//remove any whitespace that occurs after/before an operator
-		$line = preg_replace("/\s*([!\}\{;,&=\|\-\+\*\/\)\(:])\s*/","\\1",$line);
-
-		$lines[$i] = $line;
-	}
-
-	//implode the lines
-	$sJS = implode("\n",$lines);
-
-	//make sure there is a max of 1 \n after each line
-	$sJS = preg_replace("/[\n]+/","\n",$sJS);
-
-	//strip out line breaks that immediately follow a semi-colon
-	$sJS = preg_replace("/;\n/",";",$sJS);
-
-	//curly brackets aren't on their own
-	$sJS = preg_replace("/[\n]*\{[\n]*/","{",$sJS);
-
-	//finally loop through and replace all the literal strings:
-	for($i=0;$i<count($literal_strings);$i++)
-		$sJS = str_replace("___".$i."___",$literal_strings[$i],$sJS);
-
-	return $sJS;
+    //remove windows cariage returns
+    $sJS = str_replace("\r","",$sJS);
+
+    //array to store replaced literal strings
+    $literal_strings = array();
+
+    //explode the string into lines
+    $lines = explode("\n",$sJS);
+    //loop through all the lines, building a new string at the same time as removing literal strings
+    $clean = "";
+    $inComment = false;
+    $literal = "";
+    $inQuote = false;
+    $escaped = false;
+    $quoteChar = "";
+
+    for($i=0;$i<count($lines);$i++)
+    {
+        $line = $lines[$i];
+        $inNormalComment = false;
+
+        //loop through line's characters and take out any literal strings, replace them with ___i___ where i is the index of this string
+        for($j=0;$j<strlen($line);$j++)
+        {
+            $c = substr($line,$j,1);
+            $d = substr($line,$j,2);
+
+            //look for start of quote
+            if(!$inQuote && !$inComment)
+            {
+                //is this character a quote or a comment
+                if(($c=="\"" || $c=="'") && !$inComment && !$inNormalComment)
+                {
+                    $inQuote = true;
+                    $inComment = false;
+                    $escaped = false;
+                    $quoteChar = $c;
+                    $literal = $c;
+                }
+                else if($d=="/*" && !$inNormalComment)
+                {
+                    $inQuote = false;
+                    $inComment = true;
+                    $escaped = false;
+                    $quoteChar = $d;
+                    $literal = $d;
+                    $j++;
+                }
+                else if($d=="//") //ignore string markers that are found inside comments
+                {
+                    $inNormalComment = true;
+                    $clean .= $c;
+                }
+                else
+                {
+                    $clean .= $c;
+                }
+            }
+            else //allready in a string so find end quote
+            {
+                if($c == $quoteChar && !$escaped && !$inComment)
+                {
+                    $inQuote = false;
+                    $literal .= $c;
+
+                    //subsitute in a marker for the string
+                    $clean .= "___" . count($literal_strings) . "___";
+
+                    //push the string onto our array
+                    array_push($literal_strings,$literal);
+
+                }
+                else if($inComment && $d=="*/")
+                {
+                    $inComment = false;
+                    $literal .= $d;
+
+                    //subsitute in a marker for the string
+                    $clean .= "___" . count($literal_strings) . "___";
+
+                    //push the string onto our array
+                    array_push($literal_strings,$literal);
+
+                    $j++;
+                }
+                else if($c == "\\" && !$escaped)
+                    $escaped = true;
+                else
+                    $escaped = false;
+
+                $literal .= $c;
+            }
+        }
+        if($inComment) $literal .= "\n";
+        $clean .= "\n";
+    }
+    //explode the clean string into lines again
+    $lines = explode("\n",$clean);
+
+    //now process each line at a time
+    for($i=0;$i<count($lines);$i++)
+    {
+        $line = $lines[$i];
+
+        //remove comments
+        $line = preg_replace("/\/\/(.*)/","",$line);
+
+        //strip leading and trailing whitespace
+        $line = trim($line);
+
+        //remove all whitespace with a single space
+        $line = preg_replace("/\s+/"," ",$line);
+
+        //remove any whitespace that occurs after/before an operator
+        $line = preg_replace("/\s*([!\}\{;,&=\|\-\+\*\/\)\(:])\s*/","\\1",$line);
+
+        $lines[$i] = $line;
+    }
+
+    //implode the lines
+    $sJS = implode("\n",$lines);
+
+    //make sure there is a max of 1 \n after each line
+    $sJS = preg_replace("/[\n]+/","\n",$sJS);
+
+    //strip out line breaks that immediately follow a semi-colon
+    $sJS = preg_replace("/;\n/",";",$sJS);
+
+    //curly brackets aren't on their own
+    $sJS = preg_replace("/[\n]*\{[\n]*/","{",$sJS);
+
+    //finally loop through and replace all the literal strings:
+    for($i=0;$i<count($literal_strings);$i++)
+        $sJS = str_replace("___".$i."___",$literal_strings[$i],$sJS);
+
+    return $sJS;
 }
 ?>

Spacing +29 added lines, -29 removed lines

@@ -43,13 +43,13 @@ 
 function xajaxCompressJavascript($sJS)
 {
 	//remove windows cariage returns
-	$sJS = str_replace("\r","",$sJS);
+	$sJS = str_replace("\r", "", $sJS);
 
 	//array to store replaced literal strings
 	$literal_strings = array();
 
 	//explode the string into lines
-	$lines = explode("\n",$sJS);
+	$lines = explode("\n", $sJS);
 	//loop through all the lines, building a new string at the same time as removing literal strings
 	$clean = "";
 	$inComment = false;
@@ -58,22 +58,22 @@ 
 	$escaped = false;
 	$quoteChar = "";
 
-	for($i=0;$i<count($lines);$i++)
+	for ($i = 0; $i < count($lines); $i++)
 	{
 		$line = $lines[$i];
 		$inNormalComment = false;
 
 		//loop through line's characters and take out any literal strings, replace them with ___i___ where i is the index of this string
-		for($j=0;$j<strlen($line);$j++)
+		for ($j = 0; $j < strlen($line); $j++)
 		{
-			$c = substr($line,$j,1);
-			$d = substr($line,$j,2);
+			$c = substr($line, $j, 1);
+			$d = substr($line, $j, 2);
 
 			//look for start of quote
-			if(!$inQuote && !$inComment)
+			if (!$inQuote && !$inComment)
 			{
 				//is this character a quote or a comment
-				if(($c=="\"" || $c=="'") && !$inComment && !$inNormalComment)
+				if (($c == "\"" || $c == "'") && !$inComment && !$inNormalComment)
 				{
 					$inQuote = true;
 					$inComment = false;
@@ -81,7 +81,7 @@ 
 					$quoteChar = $c;
 					$literal = $c;
 				}
-				else if($d=="/*" && !$inNormalComment)
+				else if ($d == "/*" && !$inNormalComment)
 				{
 					$inQuote = false;
 					$inComment = true;
@@ -90,7 +90,7 @@ 
 					$literal = $d;
 					$j++;
 				}
-				else if($d=="//") //ignore string markers that are found inside comments
+				else if ($d == "//") //ignore string markers that are found inside comments
 				{
 					$inNormalComment = true;
 					$clean .= $c;
@@ -102,32 +102,32 @@ 
 			}
 			else //allready in a string so find end quote
 			{
-				if($c == $quoteChar && !$escaped && !$inComment)
+				if ($c == $quoteChar && !$escaped && !$inComment)
 				{
 					$inQuote = false;
 					$literal .= $c;
 
 					//subsitute in a marker for the string
-					$clean .= "___" . count($literal_strings) . "___";
+					$clean .= "___".count($literal_strings)."___";
 
 					//push the string onto our array
-					array_push($literal_strings,$literal);
+					array_push($literal_strings, $literal);
 
 				}
-				else if($inComment && $d=="*/")
+				else if ($inComment && $d == "*/")
 				{
 					$inComment = false;
 					$literal .= $d;
 
 					//subsitute in a marker for the string
-					$clean .= "___" . count($literal_strings) . "___";
+					$clean .= "___".count($literal_strings)."___";
 
 					//push the string onto our array
-					array_push($literal_strings,$literal);
+					array_push($literal_strings, $literal);
 
 					$j++;
 				}
-				else if($c == "\\" && !$escaped)
+				else if ($c == "\\" && !$escaped)
 					$escaped = true;
 				else
 					$escaped = false;
@@ -135,47 +135,47 @@ 
 				$literal .= $c;
 			}
 		}
-		if($inComment) $literal .= "\n";
+		if ($inComment) $literal .= "\n";
 		$clean .= "\n";
 	}
 	//explode the clean string into lines again
-	$lines = explode("\n",$clean);
+	$lines = explode("\n", $clean);
 
 	//now process each line at a time
-	for($i=0;$i<count($lines);$i++)
+	for ($i = 0; $i < count($lines); $i++)
 	{
 		$line = $lines[$i];
 
 		//remove comments
-		$line = preg_replace("/\/\/(.*)/","",$line);
+		$line = preg_replace("/\/\/(.*)/", "", $line);
 
 		//strip leading and trailing whitespace
 		$line = trim($line);
 
 		//remove all whitespace with a single space
-		$line = preg_replace("/\s+/"," ",$line);
+		$line = preg_replace("/\s+/", " ", $line);
 
 		//remove any whitespace that occurs after/before an operator
-		$line = preg_replace("/\s*([!\}\{;,&=\|\-\+\*\/\)\(:])\s*/","\\1",$line);
+		$line = preg_replace("/\s*([!\}\{;,&=\|\-\+\*\/\)\(:])\s*/", "\\1", $line);
 
 		$lines[$i] = $line;
 	}
 
 	//implode the lines
-	$sJS = implode("\n",$lines);
+	$sJS = implode("\n", $lines);
 
 	//make sure there is a max of 1 \n after each line
-	$sJS = preg_replace("/[\n]+/","\n",$sJS);
+	$sJS = preg_replace("/[\n]+/", "\n", $sJS);
 
 	//strip out line breaks that immediately follow a semi-colon
-	$sJS = preg_replace("/;\n/",";",$sJS);
+	$sJS = preg_replace("/;\n/", ";", $sJS);
 
 	//curly brackets aren't on their own
-	$sJS = preg_replace("/[\n]*\{[\n]*/","{",$sJS);
+	$sJS = preg_replace("/[\n]*\{[\n]*/", "{", $sJS);
 
 	//finally loop through and replace all the literal strings:
-	for($i=0;$i<count($literal_strings);$i++)
-		$sJS = str_replace("___".$i."___",$literal_strings[$i],$sJS);
+	for ($i = 0; $i < count($literal_strings); $i++)
+		$sJS = str_replace("___".$i."___", $literal_strings[$i], $sJS);
 
 	return $sJS;
 }

Braces +17 added lines, -17 removed lines

@@ -80,8 +80,7 @@ 
 					$escaped = false;
 					$quoteChar = $c;
 					$literal = $c;
-				}
-				else if($d=="/*" && !$inNormalComment)
+				} else if($d=="/*" && !$inNormalComment)
 				{
 					$inQuote = false;
 					$inComment = true;
@@ -89,18 +88,17 @@ 
 					$quoteChar = $d;
 					$literal = $d;
 					$j++;
-				}
-				else if($d=="//") //ignore string markers that are found inside comments
+				} else if($d=="//") {
+				    //ignore string markers that are found inside comments
 				{
 					$inNormalComment = true;
-					$clean .= $c;
 				}
-				else
+					$clean .= $c;
+				} else
 				{
 					$clean .= $c;
 				}
-			}
-			else //allready in a string so find end quote
+			} else //allready in a string so find end quote
 			{
 				if($c == $quoteChar && !$escaped && !$inComment)
 				{
@@ -113,8 +111,7 @@ 
 					//push the string onto our array
 					array_push($literal_strings,$literal);
 
-				}
-				else if($inComment && $d=="*/")
+				} else if($inComment && $d=="*/")
 				{
 					$inComment = false;
 					$literal .= $d;
@@ -126,16 +123,18 @@ 
 					array_push($literal_strings,$literal);
 
 					$j++;
+				} else if($c == "\\" && !$escaped) {
+									$escaped = true;
+				} else {
+									$escaped = false;
 				}
-				else if($c == "\\" && !$escaped)
-					$escaped = true;
-				else
-					$escaped = false;
 
 				$literal .= $c;
 			}
 		}
-		if($inComment) $literal .= "\n";
+		if($inComment) {
+		    $literal .= "\n";
+		}
 		$clean .= "\n";
 	}
 	//explode the clean string into lines again
@@ -174,8 +173,9 @@ 
 	$sJS = preg_replace("/[\n]*\{[\n]*/","{",$sJS);
 
 	//finally loop through and replace all the literal strings:
-	for($i=0;$i<count($literal_strings);$i++)
-		$sJS = str_replace("___".$i."___",$literal_strings[$i],$sJS);
+	for($i=0;$i<count($literal_strings);$i++) {
+			$sJS = str_replace("___".$i."___",$literal_strings[$i],$sJS);
+	}
 
 	return $sJS;
 }

main/inc/lib/xajax/xajaxResponse.inc.php

Doc Comments +4 added lines, -2 removed lines

@@ -97,6 +97,7 @@ 
 	 * @param string  contains the character encoding string to use
 	 * @param boolean lets you set if you want special characters in the output
 	 *                converted to HTML entities
+	 * @param string $sEncoding
 	 *
 	 */
 	function xajaxResponse($sEncoding=XAJAX_DEFAULT_CHAR_ENCODING, $bOutputEntities=false)
@@ -223,6 +224,8 @@ 
 	 * @param string contains the id of an HTML element
 	 * @param string the part of the element you wish to clear ("innerHTML",
 	 *               "value", etc.)
+	 * @param string $sTarget
+	 * @param string $sAttribute
 	 */
 	function addClear($sTarget,$sAttribute)
 	{
@@ -279,6 +282,7 @@ 
 	 * <i>Usage:</i> <kbd>$objResponse->addScript("var x = prompt('get some text');");</kbd>
 	 *
 	 * @param string contains Javascript code to be executed
+	 * @param string $sJS
 	 */
 	function addScript($sJS)
 	{
@@ -290,8 +294,6 @@ 
 	 *
 	 * <i>Usage:</i> <kbd>$objResponse->addScriptCall("myJSFunction", "arg 1", "arg 2", 12345);</kbd>
 	 *
-	 * @param string $sFunc the name of a Javascript function
-	 * @param mixed $args,... optional arguments to pass to the Javascript function
 	 */
 	function addScriptCall() {
 		$arguments = func_get_args();

Braces +21 added lines, -17 removed lines

@@ -258,8 +258,9 @@ 
 		{
 			$queryStart++;
 			$queryEnd = strpos($sURL, '#', $queryStart);
-			if ($queryEnd === FALSE)
-				$queryEnd = strlen($sURL);
+			if ($queryEnd === FALSE) {
+							$queryEnd = strlen($sURL);
+			}
 			$queryPart = substr($sURL, $queryStart, $queryEnd-$queryStart);
             $queryParts = array();
 			parse_str($queryPart, $queryParts);
@@ -487,8 +488,9 @@ 
 	function getXML()
 	{
 		$sXML = "<?xml version=\"1.0\"";
-		if ($this->sEncoding && strlen(trim($this->sEncoding)) > 0)
-			$sXML .= " encoding=\"".$this->sEncoding."\"";
+		if ($this->sEncoding && strlen(trim($this->sEncoding)) > 0) {
+					$sXML .= " encoding=\"".$this->sEncoding."\"";
+		}
 		$sXML .= " ?"."><xjx>" . $this->xml . "</xjx>";
 
 		return $sXML;
@@ -538,20 +540,21 @@ 
 			elseif (function_exists('mb_convert_encoding')) {
 			//
 				$sData = call_user_func_array('mb_convert_encoding', array(&$sData, 'HTML-ENTITIES', $this->sEncoding));
-			}
-			else {
+			} else {
 				trigger_error("The xajax XML response output could not be converted to HTML entities because the mb_convert_encoding function is not available", E_USER_NOTICE);
 			}
 		}
 		$xml = "<cmd";
-		foreach($aAttributes as $sAttribute => $sValue)
-			$xml .= " $sAttribute=\"$sValue\"";
-		if ($sData !== null && !stristr($sData,'<![CDATA['))
-			$xml .= "><![CDATA[$sData]]></cmd>";
-		else if ($sData !== null)
-			$xml .= ">$sData</cmd>";
-		else
-			$xml .= "></cmd>";
+		foreach($aAttributes as $sAttribute => $sValue) {
+					$xml .= " $sAttribute=\"$sValue\"";
+		}
+		if ($sData !== null && !stristr($sData,'<![CDATA[')) {
+					$xml .= "><![CDATA[$sData]]></cmd>";
+		} else if ($sData !== null) {
+					$xml .= ">$sData</cmd>";
+		} else {
+					$xml .= "></cmd>";
+		}
 
 		return $xml;
 	}
@@ -566,11 +569,12 @@ 
 	 * @return string serialized XML
 	 */
 	function _buildObjXml($var) {
-		if (gettype($var) == "object") $var = get_object_vars($var);
+		if (gettype($var) == "object") {
+		    $var = get_object_vars($var);
+		}
 		if (!is_array($var)) {
 			return "<![CDATA[$var]]>";
-		}
-		else {
+		} else {
 			$data = "<xjxobj>";
 			foreach ($var as $key => $value) {
 				$data .= "<e>";

Indentation +512 added lines, -512 removed lines

@@ -67,521 +67,521 @@
  */
 class xajaxResponse
 {
-	/**#@+
+    /**#@+
 	 * @access protected
 	 */
-	/**
-	 * @var string internal XML storage
-	 */
-	var $xml;
-	/**
-	 * @var string the encoding type to use
-	 */
-	var $sEncoding;
-	/**
-	 * @var boolean if special characters in the XML should be converted to
-	 *              entities
-	 */
-	var $bOutputEntities;
-
-	/**#@-*/
-
-	/**
-	 * The constructor's main job is to set the character encoding for the
-	 * response.
-	 *
-	 * <i>Note:</i> to change the character encoding for all of the
-	 * responses, set the XAJAX_DEFAULT_ENCODING constant before you
-	 * instantiate xajax.
-	 *
-	 * @param string  contains the character encoding string to use
-	 * @param boolean lets you set if you want special characters in the output
-	 *                converted to HTML entities
-	 *
-	 */
-	public function __construct($sEncoding=XAJAX_DEFAULT_CHAR_ENCODING, $bOutputEntities=false)
-	{
-		$this->setCharEncoding($sEncoding);
-		$this->bOutputEntities = $bOutputEntities;
-	}
-
-	/**
-	 * Sets the character encoding for the response based on $sEncoding, which
-	 * is a string containing the character encoding to use. You don't need to
-	 * use this method normally, since the character encoding for the response
-	 * gets set automatically based on the XAJAX_DEFAULT_CHAR_ENCODING
-	 * constant.
-	 *
-	 * @param string
-	 */
-	function setCharEncoding($sEncoding)
-	{
-		$this->sEncoding = $sEncoding;
-	}
-
-	/**
-	 * Tells the response object to convert special characters to HTML entities
-	 * automatically (only works if the mb_string extension is available).
-	 */
-	function outputEntitiesOn()
-	{
-		$this->bOutputEntities = true;
-	}
-
-	/**
-	 * Tells the response object to output special characters intact. (default
-	 * behavior)
-	 */
-	function outputEntitiesOff()
-	{
-		$this->bOutputEntities = false;
-	}
-
-	/**
-	 * Adds a confirm commands command message to the XML response.
-	 *
-	 * <i>Usage:</i> <kbd>$objResponse->addConfirmCommands(1, "Do you want to preview the new data?");</kbd>
-	 *
-	 * @param integer the number of commands to skip if the user presses
-	 *                Cancel in the browsers's confirm dialog
-	 * @param string  the message to show in the browser's confirm dialog
-	 */
-	function addConfirmCommands($iCmdNumber, $sMessage)
-	{
-		$this->xml .= $this->_cmdXML(array("n"=>"cc","t"=>$iCmdNumber),$sMessage);
-	}
-
-	/**
-	 * Adds an assign command message to the XML response.
-	 *
-	 * <i>Usage:</i> <kbd>$objResponse->addAssign("contentDiv", "innerHTML", "Some Text");</kbd>
-	 *
-	 * @param string contains the id of an HTML element
-	 * @param string the part of the element you wish to modify ("innerHTML",
-	 *               "value", etc.)
-	 * @param string the data you want to set the attribute to
-	 */
-	function addAssign($sTarget,$sAttribute,$sData)
-	{
-		$this->xml .= $this->_cmdXML(array("n"=>"as","t"=>$sTarget,"p"=>$sAttribute),$sData);
-	}
-
-	/**
-	 * Adds an append command message to the XML response.
-	 *
-	 * <i>Usage:</i> <kbd>$objResponse->addAppend("contentDiv", "innerHTML", "Some New Text");</kbd>
-	 *
-	 * @param string contains the id of an HTML element
-	 * @param string the part of the element you wish to modify ("innerHTML",
-	 *               "value", etc.)
-	 * @param string the data you want to append to the end of the attribute
-	 */
-	function addAppend($sTarget,$sAttribute,$sData)
-	{
-		$this->xml .= $this->_cmdXML(array("n"=>"ap","t"=>$sTarget,"p"=>$sAttribute),$sData);
-	}
-
-	/**
-	 * Adds an prepend command message to the XML response.
-	 *
-	 * <i>Usage:</i> <kbd>$objResponse->addPrepend("contentDiv", "innerHTML", "Some Starting Text");</kbd>
-	 *
-	 * @param string contains the id of an HTML element
-	 * @param string the part of the element you wish to modify ("innerHTML",
-	 *               "value", etc.)
-	 * @param string the data you want to prepend to the beginning of the
-	 *               attribute
-	 */
-	function addPrepend($sTarget,$sAttribute,$sData)
-	{
-		$this->xml .= $this->_cmdXML(array("n"=>"pp","t"=>$sTarget,"p"=>$sAttribute),$sData);
-	}
-
-	/**
-	 * Adds a replace command message to the XML response.
-	 *
-	 * <i>Usage:</i> <kbd>$objResponse->addReplace("contentDiv", "innerHTML", "text", "<b>text</b>");</kbd>
-	 *
-	 * @param string contains the id of an HTML element
-	 * @param string the part of the element you wish to modify ("innerHTML",
-	 *               "value", etc.)
-	 * @param string the string to search for
-	 * @param string the string to replace the search string when found in the
-	 *               attribute
-	 */
-	function addReplace($sTarget,$sAttribute,$sSearch,$sData)
-	{
-		$sDta = "<s><![CDATA[$sSearch]]></s><r><![CDATA[$sData]]></r>";
-		$this->xml .= $this->_cmdXML(array("n"=>"rp","t"=>$sTarget,"p"=>$sAttribute),$sDta);
-	}
-
-	/**
-	 * Adds a clear command message to the XML response.
-	 *
-	 * <i>Usage:</i> <kbd>$objResponse->addClear("contentDiv", "innerHTML");</kbd>
-	 *
-	 * @param string contains the id of an HTML element
-	 * @param string the part of the element you wish to clear ("innerHTML",
-	 *               "value", etc.)
-	 */
-	function addClear($sTarget,$sAttribute)
-	{
-		$this->addAssign($sTarget,$sAttribute,'');
-	}
-
-	/**
-	 * Adds an alert command message to the XML response.
-	 *
-	 * <i>Usage:</i> <kbd>$objResponse->addAlert("This is important information");</kbd>
-	 *
-	 * @param string the text to be displayed in the Javascript alert box
-	 */
-	function addAlert($sMsg)
-	{
-		$this->xml .= $this->_cmdXML(array("n"=>"al"),$sMsg);
-	}
-
-	/**
-	 * Uses the addScript() method to add a Javascript redirect to another URL.
-	 *
-	 * <i>Usage:</i> <kbd>$objResponse->addRedirect("http://www.xajaxproject.org");</kbd>
-	 *
-	 * @param string the URL to redirect the client browser to
-	 */
-	function addRedirect($sURL)
-	{
-		//we need to parse the query part so that the values are rawurlencode()'ed
-		//can't just use parse_url() cos we could be dealing with a relative URL which
-		//  parse_url() can't deal with.
-		$queryStart = strpos($sURL, '?', strrpos($sURL, '/'));
-		if ($queryStart !== FALSE)
-		{
-			$queryStart++;
-			$queryEnd = strpos($sURL, '#', $queryStart);
-			if ($queryEnd === FALSE)
-				$queryEnd = strlen($sURL);
-			$queryPart = substr($sURL, $queryStart, $queryEnd-$queryStart);
+    /**
+     * @var string internal XML storage
+     */
+    var $xml;
+    /**
+     * @var string the encoding type to use
+     */
+    var $sEncoding;
+    /**
+     * @var boolean if special characters in the XML should be converted to
+     *              entities
+     */
+    var $bOutputEntities;
+
+    /**#@-*/
+
+    /**
+     * The constructor's main job is to set the character encoding for the
+     * response.
+     *
+     * <i>Note:</i> to change the character encoding for all of the
+     * responses, set the XAJAX_DEFAULT_ENCODING constant before you
+     * instantiate xajax.
+     *
+     * @param string  contains the character encoding string to use
+     * @param boolean lets you set if you want special characters in the output
+     *                converted to HTML entities
+     *
+     */
+    public function __construct($sEncoding=XAJAX_DEFAULT_CHAR_ENCODING, $bOutputEntities=false)
+    {
+        $this->setCharEncoding($sEncoding);
+        $this->bOutputEntities = $bOutputEntities;
+    }
+
+    /**
+     * Sets the character encoding for the response based on $sEncoding, which
+     * is a string containing the character encoding to use. You don't need to
+     * use this method normally, since the character encoding for the response
+     * gets set automatically based on the XAJAX_DEFAULT_CHAR_ENCODING
+     * constant.
+     *
+     * @param string
+     */
+    function setCharEncoding($sEncoding)
+    {
+        $this->sEncoding = $sEncoding;
+    }
+
+    /**
+     * Tells the response object to convert special characters to HTML entities
+     * automatically (only works if the mb_string extension is available).
+     */
+    function outputEntitiesOn()
+    {
+        $this->bOutputEntities = true;
+    }
+
+    /**
+     * Tells the response object to output special characters intact. (default
+     * behavior)
+     */
+    function outputEntitiesOff()
+    {
+        $this->bOutputEntities = false;
+    }
+
+    /**
+     * Adds a confirm commands command message to the XML response.
+     *
+     * <i>Usage:</i> <kbd>$objResponse->addConfirmCommands(1, "Do you want to preview the new data?");</kbd>
+     *
+     * @param integer the number of commands to skip if the user presses
+     *                Cancel in the browsers's confirm dialog
+     * @param string  the message to show in the browser's confirm dialog
+     */
+    function addConfirmCommands($iCmdNumber, $sMessage)
+    {
+        $this->xml .= $this->_cmdXML(array("n"=>"cc","t"=>$iCmdNumber),$sMessage);
+    }
+
+    /**
+     * Adds an assign command message to the XML response.
+     *
+     * <i>Usage:</i> <kbd>$objResponse->addAssign("contentDiv", "innerHTML", "Some Text");</kbd>
+     *
+     * @param string contains the id of an HTML element
+     * @param string the part of the element you wish to modify ("innerHTML",
+     *               "value", etc.)
+     * @param string the data you want to set the attribute to
+     */
+    function addAssign($sTarget,$sAttribute,$sData)
+    {
+        $this->xml .= $this->_cmdXML(array("n"=>"as","t"=>$sTarget,"p"=>$sAttribute),$sData);
+    }
+
+    /**
+     * Adds an append command message to the XML response.
+     *
+     * <i>Usage:</i> <kbd>$objResponse->addAppend("contentDiv", "innerHTML", "Some New Text");</kbd>
+     *
+     * @param string contains the id of an HTML element
+     * @param string the part of the element you wish to modify ("innerHTML",
+     *               "value", etc.)
+     * @param string the data you want to append to the end of the attribute
+     */
+    function addAppend($sTarget,$sAttribute,$sData)
+    {
+        $this->xml .= $this->_cmdXML(array("n"=>"ap","t"=>$sTarget,"p"=>$sAttribute),$sData);
+    }
+
+    /**
+     * Adds an prepend command message to the XML response.
+     *
+     * <i>Usage:</i> <kbd>$objResponse->addPrepend("contentDiv", "innerHTML", "Some Starting Text");</kbd>
+     *
+     * @param string contains the id of an HTML element
+     * @param string the part of the element you wish to modify ("innerHTML",
+     *               "value", etc.)
+     * @param string the data you want to prepend to the beginning of the
+     *               attribute
+     */
+    function addPrepend($sTarget,$sAttribute,$sData)
+    {
+        $this->xml .= $this->_cmdXML(array("n"=>"pp","t"=>$sTarget,"p"=>$sAttribute),$sData);
+    }
+
+    /**
+     * Adds a replace command message to the XML response.
+     *
+     * <i>Usage:</i> <kbd>$objResponse->addReplace("contentDiv", "innerHTML", "text", "<b>text</b>");</kbd>
+     *
+     * @param string contains the id of an HTML element
+     * @param string the part of the element you wish to modify ("innerHTML",
+     *               "value", etc.)
+     * @param string the string to search for
+     * @param string the string to replace the search string when found in the
+     *               attribute
+     */
+    function addReplace($sTarget,$sAttribute,$sSearch,$sData)
+    {
+        $sDta = "<s><![CDATA[$sSearch]]></s><r><![CDATA[$sData]]></r>";
+        $this->xml .= $this->_cmdXML(array("n"=>"rp","t"=>$sTarget,"p"=>$sAttribute),$sDta);
+    }
+
+    /**
+     * Adds a clear command message to the XML response.
+     *
+     * <i>Usage:</i> <kbd>$objResponse->addClear("contentDiv", "innerHTML");</kbd>
+     *
+     * @param string contains the id of an HTML element
+     * @param string the part of the element you wish to clear ("innerHTML",
+     *               "value", etc.)
+     */
+    function addClear($sTarget,$sAttribute)
+    {
+        $this->addAssign($sTarget,$sAttribute,'');
+    }
+
+    /**
+     * Adds an alert command message to the XML response.
+     *
+     * <i>Usage:</i> <kbd>$objResponse->addAlert("This is important information");</kbd>
+     *
+     * @param string the text to be displayed in the Javascript alert box
+     */
+    function addAlert($sMsg)
+    {
+        $this->xml .= $this->_cmdXML(array("n"=>"al"),$sMsg);
+    }
+
+    /**
+     * Uses the addScript() method to add a Javascript redirect to another URL.
+     *
+     * <i>Usage:</i> <kbd>$objResponse->addRedirect("http://www.xajaxproject.org");</kbd>
+     *
+     * @param string the URL to redirect the client browser to
+     */
+    function addRedirect($sURL)
+    {
+        //we need to parse the query part so that the values are rawurlencode()'ed
+        //can't just use parse_url() cos we could be dealing with a relative URL which
+        //  parse_url() can't deal with.
+        $queryStart = strpos($sURL, '?', strrpos($sURL, '/'));
+        if ($queryStart !== FALSE)
+        {
+            $queryStart++;
+            $queryEnd = strpos($sURL, '#', $queryStart);
+            if ($queryEnd === FALSE)
+                $queryEnd = strlen($sURL);
+            $queryPart = substr($sURL, $queryStart, $queryEnd-$queryStart);
             $queryParts = array();
-			parse_str($queryPart, $queryParts);
-			$newQueryPart = "";
-			foreach($queryParts as $key => $value)
-			{
-				$newQueryPart .= rawurlencode($key).'='.rawurlencode($value).ini_get('arg_separator.output');
-			}
-			$sURL = str_replace($queryPart, $newQueryPart, $sURL);
-		}
-		$this->addScript('window.location = "'.$sURL.'";');
-	}
-
-	/**
-	 * Adds a Javascript command message to the XML response.
-	 *
-	 * <i>Usage:</i> <kbd>$objResponse->addScript("var x = prompt('get some text');");</kbd>
-	 *
-	 * @param string contains Javascript code to be executed
-	 */
-	function addScript($sJS)
-	{
-		$this->xml .= $this->_cmdXML(array("n"=>"js"),$sJS);
-	}
-
-	/**
-	 * Adds a Javascript function call command message to the XML response.
-	 *
-	 * <i>Usage:</i> <kbd>$objResponse->addScriptCall("myJSFunction", "arg 1", "arg 2", 12345);</kbd>
-	 *
-	 * @param string $sFunc the name of a Javascript function
-	 * @param mixed $args,... optional arguments to pass to the Javascript function
-	 */
-	function addScriptCall() {
-		$arguments = func_get_args();
-		$sFunc = array_shift($arguments);
-		$sData = $this->_buildObjXml($arguments);
-		$this->xml .= $this->_cmdXML(array("n"=>"jc","t"=>$sFunc),$sData);
-	}
-
-	/**
-	 * Adds a remove element command message to the XML response.
-	 *
-	 * <i>Usage:</i> <kbd>$objResponse->addRemove("Div2");</kbd>
-	 *
-	 * @param string contains the id of an HTML element to be removed
-	 */
-	function addRemove($sTarget)
-	{
-		$this->xml .= $this->_cmdXML(array("n"=>"rm","t"=>$sTarget),'');
-	}
-
-	/**
-	 * Adds a create element command message to the XML response.
-	 *
-	 * <i>Usage:</i> <kbd>$objResponse->addCreate("parentDiv", "h3", "myid");</kbd>
-	 *
-	 * @param string contains the id of an HTML element to to which the new
-	 *               element will be appended.
-	 * @param string the tag to be added
-	 * @param string the id to be assigned to the new element
-	 * @param string deprecated, use the addCreateInput() method instead
-	 */
-	function addCreate($sParent, $sTag, $sId, $sType="")
-	{
-		if ($sType)
-		{
-			trigger_error("The \$sType parameter of addCreate has been deprecated.  Use the addCreateInput() method instead.", E_USER_WARNING);
-			return;
-		}
-		$this->xml .= $this->_cmdXML(array("n"=>"ce","t"=>$sParent,"p"=>$sId),$sTag);
-	}
-
-	/**
-	 * Adds a insert element command message to the XML response.
-	 *
-	 * <i>Usage:</i> <kbd>$objResponse->addInsert("childDiv", "h3", "myid");</kbd>
-	 *
-	 * @param string contains the id of the child before which the new element
-	 *               will be inserted
-	 * @param string the tag to be added
-	 * @param string the id to be assigned to the new element
-	 */
-	function addInsert($sBefore, $sTag, $sId)
-	{
-		$this->xml .= $this->_cmdXML(array("n"=>"ie","t"=>$sBefore,"p"=>$sId),$sTag);
-	}
-
-	/**
-	 * Adds a insert element command message to the XML response.
-	 *
-	 * <i>Usage:</i> <kbd>$objResponse->addInsertAfter("childDiv", "h3", "myid");</kbd>
-	 *
-	 * @param string contains the id of the child after which the new element
-	 *               will be inserted
-	 * @param string the tag to be added
-	 * @param string the id to be assigned to the new element
-	 */
-	function addInsertAfter($sAfter, $sTag, $sId)
-	{
-		$this->xml .= $this->_cmdXML(array("n"=>"ia","t"=>$sAfter,"p"=>$sId),$sTag);
-	}
-
-	/**
-	 * Adds a create input command message to the XML response.
-	 *
-	 * <i>Usage:</i> <kbd>$objResponse->addCreateInput("form1", "text", "username", "input1");</kbd>
-	 *
-	 * @param string contains the id of an HTML element to which the new input
-	 *               will be appended
-	 * @param string the type of input to be created (text, radio, checkbox,
-	 *               etc.)
-	 * @param string the name to be assigned to the new input and the variable
-	 *               name when it is submitted
-	 * @param string the id to be assigned to the new input
-	 */
-	function addCreateInput($sParent, $sType, $sName, $sId)
-	{
-		$this->xml .= $this->_cmdXML(array("n"=>"ci","t"=>$sParent,"p"=>$sId,"c"=>$sType),$sName);
-	}
-
-	/**
-	 * Adds an insert input command message to the XML response.
-	 *
-	 * <i>Usage:</i> <kbd>$objResponse->addInsertInput("input5", "text", "username", "input1");</kbd>
-	 *
-	 * @param string contains the id of the child before which the new element
-	 *               will be inserted
-	 * @param string the type of input to be created (text, radio, checkbox,
-	 *               etc.)
-	 * @param string the name to be assigned to the new input and the variable
-	 *               name when it is submitted
-	 * @param string the id to be assigned to the new input
-	 */
-	function addInsertInput($sBefore, $sType, $sName, $sId)
-	{
-		$this->xml .= $this->_cmdXML(array("n"=>"ii","t"=>$sBefore,"p"=>$sId,"c"=>$sType),$sName);
-	}
-
-	/**
-	 * Adds an insert input command message to the XML response.
-	 *
-	 * <i>Usage:</i> <kbd>$objResponse->addInsertInputAfter("input7", "text", "email", "input2");</kbd>
-	 *
-	 * @param string contains the id of the child after which the new element
-	 *               will be inserted
-	 * @param string the type of input to be created (text, radio, checkbox,
-	 *               etc.)
-	 * @param string the name to be assigned to the new input and the variable
-	 *               name when it is submitted
-	 * @param string the id to be assigned to the new input
-	 */
-	function addInsertInputAfter($sAfter, $sType, $sName, $sId)
-	{
-		$this->xml .= $this->_cmdXML(array("n"=>"iia","t"=>$sAfter,"p"=>$sId,"c"=>$sType),$sName);
-	}
-
-	/**
-	 * Adds an event command message to the XML response.
-	 *
-	 * <i>Usage:</i> <kbd>$objResponse->addEvent("contentDiv", "onclick", "alert(\'Hello World\');");</kbd>
-	 *
-	 * @param string contains the id of an HTML element
-	 * @param string the event you wish to set ("onclick", "onmouseover", etc.)
-	 * @param string the Javascript string you want the event to invoke
-	 */
-	function addEvent($sTarget,$sEvent,$sScript)
-	{
-		$this->xml .= $this->_cmdXML(array("n"=>"ev","t"=>$sTarget,"p"=>$sEvent),$sScript);
-	}
-
-	/**
-	 * Adds a handler command message to the XML response.
-	 *
-	 * <i>Usage:</i> <kbd>$objResponse->addHandler("contentDiv", "onclick", "content_click");</kbd>
-	 *
-	 * @param string contains the id of an HTML element
-	 * @param string the event you wish to set ("onclick", "onmouseover", etc.)
-	 * @param string the name of a Javascript function that will handle the
-	 *               event. Multiple handlers can be added for the same event
-	 */
-	function addHandler($sTarget,$sEvent,$sHandler)
-	{
-		$this->xml .= $this->_cmdXML(array("n"=>"ah","t"=>$sTarget,"p"=>$sEvent),$sHandler);
-	}
-
-	/**
-	 * Adds a remove handler command message to the XML response.
-	 *
-	 * <i>Usage:</i> <kbd>$objResponse->addRemoveHandler("contentDiv", "onclick", "content_click");</kbd>
-	 *
-	 * @param string contains the id of an HTML element
-	 * @param string the event you wish to remove ("onclick", "onmouseover",
-	 *               etc.)
-	 * @param string the name of a Javascript handler function that you want to
-	 *               remove
-	 */
-	function addRemoveHandler($sTarget,$sEvent,$sHandler)
-	{
-		$this->xml .= $this->_cmdXML(array("n"=>"rh","t"=>$sTarget,"p"=>$sEvent),$sHandler);
-	}
-
-	/**
-	 * Adds an include script command message to the XML response.
-	 *
-	 * <i>Usage:</i> <kbd>$objResponse->addIncludeScript("functions.js");</kbd>
-	 *
-	 * @param string URL of the Javascript file to include
-	 */
-	function addIncludeScript($sFileName)
-	{
-		$this->xml .= $this->_cmdXML(array("n"=>"in"),$sFileName);
-	}
-
-	/**
-	 * Returns the XML to be returned from your function to the xajax processor
-	 * on your page. Since xajax 0.2, you can also return an xajaxResponse
-	 * object from your function directly, and xajax will automatically request
-	 * the XML using this method call.
-	 *
-	 * <i>Usage:</i> <kbd>return $objResponse->getXML();</kbd>
-	 *
-	 * @return string response XML data
-	 */
-	function getXML()
-	{
-		$sXML = "<?xml version=\"1.0\"";
-		if ($this->sEncoding && strlen(trim($this->sEncoding)) > 0)
-			$sXML .= " encoding=\"".$this->sEncoding."\"";
-		$sXML .= " ?"."><xjx>" . $this->xml . "</xjx>";
-
-		return $sXML;
-	}
-
-	/**
-	 * Adds the commands of the provided response XML output to this response
-	 * object
-	 *
-	 * <i>Usage:</i>
-	 * <code>$r1 = $objResponse1->getXML();
-	 * $objResponse2->loadXML($r1);
-	 * return $objResponse2->getXML();</code>
-	 *
-	 * @param string the response XML (returned from a getXML() method) to add
-	 *               to the end of this response object
-	 */
-	function loadXML($mXML)
-	{
-		if (is_a($mXML, "xajaxResponse")) {
-			$mXML = $mXML->getXML();
-		}
-		$sNewXML = "";
-		$iStartPos = strpos($mXML, "<xjx>") + 5;
-		$sNewXML = substr($mXML, $iStartPos);
-		$iEndPos = strpos($sNewXML, "</xjx>");
-		$sNewXML = substr($sNewXML, 0, $iEndPos);
-		$this->xml .= $sNewXML;
-	}
-
-	/**
-	 * Generates XML from command data
-	 *
-	 * @access private
-	 * @param array associative array of attributes
-	 * @param string data
-	 * @return string XML command
-	 */
-	function _cmdXML($aAttributes, $sData)
-	{
-		if ($this->bOutputEntities) {
-			// An adaptation for the Dokeos LMS, 22-AUG-2009.
-			if (function_exists('api_convert_encoding')) {
-				$sData = call_user_func_array('api_convert_encoding', array(&$sData, 'HTML-ENTITIES', $this->sEncoding));
-			}
-			//if (function_exists('mb_convert_encoding')) {
-			elseif (function_exists('mb_convert_encoding')) {
-			//
-				$sData = call_user_func_array('mb_convert_encoding', array(&$sData, 'HTML-ENTITIES', $this->sEncoding));
-			}
-			else {
-				trigger_error("The xajax XML response output could not be converted to HTML entities because the mb_convert_encoding function is not available", E_USER_NOTICE);
-			}
-		}
-		$xml = "<cmd";
-		foreach($aAttributes as $sAttribute => $sValue)
-			$xml .= " $sAttribute=\"$sValue\"";
-		if ($sData !== null && !stristr($sData,'<![CDATA['))
-			$xml .= "><![CDATA[$sData]]></cmd>";
-		else if ($sData !== null)
-			$xml .= ">$sData</cmd>";
-		else
-			$xml .= "></cmd>";
-
-		return $xml;
-	}
-
-	/**
-	 * Recursively serializes a data structure in XML so it can be sent to
-	 * the client. It could be thought of as the opposite of
-	 * {@link xajax::_parseObjXml()}.
-	 *
-	 * @access private
-	 * @param mixed data structure to serialize to XML
-	 * @return string serialized XML
-	 */
-	function _buildObjXml($var) {
-		if (gettype($var) == "object") $var = get_object_vars($var);
-		if (!is_array($var)) {
-			return "<![CDATA[$var]]>";
-		}
-		else {
-			$data = "<xjxobj>";
-			foreach ($var as $key => $value) {
-				$data .= "<e>";
-				$data .= "<k>" . htmlspecialchars($key) . "</k>";
-				$data .= "<v>" . $this->_buildObjXml($value) . "</v>";
-				$data .= "</e>";
-			}
-			$data .= "</xjxobj>";
-			return $data;
-		}
-	}
+            parse_str($queryPart, $queryParts);
+            $newQueryPart = "";
+            foreach($queryParts as $key => $value)
+            {
+                $newQueryPart .= rawurlencode($key).'='.rawurlencode($value).ini_get('arg_separator.output');
+            }
+            $sURL = str_replace($queryPart, $newQueryPart, $sURL);
+        }
+        $this->addScript('window.location = "'.$sURL.'";');
+    }
+
+    /**
+     * Adds a Javascript command message to the XML response.
+     *
+     * <i>Usage:</i> <kbd>$objResponse->addScript("var x = prompt('get some text');");</kbd>
+     *
+     * @param string contains Javascript code to be executed
+     */
+    function addScript($sJS)
+    {
+        $this->xml .= $this->_cmdXML(array("n"=>"js"),$sJS);
+    }
+
+    /**
+     * Adds a Javascript function call command message to the XML response.
+     *
+     * <i>Usage:</i> <kbd>$objResponse->addScriptCall("myJSFunction", "arg 1", "arg 2", 12345);</kbd>
+     *
+     * @param string $sFunc the name of a Javascript function
+     * @param mixed $args,... optional arguments to pass to the Javascript function
+     */
+    function addScriptCall() {
+        $arguments = func_get_args();
+        $sFunc = array_shift($arguments);
+        $sData = $this->_buildObjXml($arguments);
+        $this->xml .= $this->_cmdXML(array("n"=>"jc","t"=>$sFunc),$sData);
+    }
+
+    /**
+     * Adds a remove element command message to the XML response.
+     *
+     * <i>Usage:</i> <kbd>$objResponse->addRemove("Div2");</kbd>
+     *
+     * @param string contains the id of an HTML element to be removed
+     */
+    function addRemove($sTarget)
+    {
+        $this->xml .= $this->_cmdXML(array("n"=>"rm","t"=>$sTarget),'');
+    }
+
+    /**
+     * Adds a create element command message to the XML response.
+     *
+     * <i>Usage:</i> <kbd>$objResponse->addCreate("parentDiv", "h3", "myid");</kbd>
+     *
+     * @param string contains the id of an HTML element to to which the new
+     *               element will be appended.
+     * @param string the tag to be added
+     * @param string the id to be assigned to the new element
+     * @param string deprecated, use the addCreateInput() method instead
+     */
+    function addCreate($sParent, $sTag, $sId, $sType="")
+    {
+        if ($sType)
+        {
+            trigger_error("The \$sType parameter of addCreate has been deprecated.  Use the addCreateInput() method instead.", E_USER_WARNING);
+            return;
+        }
+        $this->xml .= $this->_cmdXML(array("n"=>"ce","t"=>$sParent,"p"=>$sId),$sTag);
+    }
+
+    /**
+     * Adds a insert element command message to the XML response.
+     *
+     * <i>Usage:</i> <kbd>$objResponse->addInsert("childDiv", "h3", "myid");</kbd>
+     *
+     * @param string contains the id of the child before which the new element
+     *               will be inserted
+     * @param string the tag to be added
+     * @param string the id to be assigned to the new element
+     */
+    function addInsert($sBefore, $sTag, $sId)
+    {
+        $this->xml .= $this->_cmdXML(array("n"=>"ie","t"=>$sBefore,"p"=>$sId),$sTag);
+    }
+
+    /**
+     * Adds a insert element command message to the XML response.
+     *
+     * <i>Usage:</i> <kbd>$objResponse->addInsertAfter("childDiv", "h3", "myid");</kbd>
+     *
+     * @param string contains the id of the child after which the new element
+     *               will be inserted
+     * @param string the tag to be added
+     * @param string the id to be assigned to the new element
+     */
+    function addInsertAfter($sAfter, $sTag, $sId)
+    {
+        $this->xml .= $this->_cmdXML(array("n"=>"ia","t"=>$sAfter,"p"=>$sId),$sTag);
+    }
+
+    /**
+     * Adds a create input command message to the XML response.
+     *
+     * <i>Usage:</i> <kbd>$objResponse->addCreateInput("form1", "text", "username", "input1");</kbd>
+     *
+     * @param string contains the id of an HTML element to which the new input
+     *               will be appended
+     * @param string the type of input to be created (text, radio, checkbox,
+     *               etc.)
+     * @param string the name to be assigned to the new input and the variable
+     *               name when it is submitted
+     * @param string the id to be assigned to the new input
+     */
+    function addCreateInput($sParent, $sType, $sName, $sId)
+    {
+        $this->xml .= $this->_cmdXML(array("n"=>"ci","t"=>$sParent,"p"=>$sId,"c"=>$sType),$sName);
+    }
+
+    /**
+     * Adds an insert input command message to the XML response.
+     *
+     * <i>Usage:</i> <kbd>$objResponse->addInsertInput("input5", "text", "username", "input1");</kbd>
+     *
+     * @param string contains the id of the child before which the new element
+     *               will be inserted
+     * @param string the type of input to be created (text, radio, checkbox,
+     *               etc.)
+     * @param string the name to be assigned to the new input and the variable
+     *               name when it is submitted
+     * @param string the id to be assigned to the new input
+     */
+    function addInsertInput($sBefore, $sType, $sName, $sId)
+    {
+        $this->xml .= $this->_cmdXML(array("n"=>"ii","t"=>$sBefore,"p"=>$sId,"c"=>$sType),$sName);
+    }
+
+    /**
+     * Adds an insert input command message to the XML response.
+     *
+     * <i>Usage:</i> <kbd>$objResponse->addInsertInputAfter("input7", "text", "email", "input2");</kbd>
+     *
+     * @param string contains the id of the child after which the new element
+     *               will be inserted
+     * @param string the type of input to be created (text, radio, checkbox,
+     *               etc.)
+     * @param string the name to be assigned to the new input and the variable
+     *               name when it is submitted
+     * @param string the id to be assigned to the new input
+     */
+    function addInsertInputAfter($sAfter, $sType, $sName, $sId)
+    {
+        $this->xml .= $this->_cmdXML(array("n"=>"iia","t"=>$sAfter,"p"=>$sId,"c"=>$sType),$sName);
+    }
+
+    /**
+     * Adds an event command message to the XML response.
+     *
+     * <i>Usage:</i> <kbd>$objResponse->addEvent("contentDiv", "onclick", "alert(\'Hello World\');");</kbd>
+     *
+     * @param string contains the id of an HTML element
+     * @param string the event you wish to set ("onclick", "onmouseover", etc.)
+     * @param string the Javascript string you want the event to invoke
+     */
+    function addEvent($sTarget,$sEvent,$sScript)
+    {
+        $this->xml .= $this->_cmdXML(array("n"=>"ev","t"=>$sTarget,"p"=>$sEvent),$sScript);
+    }
+
+    /**
+     * Adds a handler command message to the XML response.
+     *
+     * <i>Usage:</i> <kbd>$objResponse->addHandler("contentDiv", "onclick", "content_click");</kbd>
+     *
+     * @param string contains the id of an HTML element
+     * @param string the event you wish to set ("onclick", "onmouseover", etc.)
+     * @param string the name of a Javascript function that will handle the
+     *               event. Multiple handlers can be added for the same event
+     */
+    function addHandler($sTarget,$sEvent,$sHandler)
+    {
+        $this->xml .= $this->_cmdXML(array("n"=>"ah","t"=>$sTarget,"p"=>$sEvent),$sHandler);
+    }
+
+    /**
+     * Adds a remove handler command message to the XML response.
+     *
+     * <i>Usage:</i> <kbd>$objResponse->addRemoveHandler("contentDiv", "onclick", "content_click");</kbd>
+     *
+     * @param string contains the id of an HTML element
+     * @param string the event you wish to remove ("onclick", "onmouseover",
+     *               etc.)
+     * @param string the name of a Javascript handler function that you want to
+     *               remove
+     */
+    function addRemoveHandler($sTarget,$sEvent,$sHandler)
+    {
+        $this->xml .= $this->_cmdXML(array("n"=>"rh","t"=>$sTarget,"p"=>$sEvent),$sHandler);
+    }
+
+    /**
+     * Adds an include script command message to the XML response.
+     *
+     * <i>Usage:</i> <kbd>$objResponse->addIncludeScript("functions.js");</kbd>
+     *
+     * @param string URL of the Javascript file to include
+     */
+    function addIncludeScript($sFileName)
+    {
+        $this->xml .= $this->_cmdXML(array("n"=>"in"),$sFileName);
+    }
+
+    /**
+     * Returns the XML to be returned from your function to the xajax processor
+     * on your page. Since xajax 0.2, you can also return an xajaxResponse
+     * object from your function directly, and xajax will automatically request
+     * the XML using this method call.
+     *
+     * <i>Usage:</i> <kbd>return $objResponse->getXML();</kbd>
+     *
+     * @return string response XML data
+     */
+    function getXML()
+    {
+        $sXML = "<?xml version=\"1.0\"";
+        if ($this->sEncoding && strlen(trim($this->sEncoding)) > 0)
+            $sXML .= " encoding=\"".$this->sEncoding."\"";
+        $sXML .= " ?"."><xjx>" . $this->xml . "</xjx>";
+
+        return $sXML;
+    }
+
+    /**
+     * Adds the commands of the provided response XML output to this response
+     * object
+     *
+     * <i>Usage:</i>
+     * <code>$r1 = $objResponse1->getXML();
+     * $objResponse2->loadXML($r1);
+     * return $objResponse2->getXML();</code>
+     *
+     * @param string the response XML (returned from a getXML() method) to add
+     *               to the end of this response object
+     */
+    function loadXML($mXML)
+    {
+        if (is_a($mXML, "xajaxResponse")) {
+            $mXML = $mXML->getXML();
+        }
+        $sNewXML = "";
+        $iStartPos = strpos($mXML, "<xjx>") + 5;
+        $sNewXML = substr($mXML, $iStartPos);
+        $iEndPos = strpos($sNewXML, "</xjx>");
+        $sNewXML = substr($sNewXML, 0, $iEndPos);
+        $this->xml .= $sNewXML;
+    }
+
+    /**
+     * Generates XML from command data
+     *
+     * @access private
+     * @param array associative array of attributes
+     * @param string data
+     * @return string XML command
+     */
+    function _cmdXML($aAttributes, $sData)
+    {
+        if ($this->bOutputEntities) {
+            // An adaptation for the Dokeos LMS, 22-AUG-2009.
+            if (function_exists('api_convert_encoding')) {
+                $sData = call_user_func_array('api_convert_encoding', array(&$sData, 'HTML-ENTITIES', $this->sEncoding));
+            }
+            //if (function_exists('mb_convert_encoding')) {
+            elseif (function_exists('mb_convert_encoding')) {
+            //
+                $sData = call_user_func_array('mb_convert_encoding', array(&$sData, 'HTML-ENTITIES', $this->sEncoding));
+            }
+            else {
+                trigger_error("The xajax XML response output could not be converted to HTML entities because the mb_convert_encoding function is not available", E_USER_NOTICE);
+            }
+        }
+        $xml = "<cmd";
+        foreach($aAttributes as $sAttribute => $sValue)
+            $xml .= " $sAttribute=\"$sValue\"";
+        if ($sData !== null && !stristr($sData,'<![CDATA['))
+            $xml .= "><![CDATA[$sData]]></cmd>";
+        else if ($sData !== null)
+            $xml .= ">$sData</cmd>";
+        else
+            $xml .= "></cmd>";
+
+        return $xml;
+    }
+
+    /**
+     * Recursively serializes a data structure in XML so it can be sent to
+     * the client. It could be thought of as the opposite of
+     * {@link xajax::_parseObjXml()}.
+     *
+     * @access private
+     * @param mixed data structure to serialize to XML
+     * @return string serialized XML
+     */
+    function _buildObjXml($var) {
+        if (gettype($var) == "object") $var = get_object_vars($var);
+        if (!is_array($var)) {
+            return "<![CDATA[$var]]>";
+        }
+        else {
+            $data = "<xjxobj>";
+            foreach ($var as $key => $value) {
+                $data .= "<e>";
+                $data .= "<k>" . htmlspecialchars($key) . "</k>";
+                $data .= "<v>" . $this->_buildObjXml($value) . "</v>";
+                $data .= "</e>";
+            }
+            $data .= "</xjxobj>";
+            return $data;
+        }
+    }
 
 }// end class xajaxResponse
 ?>

Spacing +37 added lines, -37 removed lines

@@ -99,7 +99,7 @@ 
 	 *                converted to HTML entities
 	 *
 	 */
-	public function __construct($sEncoding=XAJAX_DEFAULT_CHAR_ENCODING, $bOutputEntities=false)
+	public function __construct($sEncoding = XAJAX_DEFAULT_CHAR_ENCODING, $bOutputEntities = false)
 	{
 		$this->setCharEncoding($sEncoding);
 		$this->bOutputEntities = $bOutputEntities;
@@ -148,7 +148,7 @@ 
 	 */
 	function addConfirmCommands($iCmdNumber, $sMessage)
 	{
-		$this->xml .= $this->_cmdXML(array("n"=>"cc","t"=>$iCmdNumber),$sMessage);
+		$this->xml .= $this->_cmdXML(array("n"=>"cc", "t"=>$iCmdNumber), $sMessage);
 	}
 
 	/**
@@ -161,9 +161,9 @@ 
 	 *               "value", etc.)
 	 * @param string the data you want to set the attribute to
 	 */
-	function addAssign($sTarget,$sAttribute,$sData)
+	function addAssign($sTarget, $sAttribute, $sData)
 	{
-		$this->xml .= $this->_cmdXML(array("n"=>"as","t"=>$sTarget,"p"=>$sAttribute),$sData);
+		$this->xml .= $this->_cmdXML(array("n"=>"as", "t"=>$sTarget, "p"=>$sAttribute), $sData);
 	}
 
 	/**
@@ -176,9 +176,9 @@ 
 	 *               "value", etc.)
 	 * @param string the data you want to append to the end of the attribute
 	 */
-	function addAppend($sTarget,$sAttribute,$sData)
+	function addAppend($sTarget, $sAttribute, $sData)
 	{
-		$this->xml .= $this->_cmdXML(array("n"=>"ap","t"=>$sTarget,"p"=>$sAttribute),$sData);
+		$this->xml .= $this->_cmdXML(array("n"=>"ap", "t"=>$sTarget, "p"=>$sAttribute), $sData);
 	}
 
 	/**
@@ -192,9 +192,9 @@ 
 	 * @param string the data you want to prepend to the beginning of the
 	 *               attribute
 	 */
-	function addPrepend($sTarget,$sAttribute,$sData)
+	function addPrepend($sTarget, $sAttribute, $sData)
 	{
-		$this->xml .= $this->_cmdXML(array("n"=>"pp","t"=>$sTarget,"p"=>$sAttribute),$sData);
+		$this->xml .= $this->_cmdXML(array("n"=>"pp", "t"=>$sTarget, "p"=>$sAttribute), $sData);
 	}
 
 	/**
@@ -209,10 +209,10 @@ 
 	 * @param string the string to replace the search string when found in the
 	 *               attribute
 	 */
-	function addReplace($sTarget,$sAttribute,$sSearch,$sData)
+	function addReplace($sTarget, $sAttribute, $sSearch, $sData)
 	{
 		$sDta = "<s><![CDATA[$sSearch]]></s><r><![CDATA[$sData]]></r>";
-		$this->xml .= $this->_cmdXML(array("n"=>"rp","t"=>$sTarget,"p"=>$sAttribute),$sDta);
+		$this->xml .= $this->_cmdXML(array("n"=>"rp", "t"=>$sTarget, "p"=>$sAttribute), $sDta);
 	}
 
 	/**
@@ -224,9 +224,9 @@ 
 	 * @param string the part of the element you wish to clear ("innerHTML",
 	 *               "value", etc.)
 	 */
-	function addClear($sTarget,$sAttribute)
+	function addClear($sTarget, $sAttribute)
 	{
-		$this->addAssign($sTarget,$sAttribute,'');
+		$this->addAssign($sTarget, $sAttribute, '');
 	}
 
 	/**
@@ -238,7 +238,7 @@ 
 	 */
 	function addAlert($sMsg)
 	{
-		$this->xml .= $this->_cmdXML(array("n"=>"al"),$sMsg);
+		$this->xml .= $this->_cmdXML(array("n"=>"al"), $sMsg);
 	}
 
 	/**
@@ -260,11 +260,11 @@ 
 			$queryEnd = strpos($sURL, '#', $queryStart);
 			if ($queryEnd === FALSE)
 				$queryEnd = strlen($sURL);
-			$queryPart = substr($sURL, $queryStart, $queryEnd-$queryStart);
+			$queryPart = substr($sURL, $queryStart, $queryEnd - $queryStart);
             $queryParts = array();
 			parse_str($queryPart, $queryParts);
 			$newQueryPart = "";
-			foreach($queryParts as $key => $value)
+			foreach ($queryParts as $key => $value)
 			{
 				$newQueryPart .= rawurlencode($key).'='.rawurlencode($value).ini_get('arg_separator.output');
 			}
@@ -282,7 +282,7 @@ 
 	 */
 	function addScript($sJS)
 	{
-		$this->xml .= $this->_cmdXML(array("n"=>"js"),$sJS);
+		$this->xml .= $this->_cmdXML(array("n"=>"js"), $sJS);
 	}
 
 	/**
@@ -297,7 +297,7 @@ 
 		$arguments = func_get_args();
 		$sFunc = array_shift($arguments);
 		$sData = $this->_buildObjXml($arguments);
-		$this->xml .= $this->_cmdXML(array("n"=>"jc","t"=>$sFunc),$sData);
+		$this->xml .= $this->_cmdXML(array("n"=>"jc", "t"=>$sFunc), $sData);
 	}
 
 	/**
@@ -309,7 +309,7 @@ 
 	 */
 	function addRemove($sTarget)
 	{
-		$this->xml .= $this->_cmdXML(array("n"=>"rm","t"=>$sTarget),'');
+		$this->xml .= $this->_cmdXML(array("n"=>"rm", "t"=>$sTarget), '');
 	}
 
 	/**
@@ -323,14 +323,14 @@ 
 	 * @param string the id to be assigned to the new element
 	 * @param string deprecated, use the addCreateInput() method instead
 	 */
-	function addCreate($sParent, $sTag, $sId, $sType="")
+	function addCreate($sParent, $sTag, $sId, $sType = "")
 	{
 		if ($sType)
 		{
 			trigger_error("The \$sType parameter of addCreate has been deprecated.  Use the addCreateInput() method instead.", E_USER_WARNING);
 			return;
 		}
-		$this->xml .= $this->_cmdXML(array("n"=>"ce","t"=>$sParent,"p"=>$sId),$sTag);
+		$this->xml .= $this->_cmdXML(array("n"=>"ce", "t"=>$sParent, "p"=>$sId), $sTag);
 	}
 
 	/**
@@ -345,7 +345,7 @@ 
 	 */
 	function addInsert($sBefore, $sTag, $sId)
 	{
-		$this->xml .= $this->_cmdXML(array("n"=>"ie","t"=>$sBefore,"p"=>$sId),$sTag);
+		$this->xml .= $this->_cmdXML(array("n"=>"ie", "t"=>$sBefore, "p"=>$sId), $sTag);
 	}
 
 	/**
@@ -360,7 +360,7 @@ 
 	 */
 	function addInsertAfter($sAfter, $sTag, $sId)
 	{
-		$this->xml .= $this->_cmdXML(array("n"=>"ia","t"=>$sAfter,"p"=>$sId),$sTag);
+		$this->xml .= $this->_cmdXML(array("n"=>"ia", "t"=>$sAfter, "p"=>$sId), $sTag);
 	}
 
 	/**
@@ -378,7 +378,7 @@ 
 	 */
 	function addCreateInput($sParent, $sType, $sName, $sId)
 	{
-		$this->xml .= $this->_cmdXML(array("n"=>"ci","t"=>$sParent,"p"=>$sId,"c"=>$sType),$sName);
+		$this->xml .= $this->_cmdXML(array("n"=>"ci", "t"=>$sParent, "p"=>$sId, "c"=>$sType), $sName);
 	}
 
 	/**
@@ -396,7 +396,7 @@ 
 	 */
 	function addInsertInput($sBefore, $sType, $sName, $sId)
 	{
-		$this->xml .= $this->_cmdXML(array("n"=>"ii","t"=>$sBefore,"p"=>$sId,"c"=>$sType),$sName);
+		$this->xml .= $this->_cmdXML(array("n"=>"ii", "t"=>$sBefore, "p"=>$sId, "c"=>$sType), $sName);
 	}
 
 	/**
@@ -414,7 +414,7 @@ 
 	 */
 	function addInsertInputAfter($sAfter, $sType, $sName, $sId)
 	{
-		$this->xml .= $this->_cmdXML(array("n"=>"iia","t"=>$sAfter,"p"=>$sId,"c"=>$sType),$sName);
+		$this->xml .= $this->_cmdXML(array("n"=>"iia", "t"=>$sAfter, "p"=>$sId, "c"=>$sType), $sName);
 	}
 
 	/**
@@ -426,9 +426,9 @@ 
 	 * @param string the event you wish to set ("onclick", "onmouseover", etc.)
 	 * @param string the Javascript string you want the event to invoke
 	 */
-	function addEvent($sTarget,$sEvent,$sScript)
+	function addEvent($sTarget, $sEvent, $sScript)
 	{
-		$this->xml .= $this->_cmdXML(array("n"=>"ev","t"=>$sTarget,"p"=>$sEvent),$sScript);
+		$this->xml .= $this->_cmdXML(array("n"=>"ev", "t"=>$sTarget, "p"=>$sEvent), $sScript);
 	}
 
 	/**
@@ -441,9 +441,9 @@ 
 	 * @param string the name of a Javascript function that will handle the
 	 *               event. Multiple handlers can be added for the same event
 	 */
-	function addHandler($sTarget,$sEvent,$sHandler)
+	function addHandler($sTarget, $sEvent, $sHandler)
 	{
-		$this->xml .= $this->_cmdXML(array("n"=>"ah","t"=>$sTarget,"p"=>$sEvent),$sHandler);
+		$this->xml .= $this->_cmdXML(array("n"=>"ah", "t"=>$sTarget, "p"=>$sEvent), $sHandler);
 	}
 
 	/**
@@ -457,9 +457,9 @@ 
 	 * @param string the name of a Javascript handler function that you want to
 	 *               remove
 	 */
-	function addRemoveHandler($sTarget,$sEvent,$sHandler)
+	function addRemoveHandler($sTarget, $sEvent, $sHandler)
 	{
-		$this->xml .= $this->_cmdXML(array("n"=>"rh","t"=>$sTarget,"p"=>$sEvent),$sHandler);
+		$this->xml .= $this->_cmdXML(array("n"=>"rh", "t"=>$sTarget, "p"=>$sEvent), $sHandler);
 	}
 
 	/**
@@ -471,7 +471,7 @@ 
 	 */
 	function addIncludeScript($sFileName)
 	{
-		$this->xml .= $this->_cmdXML(array("n"=>"in"),$sFileName);
+		$this->xml .= $this->_cmdXML(array("n"=>"in"), $sFileName);
 	}
 
 	/**
@@ -489,7 +489,7 @@ 
 		$sXML = "<?xml version=\"1.0\"";
 		if ($this->sEncoding && strlen(trim($this->sEncoding)) > 0)
 			$sXML .= " encoding=\"".$this->sEncoding."\"";
-		$sXML .= " ?"."><xjx>" . $this->xml . "</xjx>";
+		$sXML .= " ?"."><xjx>".$this->xml."</xjx>";
 
 		return $sXML;
 	}
@@ -544,9 +544,9 @@ 
 			}
 		}
 		$xml = "<cmd";
-		foreach($aAttributes as $sAttribute => $sValue)
+		foreach ($aAttributes as $sAttribute => $sValue)
 			$xml .= " $sAttribute=\"$sValue\"";
-		if ($sData !== null && !stristr($sData,'<![CDATA['))
+		if ($sData !== null && !stristr($sData, '<![CDATA['))
 			$xml .= "><![CDATA[$sData]]></cmd>";
 		else if ($sData !== null)
 			$xml .= ">$sData</cmd>";
@@ -574,8 +574,8 @@ 
 			$data = "<xjxobj>";
 			foreach ($var as $key => $value) {
 				$data .= "<e>";
-				$data .= "<k>" . htmlspecialchars($key) . "</k>";
-				$data .= "<v>" . $this->_buildObjXml($value) . "</v>";
+				$data .= "<k>".htmlspecialchars($key)."</k>";
+				$data .= "<v>".$this->_buildObjXml($value)."</v>";
 				$data .= "</e>";
 			}
 			$data .= "</xjxobj>";

main/inc/lib/zombie/zombie_report.class.php

Doc Comments +3 added lines

@@ -121,6 +121,9 @@
         return $form->isSubmitted() == false || $form->validate();
     }
 
+    /**
+     * @param string $format
+     */
     function get_ceiling($format = null)
     {
         $result = Request::get('ceiling');

Spacing +2 added lines, -2 removed lines

@@ -167,7 +167,7 @@ 
         }
 
         $action = $this->get_action();
-        $f = array($this, 'action_' . $action);
+        $f = array($this, 'action_'.$action);
         if (is_callable($f)) {
             return call_user_func($f, $ids);
         }
@@ -292,7 +292,7 @@ 
             $text = get_lang('No');
         }
 
-        $result = Display::return_icon($image . '.png', $text);
+        $result = Display::return_icon($image.'.png', $text);
         return $result;
     }
 

main/install/install.lib.php

Doc Comments +14 added lines, -5 removed lines

@@ -97,7 +97,7 @@ 
  * This function return the value of a php.ini setting if not "" or if exists,
  * otherwise return false
  * @param   string  $phpSetting The name of a PHP setting
- * @return  mixed   The value of the setting, or false if not found
+ * @return  string|false   The value of the setting, or false if not found
  */
 function checkPhpSettingExists($phpSetting)
 {
@@ -1268,6 +1268,10 @@ 
  * @param   string  Extra notice (to show on the right side)
  * @param   boolean Whether to display in update mode
  * @param   string  Additional attribute for the <tr> element
+ * @param string $installType
+ * @param string $parameterName
+ * @param string $formFieldName
+ * @param string $extra_notice
  * @return  void    Direct output
  */
 function displayDatabaseParameter(
@@ -1481,6 +1485,11 @@ 
 
     <?php
 }
+/**
+ * @param string $content
+ * @param string $title
+ * @param string $id
+ */
 function panel($content = null, $title = null, $id = null, $style = null) {
     $html = '';
     if (empty($style)) {
@@ -1837,8 +1846,8 @@ 
 }
 
 /**
- * @param $current_value
- * @param $wanted_value
+ * @param string $current_value
+ * @param string $wanted_value
  * @return string
  */
 function compare_setting_values($current_value, $wanted_value)
@@ -1855,8 +1864,8 @@ 
 }
 
 /**
- * @param $course_dir
- * @param $course_attempt_name
+ * @param string $course_dir
+ * @param string $course_attempt_name
  * @param string $file
  * @return bool
  */

Spacing +56 added lines, -56 removed lines

@@ -396,7 +396,7 @@ 
     if (!is_array($result)) {
         $result = array();
         $exceptions = array('.', '..', 'CVS', '.svn');
-        $search       = array('_latin',   '_unicode',   '_corporate',   '_org'  , '_KM',   '_');
+        $search       = array('_latin', '_unicode', '_corporate', '_org', '_KM', '_');
         $replace_with = array(' (Latin)', ' (unicode)', ' (corporate)', ' (org)', ' (KM)', ' ');
         $dirname = api_get_path(SYS_LANG_PATH);
         $handle = opendir($dirname);
@@ -430,9 +430,9 @@ 
     if ($handle = opendir($directory)) {
         while (false !== ($file = readdir($handle))) {
             if ($file != "." && $file != "..") {
-                if (is_dir($directory. "/" . $file)) {
-                    $array_items = array_merge($array_items, my_directory_to_array($directory. '/' . $file));
-                    $file = $directory . "/" . $file;
+                if (is_dir($directory."/".$file)) {
+                    $array_items = array_merge($array_items, my_directory_to_array($directory.'/'.$file));
+                    $file = $directory."/".$file;
                     $array_items[] = preg_replace("/\/\//si", '/', $file);
                 }
             }
@@ -636,7 +636,7 @@ 
     <h2><?php get_lang('WelcomeToTheChamiloInstaller'); ?></h2>
     <div class="RequirementHeading">
         <h2><?php echo display_step_sequence(); ?>
-            <?php echo get_lang('InstallationLanguage');?>
+            <?php echo get_lang('InstallationLanguage'); ?>
         </h2>
         <p><?php echo get_lang('PleaseSelectInstallationProcessLanguage'); ?>:</p>
         <form id="lang_form" method="post" action="<?php echo api_get_self(); ?>">
@@ -709,7 +709,7 @@ 
     if (phpversion() < REQUIRED_PHP_VERSION) {
         echo '<strong><font color="red">'.get_lang('PHPVersionError').'</font></strong>';
     } else {
-        echo '<strong><font color="green">'.get_lang('PHPVersionOK'). ' '.phpversion().'</font></strong>';
+        echo '<strong><font color="green">'.get_lang('PHPVersionOK').' '.phpversion().'</font></strong>';
     }
     echo '</td>
             </tr>
@@ -881,7 +881,7 @@ 
             if ($file_course_test_was_created == true) {
                 break;
             }
-            $r = @touch($course_dir.'/test.php',$perm);
+            $r = @touch($course_dir.'/test.php', $perm);
             if ($r === true) {
                 $fil_perm_verified = $perm;
                 if (check_course_script_interpretation($course_dir, $course_attempt_name, 'test.php')) {
@@ -1137,7 +1137,7 @@ 
 function get_contact_registration_form()
 {
 
-    $html ='
+    $html = '
    <form class="form-horizontal">
     <div class="panel panel-default">
     <div class="panel-body">
@@ -1234,7 +1234,7 @@ 
             <div class="col-sm-9">
                 <div class="radio">
                     <label>
-                        <input type="radio" name="financial_decision" id="financial_decision1" value="1" checked /> ' . get_lang('Yes') . '
+                        <input type="radio" name="financial_decision" id="financial_decision1" value="1" checked /> ' . get_lang('Yes').'
                     </label>
                 </div>
                 <div class="radio">
@@ -1293,8 +1293,8 @@ 
             echo '<input type="hidden" name="'.$formFieldName.'" id="'.$formFieldName.'" value="'.api_htmlentities($parameterValue).'" />';
             echo api_htmlentities($parameterValue);
         } else {
-            echo '<div class="col-sm-5"><input type="' . $inputType . '" class="form-control" size="' . DATABASE_FORM_FIELD_DISPLAY_LENGTH . '" maxlength="' . $maxLength . '" name="' . $formFieldName . '" id="' . $formFieldName . '" value="' . api_htmlentities($parameterValue) . '" />' . "</div>";
-            echo '<div class="col-sm-3">' . $extra_notice . '</div>';
+            echo '<div class="col-sm-5"><input type="'.$inputType.'" class="form-control" size="'.DATABASE_FORM_FIELD_DISPLAY_LENGTH.'" maxlength="'.$maxLength.'" name="'.$formFieldName.'" id="'.$formFieldName.'" value="'.api_htmlentities($parameterValue).'" />'."</div>";
+            echo '<div class="col-sm-3">'.$extra_notice.'</div>';
         }
 
     }
@@ -1330,12 +1330,12 @@ 
         $dbNameForm = $_configuration['main_database'];
         $dbPortForm = isset($_configuration['db_port']) ? $_configuration['db_port'] : '';
 
-        echo '<div class="RequirementHeading"><h2>' . display_step_sequence() .get_lang('DBSetting') . '</h2></div>';
+        echo '<div class="RequirementHeading"><h2>'.display_step_sequence().get_lang('DBSetting').'</h2></div>';
         echo '<div class="RequirementContent">';
         echo get_lang('DBSettingUpgradeIntro');
         echo '</div>';
     } else {
-        echo '<div class="RequirementHeading"><h2>' . display_step_sequence() .get_lang('DBSetting') . '</h2></div>';
+        echo '<div class="RequirementHeading"><h2>'.display_step_sequence().get_lang('DBSetting').'</h2></div>';
         echo '<div class="RequirementContent">';
         echo get_lang('DBSettingIntro');
         echo '</div>';
@@ -1345,12 +1345,12 @@ 
         <div class="panel-body">
         <div class="form-group">
             <label class="col-sm-4"><?php echo get_lang('DBHost'); ?> </label>
-            <?php if ($installType == 'update'){ ?>
+            <?php if ($installType == 'update') { ?>
             <div class="col-sm-5">
                 <input type="hidden" name="dbHostForm" value="<?php echo htmlentities($dbHostForm); ?>" /><?php echo $dbHostForm; ?>
             </div>
             <div class="col-sm-3"></div>
-            <?php }else{ ?>
+            <?php } else { ?>
             <div class="col-sm-5">
                 <input type="text" class="form-control" size="25" maxlength="50" name="dbHostForm" value="<?php echo htmlentities($dbHostForm); ?>" />
             </div>
@@ -1359,12 +1359,12 @@ 
         </div>
         <div class="form-group">
             <label class="col-sm-4"><?php echo get_lang('DBPort'); ?> </label>
-            <?php if ($installType == 'update'){ ?>
+            <?php if ($installType == 'update') { ?>
             <div class="col-sm-5">
                 <input type="hidden" name="dbPortForm" value="<?php echo htmlentities($dbPortForm); ?>" /><?php echo $dbPortForm; ?>
             </div>
             <div class="col-sm-3"></div>
-            <?php }else{ ?>
+            <?php } else { ?>
             <div class="col-sm-5">
                 <input type="text" class="form-control" size="25" maxlength="50" name="dbPortForm" value="<?php echo htmlentities($dbPortForm); ?>" />
             </div>
@@ -1390,7 +1390,7 @@ 
             <?php
             //Database Name fix replace weird chars
             if ($installType != INSTALL_TYPE_UPDATE) {
-                $dbNameForm = str_replace(array('-','*', '$', ' ', '.'), '', $dbNameForm);
+                $dbNameForm = str_replace(array('-', '*', '$', ' ', '.'), '', $dbNameForm);
             }
 
             displayDatabaseParameter(
@@ -1489,7 +1489,7 @@ 
     if (!empty($title)) {
         $panelTitle = Display::div($title, array('class' => 'panel-heading'));
         $panelBody = Display::div($content, array('class' => 'panel-body'));
-        $panelParent = Display::div($panelTitle . $panelBody, array('id' => $id, 'class' => 'panel panel-'.$style));
+        $panelParent = Display::div($panelTitle.$panelBody, array('id' => $id, 'class' => 'panel panel-'.$style));
     } else {
         $panelBody = Display::div($html, array('class' => 'panel-body'));
         $panelParent = Display::div($panelBody, array('id' => $id, 'class' => 'panel panel-'.$style));
@@ -1514,9 +1514,9 @@ 
     $displayWhenUpdate = 'true'
 ) {
     $html = '<div class="form-group">';
-    $html .= '<label class="col-sm-6 control-label">' . $parameterName . '</label>';
+    $html .= '<label class="col-sm-6 control-label">'.$parameterName.'</label>';
     if ($installType == INSTALL_TYPE_UPDATE && $displayWhenUpdate) {
-        $html .= '<input type="hidden" name="' . $formFieldName . '" value="'. api_htmlentities($parameterValue, ENT_QUOTES). '" />' . $parameterValue;
+        $html .= '<input type="hidden" name="'.$formFieldName.'" value="'.api_htmlentities($parameterValue, ENT_QUOTES).'" />'.$parameterValue;
     } else {
         $html .= '<div class="col-sm-6"><input class="form-control" type="text" size="'.FORM_FIELD_DISPLAY_LENGTH.'" maxlength="'.MAX_FORM_FIELD_LENGTH.'" name="'.$formFieldName.'" value="'.api_htmlentities($parameterValue, ENT_QUOTES).'" />'."</div>";
     }
@@ -1563,7 +1563,7 @@ 
         $languageForm = $_SESSION['install_language'];
     }
     echo '<div class="RequirementHeading">';
-    echo "<h2>" . display_step_sequence() . get_lang("CfgSetting") . "</h2>";
+    echo "<h2>".display_step_sequence().get_lang("CfgSetting")."</h2>";
     echo '</div>';
 
     echo '<p>'.get_lang('ConfigSettingsInfo').' <strong>app/config/configuration.php</strong></p>';
@@ -1581,14 +1581,14 @@ 
 
     // Parameters 3 and 4: administrator's names
 
-    $html .=  display_configuration_parameter($installType, get_lang('AdminFirstName'), 'adminFirstName', $adminFirstName);
-    $html .=  display_configuration_parameter($installType, get_lang('AdminLastName'), 'adminLastName', $adminLastName);
+    $html .= display_configuration_parameter($installType, get_lang('AdminFirstName'), 'adminFirstName', $adminFirstName);
+    $html .= display_configuration_parameter($installType, get_lang('AdminLastName'), 'adminLastName', $adminLastName);
 
     //Parameter 3: administrator's email
-    $html .=  display_configuration_parameter($installType, get_lang('AdminEmail'), 'emailForm', $emailForm);
+    $html .= display_configuration_parameter($installType, get_lang('AdminEmail'), 'emailForm', $emailForm);
 
     //Parameter 6: administrator's telephone
-    $html .=  display_configuration_parameter($installType, get_lang('AdminPhone'), 'adminPhoneForm', $adminPhoneForm);
+    $html .= display_configuration_parameter($installType, get_lang('AdminPhone'), 'adminPhoneForm', $adminPhoneForm);
 
 
     echo panel($html, get_lang('Administrator'), 'administrator');
@@ -1607,12 +1607,12 @@ 
         $html .= display_language_selection_box('languageForm', $languageForm);
         $html .= '</div>';
     }
-    $html.= "</div>";
+    $html .= "</div>";
 
 
     //Second parameter: Chamilo URL
     $html .= '<div class="form-group">';
-    $html .= '<label class="col-sm-6 control-label">'.get_lang('ChamiloURL') .get_lang('ThisFieldIsRequired').'</label>';
+    $html .= '<label class="col-sm-6 control-label">'.get_lang('ChamiloURL').get_lang('ThisFieldIsRequired').'</label>';
 
 
 
@@ -1636,34 +1636,34 @@ 
 
 
     $html .= '<div class="form-group">
-            <label class="col-sm-6 control-label">' . get_lang("EncryptMethodUserPass") . '</label>
+            <label class="col-sm-6 control-label">' . get_lang("EncryptMethodUserPass").'</label>
         <div class="col-sm-6">';
     if ($installType == 'update') {
-        $html .= '<input type="hidden" name="encryptPassForm" value="'. $encryptPassForm .'" />'. $encryptPassForm;
+        $html .= '<input type="hidden" name="encryptPassForm" value="'.$encryptPassForm.'" />'.$encryptPassForm;
     } else {
 
         $html .= '<div class="checkbox">
                     <label>
-                        <input  type="radio" name="encryptPassForm" value="bcrypt" id="encryptPass1" '. ($encryptPassForm == 'bcrypt' ? 'checked="checked" ':'') .'/> bcrypt
+                        <input  type="radio" name="encryptPassForm" value="bcrypt" id="encryptPass1" '. ($encryptPassForm == 'bcrypt' ? 'checked="checked" ' : '').'/> bcrypt
                     </label>';
 
         $html .= '<label>
-                        <input  type="radio" name="encryptPassForm" value="sha1" id="encryptPass1" '. ($encryptPassForm == 'sha1' ? 'checked="checked" ':'') .'/> sha1
+                        <input  type="radio" name="encryptPassForm" value="sha1" id="encryptPass1" '. ($encryptPassForm == 'sha1' ? 'checked="checked" ' : '').'/> sha1
                     </label>';
 
         $html .= '<label>
-                        <input type="radio" name="encryptPassForm" value="md5" id="encryptPass0" '. ($encryptPassForm == 'md5' ? 'checked="checked" ':'') .'/> md5
+                        <input type="radio" name="encryptPassForm" value="md5" id="encryptPass0" '. ($encryptPassForm == 'md5' ? 'checked="checked" ' : '').'/> md5
                     </label>';
 
         $html .= '<label>
-                        <input type="radio" name="encryptPassForm" value="none" id="encryptPass2" '. ($encryptPassForm == 'none' ? 'checked="checked" ':'') .'/>'. get_lang('None').'
+                        <input type="radio" name="encryptPassForm" value="none" id="encryptPass2" '. ($encryptPassForm == 'none' ? 'checked="checked" ' : '').'/>'.get_lang('None').'
                     </label>';
         $html .= '</div>';
     }
     $html .= '</div></div>';
 
     $html .= '<div class="form-group">
-            <label class="col-sm-6 control-label">' . get_lang('AllowSelfReg') . '</label>
+            <label class="col-sm-6 control-label">' . get_lang('AllowSelfReg').'</label>
             <div class="col-sm-6">';
     if ($installType == 'update') {
         if ($allowSelfReg == 'true') {
@@ -1673,17 +1673,17 @@ 
         } else {
             $label = get_lang('AfterApproval');
         }
-        $html .= '<input type="hidden" name="allowSelfReg" value="'. $allowSelfReg .'" />'. $label;
+        $html .= '<input type="hidden" name="allowSelfReg" value="'.$allowSelfReg.'" />'.$label;
     } else {
         $html .= '<div class="control-group">';
         $html .= '<label class="checkbox-inline">
-                        <input type="radio" name="allowSelfReg" value="1" id="allowSelfReg1" '. ($allowSelfReg == 'true' ? 'checked="checked" ' : '') . ' /> '. get_lang('Yes') .'
+                        <input type="radio" name="allowSelfReg" value="1" id="allowSelfReg1" '. ($allowSelfReg == 'true' ? 'checked="checked" ' : '').' /> '.get_lang('Yes').'
                     </label>';
         $html .= '<label class="checkbox-inline">
-                        <input type="radio" name="allowSelfReg" value="0" id="allowSelfReg0" '. ($allowSelfReg == 'false' ? '' : 'checked="checked" ') .' /> '. get_lang('No') .'
+                        <input type="radio" name="allowSelfReg" value="0" id="allowSelfReg0" '. ($allowSelfReg == 'false' ? '' : 'checked="checked" ').' /> '.get_lang('No').'
                     </label>';
          $html .= '<label class="checkbox-inline">
-                    <input type="radio" name="allowSelfReg" value="0" id="allowSelfReg0" '. ($allowSelfReg == 'approval' ? '' : 'checked="checked" ') .' /> '. get_lang('AfterApproval') .'
+                    <input type="radio" name="allowSelfReg" value="0" id="allowSelfReg0" '. ($allowSelfReg == 'approval' ? '' : 'checked="checked" ').' /> '.get_lang('AfterApproval').'
                 </label>';
         $html .= '</div>';
     }
@@ -1691,7 +1691,7 @@ 
     $html .= '</div>';
 
     $html .= '<div class="form-group">';
-    $html .= '<label class="col-sm-6 control-label">'. get_lang('AllowSelfRegProf') .'</label>
+    $html .= '<label class="col-sm-6 control-label">'.get_lang('AllowSelfRegProf').'</label>
         <div class="col-sm-6">';
     if ($installType == 'update') {
         if ($allowSelfRegProf == 'true') {
@@ -1699,16 +1699,16 @@ 
         } else {
             $label = get_lang('No');
         }
-        $html .= '<input type="hidden" name="allowSelfRegProf" value="'. $allowSelfRegProf.'" />'. $label;
+        $html .= '<input type="hidden" name="allowSelfRegProf" value="'.$allowSelfRegProf.'" />'.$label;
     } else {
         $html .= '<div class="control-group">
                 <label class="checkbox-inline">
-                    <input type="radio" name="allowSelfRegProf" value="1" id="allowSelfRegProf1" '. ($allowSelfRegProf ? 'checked="checked" ' : '') .'/>
-                ' . get_lang('Yes') .'
+                    <input type="radio" name="allowSelfRegProf" value="1" id="allowSelfRegProf1" '. ($allowSelfRegProf ? 'checked="checked" ' : '').'/>
+                ' . get_lang('Yes').'
                 </label>';
         $html .= '<label class="checkbox-inline">
-                    <input type="radio" name="allowSelfRegProf" value="0" id="allowSelfRegProf0" '. ($allowSelfRegProf ? '' : 'checked="checked" ') .' />
-                   '. get_lang('No') .'
+                    <input type="radio" name="allowSelfRegProf" value="0" id="allowSelfRegProf0" '. ($allowSelfRegProf ? '' : 'checked="checked" ').' />
+                   '. get_lang('No').'
                 </label>';
         $html .= '</div>';
     }
@@ -1773,7 +1773,7 @@ 
         "Macedonia", "Madagascar", "Malawi", "Malaysia", "Maldives", "Mali", "Malta", "Marshall Islands", "Mauritania", "Mauritius", "Mexico", "Micronesia", "Moldova", "Monaco", "Mongolia", "Morocco", "Mozambique", "Myanmar",
         "Namibia", "Nauru", "Nepa", "Netherlands", "New Zealand", "Nicaragua", "Niger", "Nigeria", "Norway",
         "Oman",
-        "Pakistan", "Palau", "Panama", "Papua New Guinea", "Paraguay", "Peru", "Philippines", "Poland","Portugal",
+        "Pakistan", "Palau", "Panama", "Papua New Guinea", "Paraguay", "Peru", "Philippines", "Poland", "Portugal",
         "Qatar",
         "Romania", "Russia", "Rwanda",
         "Saint Kitts and Nevis", "Saint Lucia", "Saint Vincent", "Samoa", "San Marino", "Sao Tome and Principe", "Saudi Arabia", "Senegal", "Serbia and Montenegro", "Seychelles", "Sierra Leone", "Singapore", "Slovakia", "Slovenia", "Solomon Islands", "Somalia", "South Africa", "Spain", "Sri Lanka", "Sudan", "Suriname", "Swaziland", "Sweden", "Switzerland", "Syria",
@@ -1820,11 +1820,11 @@ 
     $permissions_for_new_directories = isset($_SESSION['permissions_for_new_directories']) ? $_SESSION['permissions_for_new_directories'] : 0770;
     $permissions_for_new_files = isset($_SESSION['permissions_for_new_files']) ? $_SESSION['permissions_for_new_files'] : 0660;
     // use decoct() to store as string
-    $sql = "UPDATE $table SET selected_value = '0" . decoct($permissions_for_new_directories) . "'
+    $sql = "UPDATE $table SET selected_value = '0".decoct($permissions_for_new_directories)."'
               WHERE variable  = 'permissions_for_new_directories'";
     Database::query($sql);
 
-    $sql = "UPDATE $table SET selected_value = '0" . decoct($permissions_for_new_files) . "' WHERE variable  = 'permissions_for_new_files'";
+    $sql = "UPDATE $table SET selected_value = '0".decoct($permissions_for_new_files)."' WHERE variable  = 'permissions_for_new_files'";
     Database::query($sql);
 
     if (isset($_SESSION['permissions_for_new_directories'])) {
@@ -1844,8 +1844,8 @@ 
 function compare_setting_values($current_value, $wanted_value)
 {
     $current_value_string = $current_value;
-    $current_value = (float)$current_value;
-    $wanted_value = (float)$wanted_value;
+    $current_value = (float) $current_value;
+    $wanted_value = (float) $wanted_value;
 
     if ($current_value >= $wanted_value) {
         return Display::label($current_value_string, 'success');
@@ -1896,7 +1896,7 @@ 
 
                     fwrite($fp, $out);
                     while (!feof($fp)) {
-                        $result = str_replace("\r\n", '',fgets($fp, 128));
+                        $result = str_replace("\r\n", '', fgets($fp, 128));
                         if (!empty($result) && $result == '123') {
                             $output = true;
                         }
@@ -1919,7 +1919,7 @@ 
                     curl_setopt($ch, CURLOPT_URL, $url);
                     //curl_setopt($ch, CURLOPT_TIMEOUT, 30);
                     curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
-                    $result = curl_exec ($ch);
+                    $result = curl_exec($ch);
                     if (!empty($result) && $result == '123') {
                         $output = true;
                     }
@@ -2679,12 +2679,12 @@ 
         $adminPhoneForm,
         '', //$picture_uri = '',
         PLATFORM_AUTH_SOURCE,
-        '',//$expirationDate,
+        '', //$expirationDate,
         1,
         0,
         null,
         '',
-        false,  //$send_mail = false,
+        false, //$send_mail = false,
         true //$isAdmin = false
     );
 
@@ -2706,7 +2706,7 @@ 
         0,
         null,
         '',
-        false,  //$send_mail = false,
+        false, //$send_mail = false,
         false //$isAdmin = false
     );
 
@@ -2772,7 +2772,7 @@ 
                 SET selected_value = '".$param->selected_value."'
                 WHERE variable = '".$param->variable."'";
         if (!empty($param->subkey)) {
-            $sql .= " AND subkey='" . $param->subkey . "'";
+            $sql .= " AND subkey='".$param->subkey."'";
         }
         Database::query($sql);
     }

Indentation +2 added lines, -2 removed lines

@@ -1682,7 +1682,7 @@ 
         $html .= '<label class="checkbox-inline">
                         <input type="radio" name="allowSelfReg" value="0" id="allowSelfReg0" '. ($allowSelfReg == 'false' ? '' : 'checked="checked" ') .' /> '. get_lang('No') .'
                     </label>';
-         $html .= '<label class="checkbox-inline">
+            $html .= '<label class="checkbox-inline">
                     <input type="radio" name="allowSelfReg" value="0" id="allowSelfReg0" '. ($allowSelfReg == 'approval' ? '' : 'checked="checked" ') .' /> '. get_lang('AfterApproval') .'
                 </label>';
         $html .= '</div>';
@@ -1716,7 +1716,7 @@ 
     </div>';
 
     echo panel($html, get_lang('Platform'), 'platform');
- ?>
+    ?>
     <div class='form-group'>
         <div class="col-sm-6">
             <button type="submit" class="btn btn-default pull-right" name="step3" value="&lt; <?php echo get_lang('Previous'); ?>" ><em class="fa fa-backward"> </em> <?php echo get_lang('Previous'); ?></button>

Braces +15 added lines, -8 removed lines

@@ -973,8 +973,7 @@ 
                 <?php echo get_lang('Error'); ?>!<br />
                 Chamilo <?php echo implode('|', $update_from_version_8).' '.get_lang('HasNotBeenFoundInThatDir'); ?>.
             </div>
-        <?php }
-        else {
+        <?php } else {
             echo '<br />';
         }
         ?>
@@ -1060,14 +1059,19 @@ 
         <button type="submit" name="step1" class="btn btn-default" onclick="javascript: window.location='index.php'; return false;" value="<?php echo get_lang('Previous'); ?>" >
             <em class="fa fa-backward"> </em> <?php echo get_lang('Previous'); ?>
         </button>
-        <button type="submit" name="step2_install" class="btn btn-success" value="<?php echo get_lang("NewInstallation"); ?>" <?php if ($error) echo 'disabled="disabled"'; ?> >
+        <button type="submit" name="step2_install" class="btn btn-success" value="<?php echo get_lang("NewInstallation"); ?>" <?php if ($error) {
+    echo 'disabled="disabled"';
+}
+?> >
             <em class="fa fa-forward"> </em> <?php echo get_lang('NewInstallation'); ?>
         </button>
         <input type="hidden" name="is_executable" id="is_executable" value="-" />
         <?php
         // Real code
         echo '<button type="submit" class="btn btn-default" name="step2_update_8" value="Upgrade from Chamilo 1.9.x"';
-        if ($error) echo ' disabled="disabled"';
+        if ($error) {
+            echo ' disabled="disabled"';
+        }
         echo ' ><em class="fa fa-forward"> </em> '.get_lang('UpgradeFromLMS19x').'</button>';
 
         echo '</p>';
@@ -1350,7 +1354,7 @@ 
                 <input type="hidden" name="dbHostForm" value="<?php echo htmlentities($dbHostForm); ?>" /><?php echo $dbHostForm; ?>
             </div>
             <div class="col-sm-3"></div>
-            <?php }else{ ?>
+            <?php } else{ ?>
             <div class="col-sm-5">
                 <input type="text" class="form-control" size="25" maxlength="50" name="dbHostForm" value="<?php echo htmlentities($dbHostForm); ?>" />
             </div>
@@ -1364,7 +1368,7 @@ 
                 <input type="hidden" name="dbPortForm" value="<?php echo htmlentities($dbPortForm); ?>" /><?php echo $dbPortForm; ?>
             </div>
             <div class="col-sm-3"></div>
-            <?php }else{ ?>
+            <?php } else{ ?>
             <div class="col-sm-5">
                 <input type="text" class="form-control" size="25" maxlength="50" name="dbPortForm" value="<?php echo htmlentities($dbPortForm); ?>" />
             </div>
@@ -1446,9 +1450,12 @@ 
             Database port: <strong><?php echo $manager->getConnection()->getPort(); ?></strong><br/>
             Database driver: <strong><?php echo $manager->getConnection()->getDriver()->getName(); ?></strong><br/>
         </div>
-    <?php else: ?>
+    <?php else {
+    : ?>
         <div id="db_status" class="alert alert-danger">
-            <p><?php echo get_lang('FailedConectionDatabase'); ?></strong></p>
+            <p><?php echo get_lang('FailedConectionDatabase');
+}
+?></strong></p>
             <code><?php echo $database_exists_text ?></code>
         </div>
     <?php endif; ?>

main/newscorm/aicc.class.php

Doc Comments +5 added lines, -3 removed lines

@@ -216,7 +216,7 @@ 
     /**
      * Import the aicc object (as a result from the parse_config_files function) into the database structure
      * @param	string	$course_code
-     * @return	bool	Returns -1 on error
+     * @return	false|null	Returns -1 on error
      */
     public function import_aicc($course_code)
     {
@@ -780,7 +780,8 @@ 
      * Static function to parse AICC ini files.
      * Based on work by sinedeo at gmail dot com published on php.net (parse_ini_file()).
      * @param	string	File path
-     * @return	array	Structured array
+     * @param string $f
+     * @return	string	Structured array
      */
     function parse_ini_file_quotes_safe($f) {
         $null = '';
@@ -831,7 +832,7 @@ 
      * Based on work by sinedeo at gmail dot com published on php.net (parse_ini_file()).
      * @param		string	INI File string
      * @param		array	List of names of sections that should be considered as containing only hard string data (no variables), provided in lower case
-     * @return	array	Structured array
+     * @return	string	Structured array
      */
     function parse_ini_string_quotes_safe($s, $pure_strings = array()) {
         $null = '';
@@ -894,6 +895,7 @@ 
      * @param	string	CSV delimiter
      * @param	string	CSV enclosure
      * @param	boolean	Might one field name happen more than once on the same line? (then split by comma in the values)
+     * @param string $f
      * @return array	Simple structured array
      */
     function parse_csv_file($f, $delim = ',', $enclosure = '"', $multiples = false) {

Indentation +7 added lines, -7 removed lines

@@ -320,12 +320,12 @@ 
         }
     }
 
-     /**
-     * Intermediate to import_package only to allow import from local zip files
-     * @param	string	Path to the zip file, from the dokeos sys root
-     * @param	string	Current path (optional)
-     * @return string	Absolute path to the AICC description files or empty string on error
-     */
+        /**
+         * Intermediate to import_package only to allow import from local zip files
+         * @param	string	Path to the zip file, from the dokeos sys root
+         * @param	string	Current path (optional)
+         * @return string	Absolute path to the AICC description files or empty string on error
+         */
     function import_local_package($file_path, $current_dir = '')
     {
         // TODO: Prepare info as given by the $_FILES[''] vector.
@@ -355,7 +355,7 @@ 
         $current_dir = api_replace_dangerous_char(trim($current_dir)); // Current dir we are in, inside scorm/
         if ($this->debug > 0) { error_log('New LP - aicc::import_package() - Current_dir = '.$current_dir, 0); }
 
-         //$uploaded_filename = $_FILES['userFile']['name'];
+            //$uploaded_filename = $_FILES['userFile']['name'];
         // Get the name of the zip file without the extension.
         if ($this->debug > 0) { error_log('New LP - aicc::import_package() - Received zip file name: '.$zip_file_path, 0); }
         $file_info = pathinfo($zip_file_name);

Spacing +27 added lines, -27 removed lines

@@ -12,7 +12,7 @@ 
 class aicc extends learnpath
 {
     public $config = array();
-    public $config_basename = '';	// The configuration files might be multiple and might have
+    public $config_basename = ''; // The configuration files might be multiple and might have
                                     // funny names. We need to keep the name of that file while we
                                     // install the content.
     public $config_files = array();
@@ -32,9 +32,9 @@ 
     public $cstlist = array();
     public $orelist = array();
 
-    public $subdir = '';	// Path between the scorm/ directory and the config files e.g. maritime_nav/maritime_nav. This is the path that will be used in the lp_path when importing a package.
-    public $zipname = '';	// Keeps the zipfile safe for the object's life so that we can use it if there is no title available.
-    public $lastzipnameindex = 0;	// Keeps an index of the number of uses of the zipname so far.
+    public $subdir = ''; // Path between the scorm/ directory and the config files e.g. maritime_nav/maritime_nav. This is the path that will be used in the lp_path when importing a package.
+    public $zipname = ''; // Keeps the zipfile safe for the object's life so that we can use it if there is no title available.
+    public $lastzipnameindex = 0; // Keeps an index of the number of uses of the zipname so far.
     public $config_encoding = 'ISO-8859-1';
     public $debug = 0;
 
@@ -132,7 +132,7 @@ 
             //echo '<pre>des:'.print_r($des_params, true).'</pre>';
             if ($this->debug > 1) { error_log('New LP - In aicc::parse_config_files() - '.$des_file.' has been parsed', 0); }
             // Distribute des params into the aicc object.
-            foreach ($des_params as $des){
+            foreach ($des_params as $des) {
                 // One AU in AICC is equivalent to one SCO in SCORM (scormItem class).
                 $oDes = new aiccResource('config', $des);
                 $this->deslist[$oDes->identifier] = $oDes;
@@ -242,12 +242,12 @@ 
 
         $this->config_encoding = "ISO-8859-1"; // TODO: We may apply detection for this value, see the function api_detect_encoding().
 
-        $sql = "INSERT INTO $new_lp (c_id, lp_type, name, ref, description, path, force_commit, default_view_mod, default_encoding, js_lib, content_maker,display_order)" .
-                "VALUES " .
-                "($course_id, 3, '".$this->course_title."', '".$this->course_id."','".$this->course_description."'," .
-                "'".$this->subdir."', 0, 'embedded', '".$this->config_encoding."'," .
+        $sql = "INSERT INTO $new_lp (c_id, lp_type, name, ref, description, path, force_commit, default_view_mod, default_encoding, js_lib, content_maker,display_order)".
+                "VALUES ".
+                "($course_id, 3, '".$this->course_title."', '".$this->course_id."','".$this->course_description."',".
+                "'".$this->subdir."', 0, 'embedded', '".$this->config_encoding."',".
                 "'aicc_api.php','".$this->course_creator."',$dsp)";
-        if ($this->debug > 2) { error_log('New LP - In import_aicc(), inserting path: '. $sql, 0); }
+        if ($this->debug > 2) { error_log('New LP - In import_aicc(), inserting path: '.$sql, 0); }
         Database::query($sql);
         $lp_id = Database::insert_id();
 
@@ -276,7 +276,7 @@ 
 
         $previous = 0;
         foreach ($this->aulist as $identifier => $dummy) {
-            $oAu =& $this->aulist[$identifier];
+            $oAu = & $this->aulist[$identifier];
             //echo "Item ".$oAu->identifier;
             $field_add = '';
             $value_add = '';
@@ -294,12 +294,12 @@ 
             $parent = 0; // TODO: Deal with the parent.
             $previous = 0;
             $prereq = $oAu->prereq_string;
-            $sql_item = "INSERT INTO $new_lp_item (c_id, lp_id,item_type,ref,title, path,min_score,max_score, $field_add parent_item_id,previous_item_id,next_item_id, prerequisite,display_order,parameters) " .
-                    "VALUES " .
-                    "($course_id, $lp_id, 'au','".$oAu->identifier."','".$title."'," .
-                    "'$path',0,100, $value_add" .
-                    "$parent, $previous, 0, " .
-                    "'$prereq', 0,'".(!empty($oAu->parameters)?Database::escape_string($oAu->parameters):'')."'" .
+            $sql_item = "INSERT INTO $new_lp_item (c_id, lp_id,item_type,ref,title, path,min_score,max_score, $field_add parent_item_id,previous_item_id,next_item_id, prerequisite,display_order,parameters) ".
+                    "VALUES ".
+                    "($course_id, $lp_id, 'au','".$oAu->identifier."','".$title."',".
+                    "'$path',0,100, $value_add".
+                    "$parent, $previous, 0, ".
+                    "'$prereq', 0,'".(!empty($oAu->parameters) ? Database::escape_string($oAu->parameters) : '')."'".
                     ")";
             Database::query($sql_item);
             if ($this->debug > 1) { error_log('New LP - In aicc::import_aicc() - inserting item : '.$sql_item.' : ', 0); }
@@ -350,7 +350,7 @@ 
         $zip_file_name = $zip_file_info['name'];
 
         if ($this->debug > 0) { error_log('New LP - aicc::import_package() - Zip file path = '.$zip_file_path.', zip file name = '.$zip_file_name, 0); }
-        $course_rel_dir  = api_get_course_path().'/scorm'; // Scorm dir web path starting from /courses
+        $course_rel_dir = api_get_course_path().'/scorm'; // Scorm dir web path starting from /courses
         $course_sys_dir = api_get_path(SYS_COURSE_PATH).$course_rel_dir; // The absolute system path of this course.
         $current_dir = api_replace_dangerous_char(trim($current_dir)); // Current dir we are in, inside scorm/
         if ($this->debug > 0) { error_log('New LP - aicc::import_package() - Current_dir = '.$current_dir, 0); }
@@ -367,7 +367,7 @@ 
         if ($this->debug > 0) { error_log('New LP - aicc::import_package() - Base file name is : '.$file_base_name, 0); }
         $new_dir = api_replace_dangerous_char(trim($file_base_name));
         $this->subdir = $new_dir;
-        if($this->debug > 0) { error_log('New LP - aicc::import_package() - Subdir is first set to : '.$this->subdir, 0); }
+        if ($this->debug > 0) { error_log('New LP - aicc::import_package() - Subdir is first set to : '.$this->subdir, 0); }
 
         /*
         if (check_name_exist($course_sys_dir.$current_dir.'/'.$new_dir)) {
@@ -413,7 +413,7 @@ 
                         $subdir_isset = true;
                     } else {
                         if (!$subdir_isset) {
-                            if (preg_match('?^.*/aicc$?i',dirname($thisContent['filename']))) {
+                            if (preg_match('?^.*/aicc$?i', dirname($thisContent['filename']))) {
                                 //echo "Cutting subdir<br/>";
                                 $this->subdir .= '/'.substr(dirname($thisContent['filename']), 0, -5);
                             } else {
@@ -516,7 +516,7 @@ 
                         // TODO: RENAMING FILES CAN BE VERY DANGEROUS AICC-WISE, avoid that as much as possible!
                         //$safe_file = api_replace_dangerous_char($file, 'strict');
                         $find_str = array('\\', '.php', '.phtml');
-                        $repl_str = array('/',  '.txt', '.txt');
+                        $repl_str = array('/', '.txt', '.txt');
                         $safe_file = str_replace($find_str, $repl_str, $file);
 
                         if ($safe_file != $file) {
@@ -717,7 +717,7 @@ 
         if ($this->debug > 0) { error_log('In aicc::get_res_path('.$id.') method', 0); }
         $path = '';
         if (isset($this->resources[$id])) {
-            $oRes =& $this->resources[$id];
+            $oRes = & $this->resources[$id];
             $path = @$oRes->get_path();
         }
         return $path;
@@ -733,7 +733,7 @@ 
         if ($this->debug > 0) { error_log('In aicc::get_res_type('.$id.') method', 0); }
         $type = '';
         if (isset($this->resources[$id])) {
-            $oRes =& $this->resources[$id];
+            $oRes = & $this->resources[$id];
             $temptype = $oRes->get_scorm_type();
             if (!empty($temptype)) {
                 $type = $temptype;
@@ -746,7 +746,7 @@ 
      * Gets the default organisation's title
      * @return	string	The organization's title
      */
-    function get_title(){
+    function get_title() {
         if ($this->debug > 0) { error_log('In aicc::get_title() method', 0); }
         $title = '';
         if (isset($this->config['organizations']['default'])) {
@@ -907,7 +907,7 @@ 
             $chr = $data{$i};
             switch ($chr) {
                 case $enclosure:
-                    if ($enclosed && $data{$i+1} == $enclosure) {
+                    if ($enclosed && $data{$i + 1} == $enclosure) {
                         $fldval .= $chr;
                         ++$i; // Skip the next character.
                     } else
@@ -921,7 +921,7 @@ 
                         $fldval .= $chr;
                     break;
                 case "\r":
-                    if (!$enclosed&&$data{$i+1} == "\n")
+                    if (!$enclosed && $data{$i + 1} == "\n")
                         continue;
                 case "\n":
                     if (!$enclosed) {
@@ -932,7 +932,7 @@ 
                         $fldval .= $chr;
                     break;
                 case "\\r":
-                    if (!$enclosed&&$data{$i+1} == "\\n")
+                    if (!$enclosed && $data{$i + 1} == "\\n")
                         continue;
                 case "\\n":
                     if (!$enclosed) {

Braces +24 added lines, -15 removed lines

@@ -459,11 +459,12 @@ 
             }
         }
 
-        if ($package_type == '' || !$mandatory)
-        // && defined('CHECK_FOR_AICC') && CHECK_FOR_AICC)
+        if ($package_type == '' || !$mandatory) {
+                // && defined('CHECK_FOR_AICC') && CHECK_FOR_AICC)
         {
             return api_failure::set_failure('not_aicc_content');
         }
+        }
 
         if (!enough_size($realFileSize, $course_sys_dir, $maxFilledSpace)) {
             return api_failure::set_failure('not_enough_space');
@@ -511,7 +512,9 @@ 
                     if ($file != '.' && $file != '..') {
                         $filetype = 'file';
 
-                        if (is_dir($course_sys_dir.$new_dir.$file)) $filetype = 'folder';
+                        if (is_dir($course_sys_dir.$new_dir.$file)) {
+                            $filetype = 'folder';
+                        }
 
                         // TODO: RENAMING FILES CAN BE VERY DANGEROUS AICC-WISE, avoid that as much as possible!
                         //$safe_file = api_replace_dangerous_char($file, 'strict');
@@ -910,37 +913,43 @@ 
                     if ($enclosed && $data{$i+1} == $enclosure) {
                         $fldval .= $chr;
                         ++$i; // Skip the next character.
-                    } else
-                        $enclosed = !$enclosed;
+                    } else {
+                                            $enclosed = !$enclosed;
+                    }
                     break;
                 case $delim:
                     if (!$enclosed) {
                         $ret_array[$linecount][$fldcount++] = $fldval;
                         $fldval = '';
-                    } else
-                        $fldval .= $chr;
+                    } else {
+                                            $fldval .= $chr;
+                    }
                     break;
                 case "\r":
-                    if (!$enclosed&&$data{$i+1} == "\n")
-                        continue;
+                    if (!$enclosed&&$data{$i+1} == "\n") {
+                                            continue;
+                    }
                 case "\n":
                     if (!$enclosed) {
                         $ret_array[$linecount++][$fldcount] = $fldval;
                         $fldcount = 0;
                         $fldval = '';
-                    } else
-                        $fldval .= $chr;
+                    } else {
+                                            $fldval .= $chr;
+                    }
                     break;
                 case "\\r":
-                    if (!$enclosed&&$data{$i+1} == "\\n")
-                        continue;
+                    if (!$enclosed&&$data{$i+1} == "\\n") {
+                                            continue;
+                    }
                 case "\\n":
                     if (!$enclosed) {
                         $ret_array[$linecount++][$fldcount] = $fldval;
                         $fldcount = 0;
                         $fldval = '';
-                    } else
-                        $fldval .= $chr;
+                    } else {
+                                            $fldval .= $chr;
+                    }
                     break;
                 default:
                     $fldval .= $chr;