chamilo / chamilo-lms

main/tracking/question_course_report.php

Indentation +107 added lines, -107 removed lines

@@ -14,20 +14,20 @@ 
 $is_allowedToTrack = $is_courseAdmin || $is_platformAdmin || $is_courseCoach || $is_sessionAdmin;
 
 if (!$is_allowedToTrack) {
-	Display :: display_header(null);
-	api_not_allowed();
-	Display :: display_footer();
+    Display :: display_header(null);
+    api_not_allowed();
+    Display :: display_footer();
 }
 
 $export_to_xls = false;
 if (isset($_GET['export'])) {
-	$export_to_xls = true;
+    $export_to_xls = true;
 }
 
 if (api_is_platform_admin() ) {
-	$global = true;
+    $global = true;
 } else {
-	$global = false;
+    $global = false;
 }
 $global = true;
 
@@ -45,14 +45,14 @@ 
 $session_id = isset($_REQUEST['session_id']) ? intval($_REQUEST['session_id']) : null;
 
 if (empty($session_id)) {
-	$temp_course_list = CourseManager :: get_courses_list();
+    $temp_course_list = CourseManager :: get_courses_list();
 } else {
-	$temp_course_list = SessionManager::get_course_list_by_session_id($session_id);
+    $temp_course_list = SessionManager::get_course_list_by_session_id($session_id);
 }
 
 foreach ($temp_course_list  as $temp_course_item) {
-	$course_item = CourseManager ::get_course_information($temp_course_item['code']);
-	$course_select_list[$temp_course_item['code']]	= $course_item['title'];
+    $course_item = CourseManager ::get_course_information($temp_course_item['code']);
+    $course_select_list[$temp_course_item['code']]	= $course_item['title'];
 }
 
 //Get session list
@@ -95,132 +95,132 @@ 
 $course_info = api_get_course_info($course_code);
 
 if (!empty($course_info)) {
-	$list = new LearnpathList('', $course_code);
-	$lp_list = $list->get_flat_list();
+    $list = new LearnpathList('', $course_code);
+    $lp_list = $list->get_flat_list();
 
-	$main_question_list = array();
+    $main_question_list = array();
 
-	foreach ($lp_list as $lp_id => $lp) {
+    foreach ($lp_list as $lp_id => $lp) {
         $exercise_list = Event::get_all_exercises_from_lp(
             $lp_id,
             $course_info['real_id']
         );
 
-		foreach ($exercise_list as $exercise) {
-			$my_exercise = new Exercise($course_info['real_id']);
-			$my_exercise->read($exercise['path']);
-			$question_list = $my_exercise->selectQuestionList();
-
-			$exercise_stats = Event::get_all_exercise_event_from_lp(
-				$exercise['path'],
-				$course_info['real_id'],
-				$session_id
-			);
-
-			foreach ($question_list as $question_id) {
-				$question_data = Question::read($question_id);
-				$main_question_list[$question_id] = $question_data;
-				$quantity_exercises = 0;
-				$question_result = 0;
-
-				foreach ($exercise_stats as $stats) {
-					if (!empty($stats['question_list'])) {
-						foreach($stats['question_list'] as $my_question_stat) {
-							if ($question_id == $my_question_stat['question_id']) {
-								$question_result =  $question_result + $my_question_stat['marks'];
-								$quantity_exercises++;
-							}
-						}
-					}
-				}
-
-				if (!empty($quantity_exercises)) {
-					// Score % average
-					$main_question_list[$question_id]->results = ($question_result / ($quantity_exercises));
-				} else {
-					$main_question_list[$question_id]->results = 0;
-				}
-
-				$main_question_list[$question_id]->quantity = $quantity_exercises;
-			}
-		}
-	}
+        foreach ($exercise_list as $exercise) {
+            $my_exercise = new Exercise($course_info['real_id']);
+            $my_exercise->read($exercise['path']);
+            $question_list = $my_exercise->selectQuestionList();
+
+            $exercise_stats = Event::get_all_exercise_event_from_lp(
+                $exercise['path'],
+                $course_info['real_id'],
+                $session_id
+            );
+
+            foreach ($question_list as $question_id) {
+                $question_data = Question::read($question_id);
+                $main_question_list[$question_id] = $question_data;
+                $quantity_exercises = 0;
+                $question_result = 0;
+
+                foreach ($exercise_stats as $stats) {
+                    if (!empty($stats['question_list'])) {
+                        foreach($stats['question_list'] as $my_question_stat) {
+                            if ($question_id == $my_question_stat['question_id']) {
+                                $question_result =  $question_result + $my_question_stat['marks'];
+                                $quantity_exercises++;
+                            }
+                        }
+                    }
+                }
+
+                if (!empty($quantity_exercises)) {
+                    // Score % average
+                    $main_question_list[$question_id]->results = ($question_result / ($quantity_exercises));
+                } else {
+                    $main_question_list[$question_id]->results = 0;
+                }
+
+                $main_question_list[$question_id]->quantity = $quantity_exercises;
+            }
+        }
+    }
 }
 
 if (!$export_to_xls) {
-	Display :: display_header(get_lang("MySpace"));
-	echo '<div class="actions">';
-	if ($global) {
-		echo MySpace::getTopMenu();
-	} else {
-		echo '<div style="float:left; clear:left">
+    Display :: display_header(get_lang("MySpace"));
+    echo '<div class="actions">';
+    if ($global) {
+        echo MySpace::getTopMenu();
+    } else {
+        echo '<div style="float:left; clear:left">
 				<a href="courseLog.php?'.api_get_cidreq().'&studentlist=true">'.
                     get_lang('StudentsTracking').'</a>&nbsp;|
 				<a href="courseLog.php?'.api_get_cidreq().'&studentlist=false">'.
                     get_lang('CourseTracking').'</a>&nbsp;';
-		echo '</div>';
-	}
-	echo '</div>';
+        echo '</div>';
+    }
+    echo '</div>';
 
-	if (api_is_platform_admin()) {
-		echo MySpace::getAdminActions();
-	}
-	echo '<br />';
-	echo '<h2>'.get_lang('LPQuestionListResults').'</h2>';
+    if (api_is_platform_admin()) {
+        echo MySpace::getAdminActions();
+    }
+    echo '<br />';
+    echo '<h2>'.get_lang('LPQuestionListResults').'</h2>';
 
-	$form->display();
+    $form->display();
 
-	if (empty($course_code)) {
-		Display::display_warning_message(get_lang('PleaseSelectACourse'));
-	}
+    if (empty($course_code)) {
+        Display::display_warning_message(get_lang('PleaseSelectACourse'));
+    }
 }
 
 $course_average = array();
 $counter = 0;
 
 if (!empty($main_question_list) && is_array($main_question_list)) {
-	$html_result .= '<table  class="data_table">';
-	$html_result .= '<tr><th>'.get_lang('Question').
+    $html_result .= '<table  class="data_table">';
+    $html_result .= '<tr><th>'.get_lang('Question').
                     Display :: return_icon('info3.gif', get_lang('QuestionsAreTakenFromLPExercises'), array('align' => 'absmiddle', 'hspace' => '3px')).'</th>';
-	$html_result .= '<th>'.$course_info['visual_code'].' '.get_lang('AverageScore').Display :: return_icon('info3.gif', get_lang('AllStudentsAttemptsAreConsidered'), array('align' => 'absmiddle', 'hspace' => '3px')).' </th>';
-	$html_result .= '<th>'.get_lang('Quantity').'</th>';
-
-	foreach ($main_question_list as $question) {
-		$total_student = 0;
-		$counter ++;
-		$s_css_class = 'row_even';
-		if ($counter % 2 ==0 ) {
-			$s_css_class = 'row_odd';
-		}
-		$html_result .= "<tr class='$s_css_class'>
+    $html_result .= '<th>'.$course_info['visual_code'].' '.get_lang('AverageScore').Display :: return_icon('info3.gif', get_lang('AllStudentsAttemptsAreConsidered'), array('align' => 'absmiddle', 'hspace' => '3px')).' </th>';
+    $html_result .= '<th>'.get_lang('Quantity').'</th>';
+
+    foreach ($main_question_list as $question) {
+        $total_student = 0;
+        $counter ++;
+        $s_css_class = 'row_even';
+        if ($counter % 2 ==0 ) {
+            $s_css_class = 'row_odd';
+        }
+        $html_result .= "<tr class='$s_css_class'>
 							<td >";
-		$question_title = trim($question->question);
-		if (empty($question_title)) {
-			$html_result .= get_lang('Untitled').' '.get_lang('Question').' #'.$question->id;
-		} else {
-			$html_result .= $question->question;
-		}
-
-		$html_result .= "</td>";
-		$html_result .= "<td>";
-		$html_result .= round($question->results, 2).' / '.$question->weighting;
-		$html_result .= "</td>";
-
-		$html_result .= "<td>";
-		$html_result .= $question->quantity;
-		$html_result .= "</td>";
-	}
-
-	$html_result .="</tr>";
-	$html_result .= '</table>';
+        $question_title = trim($question->question);
+        if (empty($question_title)) {
+            $html_result .= get_lang('Untitled').' '.get_lang('Question').' #'.$question->id;
+        } else {
+            $html_result .= $question->question;
+        }
+
+        $html_result .= "</td>";
+        $html_result .= "<td>";
+        $html_result .= round($question->results, 2).' / '.$question->weighting;
+        $html_result .= "</td>";
+
+        $html_result .= "<td>";
+        $html_result .= $question->quantity;
+        $html_result .= "</td>";
+    }
+
+    $html_result .="</tr>";
+    $html_result .= '</table>';
 } else {
-	if (!empty($course_code)) {
-		Display::display_warning_message(get_lang('NoResults'));
-	}
+    if (!empty($course_code)) {
+        Display::display_warning_message(get_lang('NoResults'));
+    }
 }
 
 if (!$export_to_xls) {
-	echo $html_result;
+    echo $html_result;
 }
 
 Display :: display_footer();

main/course_description/course_description_controller.php

Indentation +2 added lines, -2 removed lines

@@ -156,7 +156,7 @@ 
                 if (isset($_GET['id_session'])) {
                     $session_id = intval($_GET['id_session']);
                 }
-		        $course_description_data = $course_description->get_data_by_id(
+                $course_description_data = $course_description->get_data_by_id(
                     $id,
                     null,
                     $session_id
@@ -165,7 +165,7 @@ 
                 $data['description_title'] = $course_description_data['description_title'];
                 $data['description_content'] = $course_description_data['description_content'];
                 $data['progress'] = $course_description_data['progress'];
-		        $data['descriptions'] = $course_description->get_data_by_description_type(
+                $data['descriptions'] = $course_description->get_data_by_description_type(
                     $description_type,
                     null,
                     $session_id

main/user/resume_session.php

Indentation +49 added lines, -49 removed lines

@@ -60,9 +60,9 @@ 
     $session_category = '';
 
     if (Database::num_rows($rs)>0) {
-    	$rows_session_category = Database::store_result($rs);
-    	$rows_session_category = $rows_session_category[0];
-    	$session_category = $rows_session_category['name'];
+        $rows_session_category = Database::store_result($rs);
+        $rows_session_category = $rows_session_category[0];
+        $session_category = $rows_session_category['name'];
     }
 
     $action = isset($_GET['action']) ? $_GET['action'] : null;
@@ -147,22 +147,22 @@ 
     	<td><?php echo get_lang('Date'); ?> :</td>
     	<td>
     	<?php
-    		if ($session['access_start_date'] == '00-00-0000' && $session['access_end_date']== '00-00-0000' ) {
-    		    echo get_lang('NoTimeLimits');
+            if ($session['access_start_date'] == '00-00-0000' && $session['access_end_date']== '00-00-0000' ) {
+                echo get_lang('NoTimeLimits');
             }
-    		else {
+            else {
                 if ($session['access_start_date'] != '00-00-0000') {
-                	//$session['date_start'] = Display::tag('i', get_lang('NoTimeLimits'));
+                    //$session['date_start'] = Display::tag('i', get_lang('NoTimeLimits'));
                     $session['access_start_date'] =  get_lang('From').' '.$session['access_start_date'];
                 } else {
-                	$session['access_start_date'] = '';
+                    $session['access_start_date'] = '';
                 }
                 if ($session['access_end_date'] == '00-00-0000') {
                     $session['access_end_date'] ='';
                 } else {
-                	$session['access_end_date'] = get_lang('Until').' '.$session['access_end_date'];
+                    $session['access_end_date'] = get_lang('Until').' '.$session['access_end_date'];
                 }
-    			echo $session['access_start_date'].' '.$session['access_end_date'];
+                echo $session['access_start_date'].' '.$session['access_end_date'];
             }
             ?>
     	</td>
@@ -221,22 +221,22 @@ 
     </tr>
     <?php
     if ($session['nbr_courses'] == 0) {
-    	echo '<tr>
+        echo '<tr>
             <td colspan="4">'.get_lang('NoCoursesForThisSession').'</td>
     		</tr>';
     } else {
-    	// select the courses
-    	$sql = "SELECT c.id, code,title,visual_code, nbr_users
+        // select the courses
+        $sql = "SELECT c.id, code,title,visual_code, nbr_users
     			FROM $tbl_course c,$tbl_session_rel_course sc
     			WHERE c.id = sc.c_id
     			AND	session_id='$id_session'
     			ORDER BY title";
-    	$result=Database::query($sql);
-    	$courses=Database::store_result($result);
-    	foreach ($courses as $course) {
-    		//select the number of users
+        $result=Database::query($sql);
+        $courses=Database::store_result($result);
+        foreach ($courses as $course) {
+            //select the number of users
 
-    		$sql = "SELECT count(*) FROM $tbl_session_rel_user sru, $tbl_session_rel_course_rel_user srcru
+            $sql = "SELECT count(*) FROM $tbl_session_rel_user sru, $tbl_session_rel_course_rel_user srcru
                     WHERE
                         srcru.user_id = sru.user_id AND
                         srcru.session_id = sru.session_id AND
@@ -244,49 +244,49 @@ 
                         sru.relation_type<>".SESSION_RELATION_TYPE_RRHH." AND
                         srcru.session_id = '".intval($id_session)."'";
 
-    		$rs = Database::query($sql);
-    		$course['nbr_users'] = Database::result($rs,0,0);
+            $rs = Database::query($sql);
+            $course['nbr_users'] = Database::result($rs,0,0);
 
-    		// Get coachs of the courses in session
+            // Get coachs of the courses in session
 
-    		$sql = "SELECT user.lastname,user.firstname,user.username
+            $sql = "SELECT user.lastname,user.firstname,user.username
     		        FROM $tbl_session_rel_course_rel_user session_rcru, $tbl_user user
     				WHERE
     				    session_rcru.user_id = user.user_id AND
     				    session_rcru.session_id = '".intval($id_session)."' AND
     				    session_rcru.c_id ='".Database::escape_string($course['id'])."' AND
     				    session_rcru.status=2";
-    		$rs = Database::query($sql);
+            $rs = Database::query($sql);
 
-    		$coachs = array();
-    		if (Database::num_rows($rs) > 0) {
-    			while ($info_coach = Database::fetch_array($rs)) {
+            $coachs = array();
+            if (Database::num_rows($rs) > 0) {
+                while ($info_coach = Database::fetch_array($rs)) {
                     $coachs[] = api_get_person_name(
                             $info_coach['firstname'],
                             $info_coach['lastname']
                         ).' ('.$info_coach['username'].')';
-    			}
-    		} else {
-    			$coach = get_lang('None');
-    		}
-
-    		if (count($coachs) > 0) {
-    			$coach = implode('<br />',$coachs);
-    		} else {
-    			$coach = get_lang('None');
-    		}
-
-    		$orig_param = '&origin=resume_session';
-    		//hide_course_breadcrumb the parameter has been added to hide the
+                }
+            } else {
+                $coach = get_lang('None');
+            }
+
+            if (count($coachs) > 0) {
+                $coach = implode('<br />',$coachs);
+            } else {
+                $coach = get_lang('None');
+            }
+
+            $orig_param = '&origin=resume_session';
+            //hide_course_breadcrumb the parameter has been added to hide the
             // name of the course, that appeared in the default $interbreadcrumb
-    		echo '
+            echo '
     		<tr>
     			<td>'.Display::url($course['title'].' ('.$course['visual_code'].')', api_get_path(WEB_COURSE_PATH).$course['code'].'/?id_session='.$id_session),'</td>
     			<td>'.$coach.'</td>
     			<td>'.$course['nbr_users'].'</td>
 
     		</tr>';
-    	}
+        }
     }
     ?>
     </table>
@@ -307,11 +307,11 @@ 
     <?php
 
     if ($session['nbr_users']==0) {
-    	echo '<tr>
+        echo '<tr>
     			<td colspan="2">'.get_lang('NoUsersForThisSession').'</td>
     		</tr>';
     } else {
-    	$order_clause = api_sort_by_first_name() ? ' ORDER BY firstname, lastname' : ' ORDER BY lastname, firstname';
+        $order_clause = api_sort_by_first_name() ? ' ORDER BY firstname, lastname' : ' ORDER BY lastname, firstname';
 
         if ($multiple_url_is_on) {
             $sql = "SELECT u.user_id, lastname, firstname, username, access_url_id
@@ -329,11 +329,11 @@ 
                     AND su.session_id = ".$id_session.$order_clause;
         }
 
-    	$result = Database::query($sql);
-    	$users  = Database::store_result($result);
+        $result = Database::query($sql);
+        $users  = Database::store_result($result);
         // change breadcrumb in destination page
-    	$orig_param = '&origin=resume_session&id_session='.$id_session;
-    	foreach ($users as $user) {
+        $orig_param = '&origin=resume_session&id_session='.$id_session;
+        foreach ($users as $user) {
             $user_link = '';
             if (!empty($user['user_id'])) {
                 $user_link = '<a href="'.api_get_path(WEB_CODE_PATH).'admin/user_information.php?user_id='.intval($user['user_id']).'">'.
@@ -350,7 +350,7 @@ 
                 }
             }
 
-    		echo '<tr>
+            echo '<tr>
                     <td width="90%">
                         '.$user_link.'
                     </td>
@@ -361,7 +361,7 @@ 
                         '.$link_to_add_user_in_url.'
                     </td>
                     </tr>';
-    	}
+        }
     }
     ?>
     </table>

main/user/session_list.php

Indentation +4 added lines, -4 removed lines

@@ -65,13 +65,13 @@ 
         array('name'=>'access_end_date',       'index'=>'access_end_date',      'width'=>'40',   'align'=>'left', 'search' => 'true'),
         array('name'=>'coach_name',     'index'=>'coach_name',    'width'=>'80',   'align'=>'left', 'search' => 'false'),
         array('name'=>'status',         'index'=>'session_active','width'=>'40',   'align'=>'left', 'search' => 'true', 'stype'=>'select',
-          //for the bottom bar
+            //for the bottom bar
             'searchoptions' => array(
                 'defaultValue' => '1',
                 'value' => '1:'.get_lang('Active').';0:'.get_lang('Inactive')
             ),
-          //for the top bar
-          'editoptions' => array('value' => ':'.get_lang('All').';1:'.get_lang('Active').';0:'.get_lang('Inactive'))),
+            //for the top bar
+            'editoptions' => array('value' => ':'.get_lang('All').';1:'.get_lang('Active').';0:'.get_lang('Inactive'))),
         array('name'=>'visibility',     'index'=>'visibility',      'width'=>'40',   'align'=>'left', 'search' => 'false'),
         array('name'=>'actions',        'index'=>'actions',         'width'=>'100',  'align'=>'left','formatter'=>'action_formatter','sortable'=>'false', 'search' => 'false')
     );
@@ -86,7 +86,7 @@ 
     //With this function we can add actions to the jgrid (edit, delete, etc)
     $action_links = 'function action_formatter(cellvalue, options, rowObject) {
          return \'&nbsp;<a href="add_users_to_session.php?page=session_list.php&id_session=\'+options.rowId+\'">'.Display::return_icon('user_subscribe_session.png',get_lang('SubscribeUsersToSession'),'',ICON_SIZE_SMALL).'</a>'.
-         '\';
+            '\';
     }';
     ?>
     <script>

whoisonlinesession.php

Indentation +39 added lines, -39 removed lines

@@ -41,10 +41,10 @@ 
 		</th>
 	</tr>
 <?php
-	$session_is_coach = array();
-	if (isset($_user['user_id']) && $_user['user_id'] != '') {
-		$_user['user_id'] = intval($_user['user_id']);
-		$sql = "SELECT DISTINCT session.id,
+    $session_is_coach = array();
+    if (isset($_user['user_id']) && $_user['user_id'] != '') {
+        $_user['user_id'] = intval($_user['user_id']);
+        $sql = "SELECT DISTINCT session.id,
 					name,
 					access_start_date,
 					access_end_date
@@ -53,13 +53,13 @@ 
 					ON srcru.user_id = ".$_user['user_id']." AND srcru.status=2
 					AND session.id = srcru.session_id
 				ORDER BY access_start_date, access_end_date, name";
-		$result = Database::query($sql);
+        $result = Database::query($sql);
 
-		while ($session = Database:: fetch_array($result)) {
-			$session_is_coach[$session['id']] = $session;
-		}
+        while ($session = Database:: fetch_array($result)) {
+            $session_is_coach[$session['id']] = $session;
+        }
 
-		$sql = "SELECT DISTINCT session.id,
+        $sql = "SELECT DISTINCT session.id,
 					name,
 					access_start_date,
 					access_end_date
@@ -67,9 +67,9 @@ 
 				WHERE session.id_coach = ".$_user['user_id']."
 				ORDER BY access_start_date, access_end_date, name";
         $result = Database::query($sql);
-		while ($session = Database:: fetch_array($result)) {
-			$session_is_coach[$session['id']] = $session;
-		}
+        while ($session = Database:: fetch_array($result)) {
+            $session_is_coach[$session['id']] = $session;
+        }
 
         if (empty($time_limit)) {
             $time_limit = api_get_setting('time_limit_whosonline');
@@ -82,7 +82,7 @@ 
 
         $students_online = array();
         foreach ($session_is_coach as $session) {
-			$sql = "SELECT DISTINCT last_access.access_user_id,
+            $sql = "SELECT DISTINCT last_access.access_user_id,
 						last_access.access_date,
 						last_access.c_id,
 						last_access.access_session_id,
@@ -95,49 +95,49 @@ 
 					AND access_date >= '$current_date'
 					GROUP BY access_user_id";
 
-			$result = Database::query($sql);
+            $result = Database::query($sql);
 
-			while($user_list = Database::fetch_array($result)) {
-				$students_online[$user_list['access_user_id']] = $user_list;
-			}
-		}
+            while($user_list = Database::fetch_array($result)) {
+                $students_online[$user_list['access_user_id']] = $user_list;
+            }
+        }
 
-		if (count($students_online) > 0) {
-			foreach ($students_online as $student_online) {
-				echo "<tr>
+        if (count($students_online) > 0) {
+            foreach ($students_online as $student_online) {
+                echo "<tr>
 						<td>
 					";
-				echo $student_online['name'];
-				echo "	</td>
+                echo $student_online['name'];
+                echo "	</td>
 						<td align='center'>
 					 ";
-				$courseInfo = api_get_course_info_by_id($student_online['c_id']);
-				echo $courseInfo['title'];
-				echo "	</td>
+                $courseInfo = api_get_course_info_by_id($student_online['c_id']);
+                echo $courseInfo['title'];
+                echo "	</td>
 						<td align='center'>
 					 ";
-							 if (!empty($student_online['email'])) {
-								echo $student_online['email'];
-							 } else {
-							 	echo get_lang('NoEmail');
-							 }
-				echo "	</td>
+                                if (!empty($student_online['email'])) {
+                                echo $student_online['email'];
+                                } else {
+                                    echo get_lang('NoEmail');
+                                }
+                echo "	</td>
 						<td align='center'>
 					 ";
-				echo '<a href="main/chat/chat.php?cidReq='.$courseInfo['code'].'&id_session='.$student_online['access_session_id'].'"> -> </a>';
-				echo "	</td>
+                echo '<a href="main/chat/chat.php?cidReq='.$courseInfo['code'].'&id_session='.$student_online['access_session_id'].'"> -> </a>';
+                echo "	</td>
 					</tr>
 					 ";
-			}
-		} else {
-			echo '	<tr>
+            }
+        } else {
+            echo '	<tr>
 						<td colspan="4">
 							'.get_lang('NoOnlineStudents').'
 						</td>
 					</tr>
 				 ';
-		}
-	}
+        }
+    }
 ?>
 </table>
 <?php

plugin/pens/lib/pens/pens_request.php

Indentation +447 added lines, -447 removed lines

@@ -43,453 +43,453 @@
 
 abstract class PENSRequest extends PENSMessage {
 
-	/**
-	 * PENS Version to be used. Currently, the only valid value is 1.0.0. Required.
-	 * @var string
-	 */
-	protected $_pens_version = null;
-	
-	/**
-	 * Command being used. The only valid values are collect, alert and receipt.Required
-	 * @var string
-	 */
-	protected $_command = null;
-	
-	/**
-	 * Package type being used. The only valid values are aicc-pkg, scorm-pif, ims-qti. Required
-	 * @var string
-	 */
-	protected $_package_type = null;
-	
-	/**
-	 * Package type version. Required
-	 * @var string
-	 */
-	protected $_package_type_version = null;
-	
-	/**
-	 * Package format. The only valid values are zip, url, jar, war and xml. Required
-	 * @var string
-	 */
-	protected $_package_format = null;
-	
-	/**
-	 * Package id. Requires a valid URI according to RFC 2396. Required
-	 * @var string
-	 */
-	protected $_package_id = null;
-	
-	/**
-	 * Package url. Requires a valid, fully qualified URL including transport protocol and filename extension. Required
-	 * @var string
-	 */
-	protected $_package_url = null;
-	
-	/**
-	 * User id required for system to retrieve package from URL. Optional.
-	 * @var string
-	 */
-	protected $_package_url_user_id = null;
-	
-	/**
-	 * Account required for system to retrieve package from URL. Optional.
-	 * @var string
-	 */
-	protected $_package_url_account = null;
-	
-	/**
-	 * Password required for system to retrieve package from URL. Optional.
-	 * @var string
-	 */
-	protected $_package_url_password = null;
-	
-	/**
-	 * Expiry date for package URL. ISO 8601 format expressed as UTC. Will be transformed into a PHP DateTime object during construction. Required
-	 * @var DateTime
-	 */
-	protected $_package_url_expiry = null;
-	
-	/**
-	 * Name or ID for client submitting the content package to the target system. Required.
-	 * @var string
-	 */
-	protected $_client = null;
-	
-	/**
-	 * User-id or sign-on for target system. Optional
-	 * @var string
-	 */
-	protected $_system_user_id = null;
-	
-	/**
-	 * Either a URL-encoded password token or the null string. If the 
-	 * target system requires a password and the null string value is 
-	 * passed, then the target system is responsible for prompting for a 
-	 * password for target system. Optional
-	 * @var string
-	 */
-	protected $_system_password = null;
-	
-	/**
-	 * URL to send acknowledgement receipt after collecting a package. Any URL, including mailto (as per RFC 2368 and RFC 2822). Required.
-	 * @var string
-	 */
-	protected $_receipt = null;
-	
-	/**
-	 * URL to send alerts to while processing the package. Any URL, including mailto (as per RFC 2368 and RFC 2822). Optional.
-	 * @var string
-	 */
-	protected $_alerts = null;
-	
-	/**
-	 * Unstructured character string that may be used to transfer vendor-specific data such as processing hints or deployment information. Optional.
-	 * @var string
-	 */
-	protected $_vendor_data = null;
-	
-	/**
-	 * Constructor
-	 * 
-	 * Constructs a PENSRequest based class using the arguments given
-	 * 
-	 * @param array Arguments
-	 */
-	public function __construct($arguments) {
-		$this->setPensVersion($arguments["pens-version"]);
-		$this->setPackageType($arguments["package-type"]);
-		$this->setPackageTypeVersion($arguments["package-type-version"]);
-		$this->setPackageFormat($arguments["package-format"]);
-		$this->setPackageId($arguments["package-id"]);
-		$this->setPackageUrl($arguments["package-url"]);
-		$this->setPackageUrlUserId($arguments["package-url-user-id"]);
-		$this->setPackageUrlAccount($arguments["package-url-account"]);
-		$this->setPackageUrlPassword($arguments["package-url-password"]);
-		$this->setPackageUrlExpiry($arguments["package-url-expiry"]);
-		$this->setClient($arguments["client"]);
-		$this->setSystemUserId($arguments["system-user-id"]);
-		$this->setSystemPassword($arguments["system-password"]);
-		$this->setReceipt($arguments["receipt"]);
-		$this->setAlerts($arguments["alerts"]);
-		$this->setVendorData($arguments["vendor-data"]);
-	}
-	
-	public function getPensVersion() {
-		return $this->_pens_version;
-	}
-	
-	/**
-	 * Sets the PENS version
-	 * 
-	 * @param string PENS version
-	 * 
-	 * @throws PENSException with code 2001 if invalid
-	 */
-	public function setPensVersion($pens_version) {
-		if($pens_version == PENSConfig::$version) {
-			$this->_pens_version = $pens_version;
-		} else {
-			throw new PENSException(2001);
-		}
-	}
-	
-	public function getCommand() {
-		return $this->_command;
-	}
-	
-	/**
-	 * Sets the command
-	 * 
-	 * @param string command
-	 * 
-	 * @throws PENSException with code 2002 if invalid
-	 */
-	protected function setCommand($command) {
-		if(in_array($command, PENSConfig::$allowed_commands)) {
-			$this->_command = $command;
-		} else {
-			throw new PENSException(2002);
-		}
-	}
-	
-	public function getPackageType() {
-		return $this->_package_type;
-	}
-	
-	/**
-	 * Sets the package type
-	 * 
-	 * @param string package type
-	 * 
-	 * @throws PENSException with code 2003 if invalid
-	 */
-	public function setPackageType($package_type) {
-		if(in_array($package_type, PENSConfig::$allowed_package_types)) {
-			$this->_package_type = $package_type;
-		} else {
-			throw new PENSException(2003);
-		}
-	}
-	
-	public function getPackageTypeVersion() {
-		return $this->_package_type_version;
-	}
-	
-	/**
-	 * Sets the package type version
-	 * 
-	 * @param string package type version
-	 * 
-	 * @throws PENSException with code 2004 if invalid
-	 */
-	public function setPackageTypeVersion($package_type_version) {
-		if(empty($package_type_version)) {
-			throw new PENSException(2004);
-		} else {
-			$this->_package_type_version = $package_type_version;
-		}
-	}
-	
-	public function getPackageFormat() {
-		return $this->_package_format;
-	}
-	
-	/**
-	 * Sets the package format
-	 * 
-	 * @param string package format
-	 * 
-	 * @throws PENSException with code 2005 if invalid
-	 */
-	public function setPackageFormat($package_format) {
-		if(in_array($package_format, PENSConfig::$allowed_package_formats)) {
-			$this->_package_format = $package_format;
-		} else {
-			throw new PENSException(2005);
-		}
-	}
-	
-	public function getPackageId() {
-		return $this->_package_id;
-	}
-	
-	/**
-	 * Sets the package Id
-	 * 
-	 * @param string package Id
-	 * 
-	 * @throws PENSException with code 2007 if invalid
-	 */
-	public function setPackageId($package_id) {
-		if (preg_match('/'.ABSOLUTEURI_2396.'/', $package_id)) {
-			$this->_package_id = $package_id;
-		} else {
-			throw new PENSException(2007);
-		}
-	}
-	
-	public function getPackageUrl() {
-		return $this->_package_url;
-	}
-	
-	/**
-	 * Sets the package url
-	 * 
-	 * @param string package url
-	 * 
-	 * @throws PENSException with code 2008 if invalid
-	 */
-	public function setPackageUrl($package_url) {
-		if (preg_match('/'.ABSOLUTEURI_2396.'/', $package_url) && substr($package_url, -4) == ".".$this->_package_format) {
-			$this->_package_url = $package_url;
-		} else {
-			throw new PENSException(2008);
-		}
-	}
-	
-	public function getFilename() {
-		return substr(strrchr($this->_package_url, "/"), 1);
-	}
-	
-	public function getPackageUrlUserId() {
-		return $this->_package_url_user_id;
-	}
-	
-	public function setPackageUrlUserId($package_url_user_id) {
-		if(!empty($package_url_user_id)) {
-			$this->_package_url_user_id = $package_url_user_id;
-		}
-	}
-	
-	public function getPackageUrlAccount() {
-		return $this->_package_url_account;
-	}
-	
-	public function setPackageUrlAccount($package_url_account) {
-		if(!empty($package_url_account)) {
-			$this->_package_url_account = $package_url_account;
-		}
-	}
-	
-	public function getPackageUrlPassword() {
-		return $this->_package_url_password;
-	}
-	
-	public function setPackageUrlPassword($package_url_password) {
-		if(!empty($package_url_password)) {
-			$this->_package_url_password = $package_url_password;
-		}
-	}
-	
-	public function getPackageUrlExpiry() {
-		return $this->_package_url_expiry;
-	}
-	
-	/**
-	 * Sets the package url expiry and transforms it into a php DateTime object
-	 * 
-	 * @param string package url expiry
-	 * 
-	 * @throws PENSException with code 2009 if invalid
-	 * @todo Perform a better validation of the date
-	 */
-	public function setPackageUrlExpiry($package_url_expiry) {
-		if(empty($package_url_expiry)) {
-			throw new PENSException(2009);
-		} else {
-			try {
-				$expiry = new DateTime($package_url_expiry, new DateTimeZone('UTC'));
-				$this->_package_url_expiry = $expiry;
-			} catch(Exception $e) {
-				throw new PENSException(2009);
-			}
-		}
-	}
-	
-	public function getClient() {
-		return $this->_client;
-	}
-	
-	/**
-	 * Sets the client
-	 * 
-	 * @param string client
-	 * 
-	 * @throws PENSException with code 2010 if invalid
-	 */
-	public function setClient($client) {
-		if(!empty($client)) {
-			$this->_client = $client;
-		} else {
-			throw new PENSException(2010);
-		}
-	}
-	
-	public function getSystemUserId() {
-		return $this->_system_user_id;
-	}
-	
-	public function setSystemUserId($system_user_id) {
-		if(!empty($system_user_id)) {
-			$this->_system_user_id = $system_user_id;
-		}
-	}
-	
-	public function getSystemPassword() {
-		return $this->_system_password;
-	}
-	
-	public function setSystemPassword($system_password) {
-		if(!empty($system_password)) {
-			$this->_system_password = $system_password;
-		}
-	}
-	
-	public function getReceipt() {
-		return $this->_receipt;
-	}
-	
-	/**
-	 * Sets the receipt url
-	 * 
-	 * @param string receipt url
-	 * 
-	 * @throws PENSException with code 2011 if invalid
-	 */
-	public function setReceipt($receipt) {
-		if($this instanceof PENSRequestCollect) {
-			if (preg_match('/'.ABSOLUTEURI_2396.'/', $receipt)) {
-				$this->_receipt = $receipt;
-			} else {
-				throw new PENSException(2011);
-			}
-		}
-	}
-	
-	public function getAlerts() {
-		return $this->_alerts;
-	}
-	
-	public function setAlerts($alerts) {
-		if(!empty($alerts)) {
-			if(preg_match('/'.ABSOLUTEURI_2396.'/', $alerts)) {
-				$this->_alerts = $alerts;
-			} else {
-				throw new PENSException(1201);
-			}
-		}
-	}
-	
-	public function getVendorData() {
-		return $this->_vendor_data;
-	}
-	
-	public function setVendorData($vendor_data) {
-		if(!empty($vendor_data)) {
-			$this->_vendor_data = $vendor_data;
-		}
-	}
-	
-	/**
-	 * Returns an associative that contains all the fields needed to send a
-	 * receipt or an alert to the client
-	 * 
-	 * @return array Associative array
-	 */
-	protected function getSendReceiptAlertArray() {
-		return array("pens-version" => $this->getPensVersion(),
-			"package-type" => $this->getPackageType(),
-			"package-type-version" => $this->getPackageTypeVersion(),
-			"package-format" => $this->getPackageFormat(),
-			"package-id" => $this->getPackageId(),
-			"package-url" => $this->getPackageUrl(),
-			"package-url-expiry" => $this->getPackageUrlExpiry()->format(DateTime::ISO8601),
-			"client" => $this->getClient());
-	}
-	
-	/**
-	 * Returns an associative that contains all the fields needed to send a
-	 * receipt to the client
-	 * 
-	 * @return array Associative array
-	 */
-	public function getSendReceiptArray() {
-		$receipt = $this->getSendReceiptAlertArray();
-		$receipt["command"] = "receipt";
-		return $receipt;
-	}
-	
-	/**
-	 * Returns an associative that contains all the fields needed to send an
-	 * alert to the client
-	 * 
-	 * @return array Associative array
-	 */
-	public function getSendAlertArray() {
-		$alert = $this->getSendReceiptAlertArray();
-		$alert["command"] = "alert";
-		return $alert;
-	}
+    /**
+     * PENS Version to be used. Currently, the only valid value is 1.0.0. Required.
+     * @var string
+     */
+    protected $_pens_version = null;
+	
+    /**
+     * Command being used. The only valid values are collect, alert and receipt.Required
+     * @var string
+     */
+    protected $_command = null;
+	
+    /**
+     * Package type being used. The only valid values are aicc-pkg, scorm-pif, ims-qti. Required
+     * @var string
+     */
+    protected $_package_type = null;
+	
+    /**
+     * Package type version. Required
+     * @var string
+     */
+    protected $_package_type_version = null;
+	
+    /**
+     * Package format. The only valid values are zip, url, jar, war and xml. Required
+     * @var string
+     */
+    protected $_package_format = null;
+	
+    /**
+     * Package id. Requires a valid URI according to RFC 2396. Required
+     * @var string
+     */
+    protected $_package_id = null;
+	
+    /**
+     * Package url. Requires a valid, fully qualified URL including transport protocol and filename extension. Required
+     * @var string
+     */
+    protected $_package_url = null;
+	
+    /**
+     * User id required for system to retrieve package from URL. Optional.
+     * @var string
+     */
+    protected $_package_url_user_id = null;
+	
+    /**
+     * Account required for system to retrieve package from URL. Optional.
+     * @var string
+     */
+    protected $_package_url_account = null;
+	
+    /**
+     * Password required for system to retrieve package from URL. Optional.
+     * @var string
+     */
+    protected $_package_url_password = null;
+	
+    /**
+     * Expiry date for package URL. ISO 8601 format expressed as UTC. Will be transformed into a PHP DateTime object during construction. Required
+     * @var DateTime
+     */
+    protected $_package_url_expiry = null;
+	
+    /**
+     * Name or ID for client submitting the content package to the target system. Required.
+     * @var string
+     */
+    protected $_client = null;
+	
+    /**
+     * User-id or sign-on for target system. Optional
+     * @var string
+     */
+    protected $_system_user_id = null;
+	
+    /**
+     * Either a URL-encoded password token or the null string. If the 
+     * target system requires a password and the null string value is 
+     * passed, then the target system is responsible for prompting for a 
+     * password for target system. Optional
+     * @var string
+     */
+    protected $_system_password = null;
+	
+    /**
+     * URL to send acknowledgement receipt after collecting a package. Any URL, including mailto (as per RFC 2368 and RFC 2822). Required.
+     * @var string
+     */
+    protected $_receipt = null;
+	
+    /**
+     * URL to send alerts to while processing the package. Any URL, including mailto (as per RFC 2368 and RFC 2822). Optional.
+     * @var string
+     */
+    protected $_alerts = null;
+	
+    /**
+     * Unstructured character string that may be used to transfer vendor-specific data such as processing hints or deployment information. Optional.
+     * @var string
+     */
+    protected $_vendor_data = null;
+	
+    /**
+     * Constructor
+     * 
+     * Constructs a PENSRequest based class using the arguments given
+     * 
+     * @param array Arguments
+     */
+    public function __construct($arguments) {
+        $this->setPensVersion($arguments["pens-version"]);
+        $this->setPackageType($arguments["package-type"]);
+        $this->setPackageTypeVersion($arguments["package-type-version"]);
+        $this->setPackageFormat($arguments["package-format"]);
+        $this->setPackageId($arguments["package-id"]);
+        $this->setPackageUrl($arguments["package-url"]);
+        $this->setPackageUrlUserId($arguments["package-url-user-id"]);
+        $this->setPackageUrlAccount($arguments["package-url-account"]);
+        $this->setPackageUrlPassword($arguments["package-url-password"]);
+        $this->setPackageUrlExpiry($arguments["package-url-expiry"]);
+        $this->setClient($arguments["client"]);
+        $this->setSystemUserId($arguments["system-user-id"]);
+        $this->setSystemPassword($arguments["system-password"]);
+        $this->setReceipt($arguments["receipt"]);
+        $this->setAlerts($arguments["alerts"]);
+        $this->setVendorData($arguments["vendor-data"]);
+    }
+	
+    public function getPensVersion() {
+        return $this->_pens_version;
+    }
+	
+    /**
+     * Sets the PENS version
+     * 
+     * @param string PENS version
+     * 
+     * @throws PENSException with code 2001 if invalid
+     */
+    public function setPensVersion($pens_version) {
+        if($pens_version == PENSConfig::$version) {
+            $this->_pens_version = $pens_version;
+        } else {
+            throw new PENSException(2001);
+        }
+    }
+	
+    public function getCommand() {
+        return $this->_command;
+    }
+	
+    /**
+     * Sets the command
+     * 
+     * @param string command
+     * 
+     * @throws PENSException with code 2002 if invalid
+     */
+    protected function setCommand($command) {
+        if(in_array($command, PENSConfig::$allowed_commands)) {
+            $this->_command = $command;
+        } else {
+            throw new PENSException(2002);
+        }
+    }
+	
+    public function getPackageType() {
+        return $this->_package_type;
+    }
+	
+    /**
+     * Sets the package type
+     * 
+     * @param string package type
+     * 
+     * @throws PENSException with code 2003 if invalid
+     */
+    public function setPackageType($package_type) {
+        if(in_array($package_type, PENSConfig::$allowed_package_types)) {
+            $this->_package_type = $package_type;
+        } else {
+            throw new PENSException(2003);
+        }
+    }
+	
+    public function getPackageTypeVersion() {
+        return $this->_package_type_version;
+    }
+	
+    /**
+     * Sets the package type version
+     * 
+     * @param string package type version
+     * 
+     * @throws PENSException with code 2004 if invalid
+     */
+    public function setPackageTypeVersion($package_type_version) {
+        if(empty($package_type_version)) {
+            throw new PENSException(2004);
+        } else {
+            $this->_package_type_version = $package_type_version;
+        }
+    }
+	
+    public function getPackageFormat() {
+        return $this->_package_format;
+    }
+	
+    /**
+     * Sets the package format
+     * 
+     * @param string package format
+     * 
+     * @throws PENSException with code 2005 if invalid
+     */
+    public function setPackageFormat($package_format) {
+        if(in_array($package_format, PENSConfig::$allowed_package_formats)) {
+            $this->_package_format = $package_format;
+        } else {
+            throw new PENSException(2005);
+        }
+    }
+	
+    public function getPackageId() {
+        return $this->_package_id;
+    }
+	
+    /**
+     * Sets the package Id
+     * 
+     * @param string package Id
+     * 
+     * @throws PENSException with code 2007 if invalid
+     */
+    public function setPackageId($package_id) {
+        if (preg_match('/'.ABSOLUTEURI_2396.'/', $package_id)) {
+            $this->_package_id = $package_id;
+        } else {
+            throw new PENSException(2007);
+        }
+    }
+	
+    public function getPackageUrl() {
+        return $this->_package_url;
+    }
+	
+    /**
+     * Sets the package url
+     * 
+     * @param string package url
+     * 
+     * @throws PENSException with code 2008 if invalid
+     */
+    public function setPackageUrl($package_url) {
+        if (preg_match('/'.ABSOLUTEURI_2396.'/', $package_url) && substr($package_url, -4) == ".".$this->_package_format) {
+            $this->_package_url = $package_url;
+        } else {
+            throw new PENSException(2008);
+        }
+    }
+	
+    public function getFilename() {
+        return substr(strrchr($this->_package_url, "/"), 1);
+    }
+	
+    public function getPackageUrlUserId() {
+        return $this->_package_url_user_id;
+    }
+	
+    public function setPackageUrlUserId($package_url_user_id) {
+        if(!empty($package_url_user_id)) {
+            $this->_package_url_user_id = $package_url_user_id;
+        }
+    }
+	
+    public function getPackageUrlAccount() {
+        return $this->_package_url_account;
+    }
+	
+    public function setPackageUrlAccount($package_url_account) {
+        if(!empty($package_url_account)) {
+            $this->_package_url_account = $package_url_account;
+        }
+    }
+	
+    public function getPackageUrlPassword() {
+        return $this->_package_url_password;
+    }
+	
+    public function setPackageUrlPassword($package_url_password) {
+        if(!empty($package_url_password)) {
+            $this->_package_url_password = $package_url_password;
+        }
+    }
+	
+    public function getPackageUrlExpiry() {
+        return $this->_package_url_expiry;
+    }
+	
+    /**
+     * Sets the package url expiry and transforms it into a php DateTime object
+     * 
+     * @param string package url expiry
+     * 
+     * @throws PENSException with code 2009 if invalid
+     * @todo Perform a better validation of the date
+     */
+    public function setPackageUrlExpiry($package_url_expiry) {
+        if(empty($package_url_expiry)) {
+            throw new PENSException(2009);
+        } else {
+            try {
+                $expiry = new DateTime($package_url_expiry, new DateTimeZone('UTC'));
+                $this->_package_url_expiry = $expiry;
+            } catch(Exception $e) {
+                throw new PENSException(2009);
+            }
+        }
+    }
+	
+    public function getClient() {
+        return $this->_client;
+    }
+	
+    /**
+     * Sets the client
+     * 
+     * @param string client
+     * 
+     * @throws PENSException with code 2010 if invalid
+     */
+    public function setClient($client) {
+        if(!empty($client)) {
+            $this->_client = $client;
+        } else {
+            throw new PENSException(2010);
+        }
+    }
+	
+    public function getSystemUserId() {
+        return $this->_system_user_id;
+    }
+	
+    public function setSystemUserId($system_user_id) {
+        if(!empty($system_user_id)) {
+            $this->_system_user_id = $system_user_id;
+        }
+    }
+	
+    public function getSystemPassword() {
+        return $this->_system_password;
+    }
+	
+    public function setSystemPassword($system_password) {
+        if(!empty($system_password)) {
+            $this->_system_password = $system_password;
+        }
+    }
+	
+    public function getReceipt() {
+        return $this->_receipt;
+    }
+	
+    /**
+     * Sets the receipt url
+     * 
+     * @param string receipt url
+     * 
+     * @throws PENSException with code 2011 if invalid
+     */
+    public function setReceipt($receipt) {
+        if($this instanceof PENSRequestCollect) {
+            if (preg_match('/'.ABSOLUTEURI_2396.'/', $receipt)) {
+                $this->_receipt = $receipt;
+            } else {
+                throw new PENSException(2011);
+            }
+        }
+    }
+	
+    public function getAlerts() {
+        return $this->_alerts;
+    }
+	
+    public function setAlerts($alerts) {
+        if(!empty($alerts)) {
+            if(preg_match('/'.ABSOLUTEURI_2396.'/', $alerts)) {
+                $this->_alerts = $alerts;
+            } else {
+                throw new PENSException(1201);
+            }
+        }
+    }
+	
+    public function getVendorData() {
+        return $this->_vendor_data;
+    }
+	
+    public function setVendorData($vendor_data) {
+        if(!empty($vendor_data)) {
+            $this->_vendor_data = $vendor_data;
+        }
+    }
+	
+    /**
+     * Returns an associative that contains all the fields needed to send a
+     * receipt or an alert to the client
+     * 
+     * @return array Associative array
+     */
+    protected function getSendReceiptAlertArray() {
+        return array("pens-version" => $this->getPensVersion(),
+            "package-type" => $this->getPackageType(),
+            "package-type-version" => $this->getPackageTypeVersion(),
+            "package-format" => $this->getPackageFormat(),
+            "package-id" => $this->getPackageId(),
+            "package-url" => $this->getPackageUrl(),
+            "package-url-expiry" => $this->getPackageUrlExpiry()->format(DateTime::ISO8601),
+            "client" => $this->getClient());
+    }
+	
+    /**
+     * Returns an associative that contains all the fields needed to send a
+     * receipt to the client
+     * 
+     * @return array Associative array
+     */
+    public function getSendReceiptArray() {
+        $receipt = $this->getSendReceiptAlertArray();
+        $receipt["command"] = "receipt";
+        return $receipt;
+    }
+	
+    /**
+     * Returns an associative that contains all the fields needed to send an
+     * alert to the client
+     * 
+     * @return array Associative array
+     */
+    public function getSendAlertArray() {
+        $alert = $this->getSendReceiptAlertArray();
+        $alert["command"] = "alert";
+        return $alert;
+    }
 	
 	
 }

plugin/pens/lib/pens/pens_config.php

Indentation +43 added lines, -43 removed lines

@@ -16,54 +16,54 @@
  * along with php-pens.  If not, see <http://www.gnu.org/licenses/>.
  */
  
- /**
- * PENSConfig
- * 
- * Provides the PENSConfig class
- * 
- * @package PENS
- * @author Guillaume Viguier-Just <guillaume@viguierjust.com>
- * @licence http://www.gnu.org/licenses/gpl.txt
- */
+    /**
+     * PENSConfig
+     * 
+     * Provides the PENSConfig class
+     * 
+     * @package PENS
+     * @author Guillaume Viguier-Just <guillaume@viguierjust.com>
+     * @licence http://www.gnu.org/licenses/gpl.txt
+     */
  
- /**
- * PENSConfig
- * 
- * This class provides different static variables to configure php-pens.
- * 
- * @package PENS
- * @author Guillaume Viguier-Just <guillaume@viguierjust.com>
- * @licence http://www.gnu.org/licenses/gpl.txt
- */
+    /**
+     * PENSConfig
+     * 
+     * This class provides different static variables to configure php-pens.
+     * 
+     * @package PENS
+     * @author Guillaume Viguier-Just <guillaume@viguierjust.com>
+     * @licence http://www.gnu.org/licenses/gpl.txt
+     */
 class PENSConfig {
 
-	/**
-	 * PENS version
-	 * @var string
-	 */
-	public static $version = "1.0.0";
+    /**
+     * PENS version
+     * @var string
+     */
+    public static $version = "1.0.0";
 	
-	/**
-	 * Allowed commands
-	 * @var array
-	 */
-	public static $allowed_commands = array("collect", "receipt", "alert");
+    /**
+     * Allowed commands
+     * @var array
+     */
+    public static $allowed_commands = array("collect", "receipt", "alert");
 	
-	/**
-	 * Allowed package types
-	 * @var array
-	 */
-	public static $allowed_package_types = array("aicc-pkg", "scorm-pif", "ims-qti");
+    /**
+     * Allowed package types
+     * @var array
+     */
+    public static $allowed_package_types = array("aicc-pkg", "scorm-pif", "ims-qti");
 	
-	/**
-	 * Allowed package formats
-	 * @var array
-	 */
-	public static $allowed_package_formats = array("zip", "url", "jar", "war", "xml");
+    /**
+     * Allowed package formats
+     * @var array
+     */
+    public static $allowed_package_formats = array("zip", "url", "jar", "war", "xml");
 	
-	/**
-	 * End of line as specified by the PENS specification
-	 * @var string
-	 */
-	public static $eol = "\r\n";
+    /**
+     * End of line as specified by the PENS specification
+     * @var string
+     */
+    public static $eol = "\r\n";
 }

plugin/pens/lib/pens/pens_exception.php

Indentation +55 added lines, -55 removed lines

@@ -37,62 +37,62 @@
  */
 class PENSException extends Exception {
 
-	/**
-	 * Array that provides an association between exception codes and messages
-	 * @var array
-	 */
-	protected static $_code_to_messages = array(
-		1101 => "Unable to parse PENS command",
-		1201 => "Attempt to pass an invalid argument",
-		1301 => "Unable to retrieve package",
-		1302 => "Unable to retrieve package via HTTPS",
-		1304 => "Unable to retrieve package via FTP",
-		1306 => "Unable to retrieve package via FTPS",
-		1310 => "Unable to retrieve package at specified URL due to error in URL or lack of response from URL",
-		1312 => "Unable to retrieve package at specified URL due to error with access credential for package URL",
-		1320 => "Expiration date is non-null and in an improper format",
-		1322 => "Current time indicates expiry date has passed",
-		1420 => "PENS version not supported",
-		1421 => "Command not supported",
-		1430 => "Package type not supported",
-		// The following error code is not specified in the PENS specification and was added in this implementation
-		1431 => "Package format not supported",
-		1432 => "Internal package error",
-		1440 => "Insufficient host space/storage available",
-		1500 => "Unable to communicate with provided acknowledgement URL",
-		1510 => "Unsupported acknowledgement protocol",
-		1520 => "Unsupported alert protocol",
-		2001 => "PENS version invalid or not specified",
-		2002 => "PENS command invalid or not specified",
-		2003 => "package-type invalid or not specified",
-		2004 => "package-type-version invalid or not specified",
-		2005 => "package-format invalid or not specified",
-		2007 => "package-id invalid or not specified",
-		2008 => "package-url invalid or not specified",
-		2009 => "package-url-expiry date invalid or not specified",
-		2010 => "client submitting package invalid or not specified",
-		2011 => "receipt url invalid or not specified"
-	);
+    /**
+     * Array that provides an association between exception codes and messages
+     * @var array
+     */
+    protected static $_code_to_messages = array(
+        1101 => "Unable to parse PENS command",
+        1201 => "Attempt to pass an invalid argument",
+        1301 => "Unable to retrieve package",
+        1302 => "Unable to retrieve package via HTTPS",
+        1304 => "Unable to retrieve package via FTP",
+        1306 => "Unable to retrieve package via FTPS",
+        1310 => "Unable to retrieve package at specified URL due to error in URL or lack of response from URL",
+        1312 => "Unable to retrieve package at specified URL due to error with access credential for package URL",
+        1320 => "Expiration date is non-null and in an improper format",
+        1322 => "Current time indicates expiry date has passed",
+        1420 => "PENS version not supported",
+        1421 => "Command not supported",
+        1430 => "Package type not supported",
+        // The following error code is not specified in the PENS specification and was added in this implementation
+        1431 => "Package format not supported",
+        1432 => "Internal package error",
+        1440 => "Insufficient host space/storage available",
+        1500 => "Unable to communicate with provided acknowledgement URL",
+        1510 => "Unsupported acknowledgement protocol",
+        1520 => "Unsupported alert protocol",
+        2001 => "PENS version invalid or not specified",
+        2002 => "PENS command invalid or not specified",
+        2003 => "package-type invalid or not specified",
+        2004 => "package-type-version invalid or not specified",
+        2005 => "package-format invalid or not specified",
+        2007 => "package-id invalid or not specified",
+        2008 => "package-url invalid or not specified",
+        2009 => "package-url-expiry date invalid or not specified",
+        2010 => "client submitting package invalid or not specified",
+        2011 => "receipt url invalid or not specified"
+    );
 	
-	/**
-	 * Redefines the constructor so that code is the first argument
-	 * 
-	 * @param int Exception code
-	 * @param string Message to display
-	 * @return PENSException Exception created
-	 */
-	public function __construct($code, $message = null) {
-		parent::__construct($message, $code);
-		$this->setMessageBasedOnCode();
-	}
+    /**
+     * Redefines the constructor so that code is the first argument
+     * 
+     * @param int Exception code
+     * @param string Message to display
+     * @return PENSException Exception created
+     */
+    public function __construct($code, $message = null) {
+        parent::__construct($message, $code);
+        $this->setMessageBasedOnCode();
+    }
 	
-	/**
-	 * Sets the message based on the code
-	 */
-	protected function setMessageBasedOnCode() {
-		if(empty($this->message) && !empty(self::$_code_to_messages[$this->code])) {
-			$this->message = self::$_code_to_messages[$this->code];
-		}
-	}
+    /**
+     * Sets the message based on the code
+     */
+    protected function setMessageBasedOnCode() {
+        if(empty($this->message) && !empty(self::$_code_to_messages[$this->code])) {
+            $this->message = self::$_code_to_messages[$this->code];
+        }
+    }
 	
 }

plugin/pens/pens.php

Indentation +13 added lines, -13 removed lines

@@ -29,19 +29,19 @@
 require_once __DIR__ . '/chamilo_pens.php';
 
 class ChamiloPackageHandler extends PENSPackageHandler {
-	public function processPackage($request, $path_to_package) {
-		$server = PENSServer::singleton();
-		// Moves the package to archive/pens
-		$path_to_archives = api_get_path(SYS_ARCHIVE_PATH) . 'pens';
-		if(!is_dir($path_to_archives)) {
-			mkdir($path_to_archives, 0777, true);
-		}
-		rename($path_to_package, $path_to_archives . '/' . $request->getFilename());
-		// Insert the request in the database
-		$chamilo_pens = new ChamiloPens($request);
-		$chamilo_pens->save();
-		$server->sendAlert($request, new PENSResponse(0, 'Package successfully processed'));
-	}
+    public function processPackage($request, $path_to_package) {
+        $server = PENSServer::singleton();
+        // Moves the package to archive/pens
+        $path_to_archives = api_get_path(SYS_ARCHIVE_PATH) . 'pens';
+        if(!is_dir($path_to_archives)) {
+            mkdir($path_to_archives, 0777, true);
+        }
+        rename($path_to_package, $path_to_archives . '/' . $request->getFilename());
+        // Insert the request in the database
+        $chamilo_pens = new ChamiloPens($request);
+        $chamilo_pens->save();
+        $server->sendAlert($request, new PENSResponse(0, 'Package successfully processed'));
+    }
 }
 
 $handler = new ChamiloPackageHandler();