Passed
Push — 1.10.x ( 5654d2...115d5a )
by Yannick
263:14 queued 212:07
created
custompages/registration-feedback-dist.php 1 patch
Indentation   +5 added lines, -5 removed lines patch added patch discarded remove patch
@@ -1,12 +1,12 @@
 block discarded – undo
1 1
 <?php
2 2
 /* For licensing terms, see /license.txt */
3 3
 /**
4
- * Quick display for user registration
5
- * @package chamilo.custompages
6
- */
4
+             * Quick display for user registration
5
+             * @package chamilo.custompages
6
+             */
7 7
 /**
8
- * HTML output
9
- */
8
+             * HTML output
9
+             */
10 10
 require_once('language.php');
11 11
 $rootWeb = api_get_path('WEB_PATH');
12 12
 
Please login to merge, or discard this patch.
custompages/language.inc.php 1 patch
Indentation   +10 added lines, -10 removed lines patch added patch discarded remove patch
@@ -29,11 +29,11 @@  discard block
 block discarded – undo
29 29
     krsort($langs, SORT_NUMERIC);
30 30
     // Choosing the best match
31 31
     foreach($langs as $weight => $codes) {
32
-		foreach ($codes as $code) {
33
-        	if (in_array($code, $available_langs)) {
34
-            	return $code;
35
-        	}
36
-		}
32
+        foreach ($codes as $code) {
33
+            if (in_array($code, $available_langs)) {
34
+                return $code;
35
+            }
36
+        }
37 37
     }
38 38
     // No match
39 39
     return null;
@@ -44,11 +44,11 @@  discard block
 block discarded – undo
44 44
  * use this if you want to avoid translation caching issues
45 45
  */
46 46
 function cp_get_lang($variable) {
47
-	return get_lang($variable, null, $_SESSION['user_language_choice']);
47
+    return get_lang($variable, null, $_SESSION['user_language_choice']);
48 48
 }
49 49
 /**
50
- * Code
51
- */
50
+     * Code
51
+     */
52 52
 // Note that Chamilo languages are expressed as full english names, not 2-characters codes
53 53
 // e.g. 'english' instead of 'en', 'french' instead of 'fr', ...
54 54
 // We need a matching array. Note the value for the null key, which is the default language.
@@ -63,12 +63,12 @@  discard block
 block discarded – undo
63 63
 
64 64
 // Chamilo overrides this parameters at some places, e.g. in the logout link
65 65
 if (isset($_REQUEST['language']) && !empty($_REQUEST['language']) && in_array($_REQUEST['language'], $chamilo_langs)) {
66
-	$lang_match = $_REQUEST['language'];
66
+    $lang_match = $_REQUEST['language'];
67 67
 }
68 68
 
69 69
 // Maybe a language had already been selected, we should honor this
70 70
 if (isset($_SESSION['user_language_choice']) && in_array($_SESSION['user_language_choice'], $chamilo_langs)) {
71
-	$lang_match = $_SESSION['user_language_choice'];
71
+    $lang_match = $_SESSION['user_language_choice'];
72 72
 }
73 73
 
74 74
 // We need to set the relevant session variables to the best match, to use Chamilo's i18n lib.
Please login to merge, or discard this patch.
whoisonlinesession.php 1 patch
Indentation   +39 added lines, -39 removed lines patch added patch discarded remove patch
@@ -41,10 +41,10 @@  discard block
 block discarded – undo
41 41
 		</th>
42 42
 	</tr>
43 43
 <?php
44
-	$session_is_coach = array();
45
-	if (isset($_user['user_id']) && $_user['user_id'] != '') {
46
-		$_user['user_id'] = intval($_user['user_id']);
47
-		$sql = "SELECT DISTINCT session.id,
44
+    $session_is_coach = array();
45
+    if (isset($_user['user_id']) && $_user['user_id'] != '') {
46
+        $_user['user_id'] = intval($_user['user_id']);
47
+        $sql = "SELECT DISTINCT session.id,
48 48
 					name,
49 49
 					access_start_date,
50 50
 					access_end_date
@@ -53,13 +53,13 @@  discard block
 block discarded – undo
53 53
 					ON srcru.user_id = ".$_user['user_id']." AND srcru.status=2
54 54
 					AND session.id = srcru.session_id
55 55
 				ORDER BY access_start_date, access_end_date, name";
56
-		$result = Database::query($sql);
56
+        $result = Database::query($sql);
57 57
 
58
-		while ($session = Database:: fetch_array($result)) {
59
-			$session_is_coach[$session['id']] = $session;
60
-		}
58
+        while ($session = Database:: fetch_array($result)) {
59
+            $session_is_coach[$session['id']] = $session;
60
+        }
61 61
 
62
-		$sql = "SELECT DISTINCT session.id,
62
+        $sql = "SELECT DISTINCT session.id,
63 63
 					name,
64 64
 					access_start_date,
65 65
 					access_end_date
@@ -67,9 +67,9 @@  discard block
 block discarded – undo
67 67
 				WHERE session.id_coach = ".$_user['user_id']."
68 68
 				ORDER BY access_start_date, access_end_date, name";
69 69
         $result = Database::query($sql);
70
-		while ($session = Database:: fetch_array($result)) {
71
-			$session_is_coach[$session['id']] = $session;
72
-		}
70
+        while ($session = Database:: fetch_array($result)) {
71
+            $session_is_coach[$session['id']] = $session;
72
+        }
73 73
 
74 74
         if (empty($time_limit)) {
75 75
             $time_limit = api_get_setting('time_limit_whosonline');
@@ -82,7 +82,7 @@  discard block
 block discarded – undo
82 82
 
83 83
         $students_online = array();
84 84
         foreach ($session_is_coach as $session) {
85
-			$sql = "SELECT DISTINCT last_access.access_user_id,
85
+            $sql = "SELECT DISTINCT last_access.access_user_id,
86 86
 						last_access.access_date,
87 87
 						last_access.c_id,
88 88
 						last_access.access_session_id,
@@ -95,49 +95,49 @@  discard block
 block discarded – undo
95 95
 					AND access_date >= '$current_date'
96 96
 					GROUP BY access_user_id";
97 97
 
98
-			$result = Database::query($sql);
98
+            $result = Database::query($sql);
99 99
 
100
-			while($user_list = Database::fetch_array($result)) {
101
-				$students_online[$user_list['access_user_id']] = $user_list;
102
-			}
103
-		}
100
+            while($user_list = Database::fetch_array($result)) {
101
+                $students_online[$user_list['access_user_id']] = $user_list;
102
+            }
103
+        }
104 104
 
105
-		if (count($students_online) > 0) {
106
-			foreach ($students_online as $student_online) {
107
-				echo "<tr>
105
+        if (count($students_online) > 0) {
106
+            foreach ($students_online as $student_online) {
107
+                echo "<tr>
108 108
 						<td>
109 109
 					";
110
-				echo $student_online['name'];
111
-				echo "	</td>
110
+                echo $student_online['name'];
111
+                echo "	</td>
112 112
 						<td align='center'>
113 113
 					 ";
114
-				$courseInfo = api_get_course_info_by_id($student_online['c_id']);
115
-				echo $courseInfo['title'];
116
-				echo "	</td>
114
+                $courseInfo = api_get_course_info_by_id($student_online['c_id']);
115
+                echo $courseInfo['title'];
116
+                echo "	</td>
117 117
 						<td align='center'>
118 118
 					 ";
119
-							 if (!empty($student_online['email'])) {
120
-								echo $student_online['email'];
121
-							 } else {
122
-							 	echo get_lang('NoEmail');
123
-							 }
124
-				echo "	</td>
119
+                                if (!empty($student_online['email'])) {
120
+                                echo $student_online['email'];
121
+                                } else {
122
+                                    echo get_lang('NoEmail');
123
+                                }
124
+                echo "	</td>
125 125
 						<td align='center'>
126 126
 					 ";
127
-				echo '<a href="main/chat/chat.php?cidReq='.$courseInfo['code'].'&id_session='.$student_online['access_session_id'].'"> -> </a>';
128
-				echo "	</td>
127
+                echo '<a href="main/chat/chat.php?cidReq='.$courseInfo['code'].'&id_session='.$student_online['access_session_id'].'"> -> </a>';
128
+                echo "	</td>
129 129
 					</tr>
130 130
 					 ";
131
-			}
132
-		} else {
133
-			echo '	<tr>
131
+            }
132
+        } else {
133
+            echo '	<tr>
134 134
 						<td colspan="4">
135 135
 							'.get_lang('NoOnlineStudents').'
136 136
 						</td>
137 137
 					</tr>
138 138
 				 ';
139
-		}
140
-	}
139
+        }
140
+    }
141 141
 ?>
142 142
 </table>
143 143
 <?php
Please login to merge, or discard this patch.
plugin/jcapture/plugin.php 1 patch
Indentation   +4 added lines, -4 removed lines patch added patch discarded remove patch
@@ -1,9 +1,9 @@
 block discarded – undo
1 1
 <?php
2 2
 /**
3
- * Screencast widget
4
- * jcapture docs
5
- * http://www.nasdanika.com/wiki/doku.php?id=products:jcapture:start
6
- */
3
+     * Screencast widget
4
+     * jcapture docs
5
+     * http://www.nasdanika.com/wiki/doku.php?id=products:jcapture:start
6
+     */
7 7
 $plugin_info = array(
8 8
     'title' => 'Jcapture Screencast',
9 9
     'comment' => "Screencast widget",
Please login to merge, or discard this patch.
plugin/show_user_info/plugin.php 1 patch
Indentation   +7 added lines, -7 removed lines patch added patch discarded remove patch
@@ -1,13 +1,13 @@
 block discarded – undo
1 1
 <?php
2 2
 /**
3
- * This script is a configuration file for the date plugin. You can use it as a master for other platform plugins (course plugins are slightly different).
4
- * These settings will be used in the administration interface for plugins (Chamilo configuration settings->Plugins)
5
- * @package chamilo.plugin
6
- * @author Julio Montoya <[email protected]>
7
- */
3
+     * This script is a configuration file for the date plugin. You can use it as a master for other platform plugins (course plugins are slightly different).
4
+     * These settings will be used in the administration interface for plugins (Chamilo configuration settings->Plugins)
5
+     * @package chamilo.plugin
6
+     * @author Julio Montoya <[email protected]>
7
+     */
8 8
 /**
9
- * Plugin details (must be present)
10
- */
9
+     * Plugin details (must be present)
10
+     */
11 11
 
12 12
 //the plugin title
13 13
 $plugin_info['title']      = 'Add a button to logout from CAS';
Please login to merge, or discard this patch.
plugin/formLogin_hide_unhide/plugin.php 1 patch
Indentation   +7 added lines, -7 removed lines patch added patch discarded remove patch
@@ -1,13 +1,13 @@
 block discarded – undo
1 1
 <?php
2 2
 /**
3
- * This script is a configuration file for the date plugin. You can use it as a master for other platform plugins (course plugins are slightly different).
4
- * These settings will be used in the administration interface for plugins (Chamilo configuration settings->Plugins)
5
- * @package chamilo.plugin
6
- * @author Julio Montoya <[email protected]>
7
- */
3
+     * This script is a configuration file for the date plugin. You can use it as a master for other platform plugins (course plugins are slightly different).
4
+     * These settings will be used in the administration interface for plugins (Chamilo configuration settings->Plugins)
5
+     * @package chamilo.plugin
6
+     * @author Julio Montoya <[email protected]>
7
+     */
8 8
 /**
9
- * Plugin details (must be present)
10
- */
9
+     * Plugin details (must be present)
10
+     */
11 11
 
12 12
 //the plugin title
13 13
 $plugin_info['title']      = 'Add a button to logout from CAS';
Please login to merge, or discard this patch.
plugin/pens/lib/pens/pens_request.php 1 patch
Indentation   +447 added lines, -447 removed lines patch added patch discarded remove patch
@@ -43,453 +43,453 @@
 block discarded – undo
43 43
 
44 44
 abstract class PENSRequest extends PENSMessage {
45 45
 
46
-	/**
47
-	 * PENS Version to be used. Currently, the only valid value is 1.0.0. Required.
48
-	 * @var string
49
-	 */
50
-	protected $_pens_version = null;
51
-	
52
-	/**
53
-	 * Command being used. The only valid values are collect, alert and receipt.Required
54
-	 * @var string
55
-	 */
56
-	protected $_command = null;
57
-	
58
-	/**
59
-	 * Package type being used. The only valid values are aicc-pkg, scorm-pif, ims-qti. Required
60
-	 * @var string
61
-	 */
62
-	protected $_package_type = null;
63
-	
64
-	/**
65
-	 * Package type version. Required
66
-	 * @var string
67
-	 */
68
-	protected $_package_type_version = null;
69
-	
70
-	/**
71
-	 * Package format. The only valid values are zip, url, jar, war and xml. Required
72
-	 * @var string
73
-	 */
74
-	protected $_package_format = null;
75
-	
76
-	/**
77
-	 * Package id. Requires a valid URI according to RFC 2396. Required
78
-	 * @var string
79
-	 */
80
-	protected $_package_id = null;
81
-	
82
-	/**
83
-	 * Package url. Requires a valid, fully qualified URL including transport protocol and filename extension. Required
84
-	 * @var string
85
-	 */
86
-	protected $_package_url = null;
87
-	
88
-	/**
89
-	 * User id required for system to retrieve package from URL. Optional.
90
-	 * @var string
91
-	 */
92
-	protected $_package_url_user_id = null;
93
-	
94
-	/**
95
-	 * Account required for system to retrieve package from URL. Optional.
96
-	 * @var string
97
-	 */
98
-	protected $_package_url_account = null;
99
-	
100
-	/**
101
-	 * Password required for system to retrieve package from URL. Optional.
102
-	 * @var string
103
-	 */
104
-	protected $_package_url_password = null;
105
-	
106
-	/**
107
-	 * Expiry date for package URL. ISO 8601 format expressed as UTC. Will be transformed into a PHP DateTime object during construction. Required
108
-	 * @var DateTime
109
-	 */
110
-	protected $_package_url_expiry = null;
111
-	
112
-	/**
113
-	 * Name or ID for client submitting the content package to the target system. Required.
114
-	 * @var string
115
-	 */
116
-	protected $_client = null;
117
-	
118
-	/**
119
-	 * User-id or sign-on for target system. Optional
120
-	 * @var string
121
-	 */
122
-	protected $_system_user_id = null;
123
-	
124
-	/**
125
-	 * Either a URL-encoded password token or the null string. If the 
126
-	 * target system requires a password and the null string value is 
127
-	 * passed, then the target system is responsible for prompting for a 
128
-	 * password for target system. Optional
129
-	 * @var string
130
-	 */
131
-	protected $_system_password = null;
132
-	
133
-	/**
134
-	 * URL to send acknowledgement receipt after collecting a package. Any URL, including mailto (as per RFC 2368 and RFC 2822). Required.
135
-	 * @var string
136
-	 */
137
-	protected $_receipt = null;
138
-	
139
-	/**
140
-	 * URL to send alerts to while processing the package. Any URL, including mailto (as per RFC 2368 and RFC 2822). Optional.
141
-	 * @var string
142
-	 */
143
-	protected $_alerts = null;
144
-	
145
-	/**
146
-	 * Unstructured character string that may be used to transfer vendor-specific data such as processing hints or deployment information. Optional.
147
-	 * @var string
148
-	 */
149
-	protected $_vendor_data = null;
150
-	
151
-	/**
152
-	 * Constructor
153
-	 * 
154
-	 * Constructs a PENSRequest based class using the arguments given
155
-	 * 
156
-	 * @param array Arguments
157
-	 */
158
-	public function __construct($arguments) {
159
-		$this->setPensVersion($arguments["pens-version"]);
160
-		$this->setPackageType($arguments["package-type"]);
161
-		$this->setPackageTypeVersion($arguments["package-type-version"]);
162
-		$this->setPackageFormat($arguments["package-format"]);
163
-		$this->setPackageId($arguments["package-id"]);
164
-		$this->setPackageUrl($arguments["package-url"]);
165
-		$this->setPackageUrlUserId($arguments["package-url-user-id"]);
166
-		$this->setPackageUrlAccount($arguments["package-url-account"]);
167
-		$this->setPackageUrlPassword($arguments["package-url-password"]);
168
-		$this->setPackageUrlExpiry($arguments["package-url-expiry"]);
169
-		$this->setClient($arguments["client"]);
170
-		$this->setSystemUserId($arguments["system-user-id"]);
171
-		$this->setSystemPassword($arguments["system-password"]);
172
-		$this->setReceipt($arguments["receipt"]);
173
-		$this->setAlerts($arguments["alerts"]);
174
-		$this->setVendorData($arguments["vendor-data"]);
175
-	}
176
-	
177
-	public function getPensVersion() {
178
-		return $this->_pens_version;
179
-	}
180
-	
181
-	/**
182
-	 * Sets the PENS version
183
-	 * 
184
-	 * @param string PENS version
185
-	 * 
186
-	 * @throws PENSException with code 2001 if invalid
187
-	 */
188
-	public function setPensVersion($pens_version) {
189
-		if($pens_version == PENSConfig::$version) {
190
-			$this->_pens_version = $pens_version;
191
-		} else {
192
-			throw new PENSException(2001);
193
-		}
194
-	}
195
-	
196
-	public function getCommand() {
197
-		return $this->_command;
198
-	}
199
-	
200
-	/**
201
-	 * Sets the command
202
-	 * 
203
-	 * @param string command
204
-	 * 
205
-	 * @throws PENSException with code 2002 if invalid
206
-	 */
207
-	protected function setCommand($command) {
208
-		if(in_array($command, PENSConfig::$allowed_commands)) {
209
-			$this->_command = $command;
210
-		} else {
211
-			throw new PENSException(2002);
212
-		}
213
-	}
214
-	
215
-	public function getPackageType() {
216
-		return $this->_package_type;
217
-	}
218
-	
219
-	/**
220
-	 * Sets the package type
221
-	 * 
222
-	 * @param string package type
223
-	 * 
224
-	 * @throws PENSException with code 2003 if invalid
225
-	 */
226
-	public function setPackageType($package_type) {
227
-		if(in_array($package_type, PENSConfig::$allowed_package_types)) {
228
-			$this->_package_type = $package_type;
229
-		} else {
230
-			throw new PENSException(2003);
231
-		}
232
-	}
233
-	
234
-	public function getPackageTypeVersion() {
235
-		return $this->_package_type_version;
236
-	}
237
-	
238
-	/**
239
-	 * Sets the package type version
240
-	 * 
241
-	 * @param string package type version
242
-	 * 
243
-	 * @throws PENSException with code 2004 if invalid
244
-	 */
245
-	public function setPackageTypeVersion($package_type_version) {
246
-		if(empty($package_type_version)) {
247
-			throw new PENSException(2004);
248
-		} else {
249
-			$this->_package_type_version = $package_type_version;
250
-		}
251
-	}
252
-	
253
-	public function getPackageFormat() {
254
-		return $this->_package_format;
255
-	}
256
-	
257
-	/**
258
-	 * Sets the package format
259
-	 * 
260
-	 * @param string package format
261
-	 * 
262
-	 * @throws PENSException with code 2005 if invalid
263
-	 */
264
-	public function setPackageFormat($package_format) {
265
-		if(in_array($package_format, PENSConfig::$allowed_package_formats)) {
266
-			$this->_package_format = $package_format;
267
-		} else {
268
-			throw new PENSException(2005);
269
-		}
270
-	}
271
-	
272
-	public function getPackageId() {
273
-		return $this->_package_id;
274
-	}
275
-	
276
-	/**
277
-	 * Sets the package Id
278
-	 * 
279
-	 * @param string package Id
280
-	 * 
281
-	 * @throws PENSException with code 2007 if invalid
282
-	 */
283
-	public function setPackageId($package_id) {
284
-		if (preg_match('/'.ABSOLUTEURI_2396.'/', $package_id)) {
285
-			$this->_package_id = $package_id;
286
-		} else {
287
-			throw new PENSException(2007);
288
-		}
289
-	}
290
-	
291
-	public function getPackageUrl() {
292
-		return $this->_package_url;
293
-	}
294
-	
295
-	/**
296
-	 * Sets the package url
297
-	 * 
298
-	 * @param string package url
299
-	 * 
300
-	 * @throws PENSException with code 2008 if invalid
301
-	 */
302
-	public function setPackageUrl($package_url) {
303
-		if (preg_match('/'.ABSOLUTEURI_2396.'/', $package_url) && substr($package_url, -4) == ".".$this->_package_format) {
304
-			$this->_package_url = $package_url;
305
-		} else {
306
-			throw new PENSException(2008);
307
-		}
308
-	}
309
-	
310
-	public function getFilename() {
311
-		return substr(strrchr($this->_package_url, "/"), 1);
312
-	}
313
-	
314
-	public function getPackageUrlUserId() {
315
-		return $this->_package_url_user_id;
316
-	}
317
-	
318
-	public function setPackageUrlUserId($package_url_user_id) {
319
-		if(!empty($package_url_user_id)) {
320
-			$this->_package_url_user_id = $package_url_user_id;
321
-		}
322
-	}
323
-	
324
-	public function getPackageUrlAccount() {
325
-		return $this->_package_url_account;
326
-	}
327
-	
328
-	public function setPackageUrlAccount($package_url_account) {
329
-		if(!empty($package_url_account)) {
330
-			$this->_package_url_account = $package_url_account;
331
-		}
332
-	}
333
-	
334
-	public function getPackageUrlPassword() {
335
-		return $this->_package_url_password;
336
-	}
337
-	
338
-	public function setPackageUrlPassword($package_url_password) {
339
-		if(!empty($package_url_password)) {
340
-			$this->_package_url_password = $package_url_password;
341
-		}
342
-	}
343
-	
344
-	public function getPackageUrlExpiry() {
345
-		return $this->_package_url_expiry;
346
-	}
347
-	
348
-	/**
349
-	 * Sets the package url expiry and transforms it into a php DateTime object
350
-	 * 
351
-	 * @param string package url expiry
352
-	 * 
353
-	 * @throws PENSException with code 2009 if invalid
354
-	 * @todo Perform a better validation of the date
355
-	 */
356
-	public function setPackageUrlExpiry($package_url_expiry) {
357
-		if(empty($package_url_expiry)) {
358
-			throw new PENSException(2009);
359
-		} else {
360
-			try {
361
-				$expiry = new DateTime($package_url_expiry, new DateTimeZone('UTC'));
362
-				$this->_package_url_expiry = $expiry;
363
-			} catch(Exception $e) {
364
-				throw new PENSException(2009);
365
-			}
366
-		}
367
-	}
368
-	
369
-	public function getClient() {
370
-		return $this->_client;
371
-	}
372
-	
373
-	/**
374
-	 * Sets the client
375
-	 * 
376
-	 * @param string client
377
-	 * 
378
-	 * @throws PENSException with code 2010 if invalid
379
-	 */
380
-	public function setClient($client) {
381
-		if(!empty($client)) {
382
-			$this->_client = $client;
383
-		} else {
384
-			throw new PENSException(2010);
385
-		}
386
-	}
387
-	
388
-	public function getSystemUserId() {
389
-		return $this->_system_user_id;
390
-	}
391
-	
392
-	public function setSystemUserId($system_user_id) {
393
-		if(!empty($system_user_id)) {
394
-			$this->_system_user_id = $system_user_id;
395
-		}
396
-	}
397
-	
398
-	public function getSystemPassword() {
399
-		return $this->_system_password;
400
-	}
401
-	
402
-	public function setSystemPassword($system_password) {
403
-		if(!empty($system_password)) {
404
-			$this->_system_password = $system_password;
405
-		}
406
-	}
407
-	
408
-	public function getReceipt() {
409
-		return $this->_receipt;
410
-	}
411
-	
412
-	/**
413
-	 * Sets the receipt url
414
-	 * 
415
-	 * @param string receipt url
416
-	 * 
417
-	 * @throws PENSException with code 2011 if invalid
418
-	 */
419
-	public function setReceipt($receipt) {
420
-		if($this instanceof PENSRequestCollect) {
421
-			if (preg_match('/'.ABSOLUTEURI_2396.'/', $receipt)) {
422
-				$this->_receipt = $receipt;
423
-			} else {
424
-				throw new PENSException(2011);
425
-			}
426
-		}
427
-	}
428
-	
429
-	public function getAlerts() {
430
-		return $this->_alerts;
431
-	}
432
-	
433
-	public function setAlerts($alerts) {
434
-		if(!empty($alerts)) {
435
-			if(preg_match('/'.ABSOLUTEURI_2396.'/', $alerts)) {
436
-				$this->_alerts = $alerts;
437
-			} else {
438
-				throw new PENSException(1201);
439
-			}
440
-		}
441
-	}
442
-	
443
-	public function getVendorData() {
444
-		return $this->_vendor_data;
445
-	}
446
-	
447
-	public function setVendorData($vendor_data) {
448
-		if(!empty($vendor_data)) {
449
-			$this->_vendor_data = $vendor_data;
450
-		}
451
-	}
452
-	
453
-	/**
454
-	 * Returns an associative that contains all the fields needed to send a
455
-	 * receipt or an alert to the client
456
-	 * 
457
-	 * @return array Associative array
458
-	 */
459
-	protected function getSendReceiptAlertArray() {
460
-		return array("pens-version" => $this->getPensVersion(),
461
-			"package-type" => $this->getPackageType(),
462
-			"package-type-version" => $this->getPackageTypeVersion(),
463
-			"package-format" => $this->getPackageFormat(),
464
-			"package-id" => $this->getPackageId(),
465
-			"package-url" => $this->getPackageUrl(),
466
-			"package-url-expiry" => $this->getPackageUrlExpiry()->format(DateTime::ISO8601),
467
-			"client" => $this->getClient());
468
-	}
469
-	
470
-	/**
471
-	 * Returns an associative that contains all the fields needed to send a
472
-	 * receipt to the client
473
-	 * 
474
-	 * @return array Associative array
475
-	 */
476
-	public function getSendReceiptArray() {
477
-		$receipt = $this->getSendReceiptAlertArray();
478
-		$receipt["command"] = "receipt";
479
-		return $receipt;
480
-	}
481
-	
482
-	/**
483
-	 * Returns an associative that contains all the fields needed to send an
484
-	 * alert to the client
485
-	 * 
486
-	 * @return array Associative array
487
-	 */
488
-	public function getSendAlertArray() {
489
-		$alert = $this->getSendReceiptAlertArray();
490
-		$alert["command"] = "alert";
491
-		return $alert;
492
-	}
46
+    /**
47
+     * PENS Version to be used. Currently, the only valid value is 1.0.0. Required.
48
+     * @var string
49
+     */
50
+    protected $_pens_version = null;
51
+	
52
+    /**
53
+     * Command being used. The only valid values are collect, alert and receipt.Required
54
+     * @var string
55
+     */
56
+    protected $_command = null;
57
+	
58
+    /**
59
+     * Package type being used. The only valid values are aicc-pkg, scorm-pif, ims-qti. Required
60
+     * @var string
61
+     */
62
+    protected $_package_type = null;
63
+	
64
+    /**
65
+     * Package type version. Required
66
+     * @var string
67
+     */
68
+    protected $_package_type_version = null;
69
+	
70
+    /**
71
+     * Package format. The only valid values are zip, url, jar, war and xml. Required
72
+     * @var string
73
+     */
74
+    protected $_package_format = null;
75
+	
76
+    /**
77
+     * Package id. Requires a valid URI according to RFC 2396. Required
78
+     * @var string
79
+     */
80
+    protected $_package_id = null;
81
+	
82
+    /**
83
+     * Package url. Requires a valid, fully qualified URL including transport protocol and filename extension. Required
84
+     * @var string
85
+     */
86
+    protected $_package_url = null;
87
+	
88
+    /**
89
+     * User id required for system to retrieve package from URL. Optional.
90
+     * @var string
91
+     */
92
+    protected $_package_url_user_id = null;
93
+	
94
+    /**
95
+     * Account required for system to retrieve package from URL. Optional.
96
+     * @var string
97
+     */
98
+    protected $_package_url_account = null;
99
+	
100
+    /**
101
+     * Password required for system to retrieve package from URL. Optional.
102
+     * @var string
103
+     */
104
+    protected $_package_url_password = null;
105
+	
106
+    /**
107
+     * Expiry date for package URL. ISO 8601 format expressed as UTC. Will be transformed into a PHP DateTime object during construction. Required
108
+     * @var DateTime
109
+     */
110
+    protected $_package_url_expiry = null;
111
+	
112
+    /**
113
+     * Name or ID for client submitting the content package to the target system. Required.
114
+     * @var string
115
+     */
116
+    protected $_client = null;
117
+	
118
+    /**
119
+     * User-id or sign-on for target system. Optional
120
+     * @var string
121
+     */
122
+    protected $_system_user_id = null;
123
+	
124
+    /**
125
+     * Either a URL-encoded password token or the null string. If the 
126
+     * target system requires a password and the null string value is 
127
+     * passed, then the target system is responsible for prompting for a 
128
+     * password for target system. Optional
129
+     * @var string
130
+     */
131
+    protected $_system_password = null;
132
+	
133
+    /**
134
+     * URL to send acknowledgement receipt after collecting a package. Any URL, including mailto (as per RFC 2368 and RFC 2822). Required.
135
+     * @var string
136
+     */
137
+    protected $_receipt = null;
138
+	
139
+    /**
140
+     * URL to send alerts to while processing the package. Any URL, including mailto (as per RFC 2368 and RFC 2822). Optional.
141
+     * @var string
142
+     */
143
+    protected $_alerts = null;
144
+	
145
+    /**
146
+     * Unstructured character string that may be used to transfer vendor-specific data such as processing hints or deployment information. Optional.
147
+     * @var string
148
+     */
149
+    protected $_vendor_data = null;
150
+	
151
+    /**
152
+     * Constructor
153
+     * 
154
+     * Constructs a PENSRequest based class using the arguments given
155
+     * 
156
+     * @param array Arguments
157
+     */
158
+    public function __construct($arguments) {
159
+        $this->setPensVersion($arguments["pens-version"]);
160
+        $this->setPackageType($arguments["package-type"]);
161
+        $this->setPackageTypeVersion($arguments["package-type-version"]);
162
+        $this->setPackageFormat($arguments["package-format"]);
163
+        $this->setPackageId($arguments["package-id"]);
164
+        $this->setPackageUrl($arguments["package-url"]);
165
+        $this->setPackageUrlUserId($arguments["package-url-user-id"]);
166
+        $this->setPackageUrlAccount($arguments["package-url-account"]);
167
+        $this->setPackageUrlPassword($arguments["package-url-password"]);
168
+        $this->setPackageUrlExpiry($arguments["package-url-expiry"]);
169
+        $this->setClient($arguments["client"]);
170
+        $this->setSystemUserId($arguments["system-user-id"]);
171
+        $this->setSystemPassword($arguments["system-password"]);
172
+        $this->setReceipt($arguments["receipt"]);
173
+        $this->setAlerts($arguments["alerts"]);
174
+        $this->setVendorData($arguments["vendor-data"]);
175
+    }
176
+	
177
+    public function getPensVersion() {
178
+        return $this->_pens_version;
179
+    }
180
+	
181
+    /**
182
+     * Sets the PENS version
183
+     * 
184
+     * @param string PENS version
185
+     * 
186
+     * @throws PENSException with code 2001 if invalid
187
+     */
188
+    public function setPensVersion($pens_version) {
189
+        if($pens_version == PENSConfig::$version) {
190
+            $this->_pens_version = $pens_version;
191
+        } else {
192
+            throw new PENSException(2001);
193
+        }
194
+    }
195
+	
196
+    public function getCommand() {
197
+        return $this->_command;
198
+    }
199
+	
200
+    /**
201
+     * Sets the command
202
+     * 
203
+     * @param string command
204
+     * 
205
+     * @throws PENSException with code 2002 if invalid
206
+     */
207
+    protected function setCommand($command) {
208
+        if(in_array($command, PENSConfig::$allowed_commands)) {
209
+            $this->_command = $command;
210
+        } else {
211
+            throw new PENSException(2002);
212
+        }
213
+    }
214
+	
215
+    public function getPackageType() {
216
+        return $this->_package_type;
217
+    }
218
+	
219
+    /**
220
+     * Sets the package type
221
+     * 
222
+     * @param string package type
223
+     * 
224
+     * @throws PENSException with code 2003 if invalid
225
+     */
226
+    public function setPackageType($package_type) {
227
+        if(in_array($package_type, PENSConfig::$allowed_package_types)) {
228
+            $this->_package_type = $package_type;
229
+        } else {
230
+            throw new PENSException(2003);
231
+        }
232
+    }
233
+	
234
+    public function getPackageTypeVersion() {
235
+        return $this->_package_type_version;
236
+    }
237
+	
238
+    /**
239
+     * Sets the package type version
240
+     * 
241
+     * @param string package type version
242
+     * 
243
+     * @throws PENSException with code 2004 if invalid
244
+     */
245
+    public function setPackageTypeVersion($package_type_version) {
246
+        if(empty($package_type_version)) {
247
+            throw new PENSException(2004);
248
+        } else {
249
+            $this->_package_type_version = $package_type_version;
250
+        }
251
+    }
252
+	
253
+    public function getPackageFormat() {
254
+        return $this->_package_format;
255
+    }
256
+	
257
+    /**
258
+     * Sets the package format
259
+     * 
260
+     * @param string package format
261
+     * 
262
+     * @throws PENSException with code 2005 if invalid
263
+     */
264
+    public function setPackageFormat($package_format) {
265
+        if(in_array($package_format, PENSConfig::$allowed_package_formats)) {
266
+            $this->_package_format = $package_format;
267
+        } else {
268
+            throw new PENSException(2005);
269
+        }
270
+    }
271
+	
272
+    public function getPackageId() {
273
+        return $this->_package_id;
274
+    }
275
+	
276
+    /**
277
+     * Sets the package Id
278
+     * 
279
+     * @param string package Id
280
+     * 
281
+     * @throws PENSException with code 2007 if invalid
282
+     */
283
+    public function setPackageId($package_id) {
284
+        if (preg_match('/'.ABSOLUTEURI_2396.'/', $package_id)) {
285
+            $this->_package_id = $package_id;
286
+        } else {
287
+            throw new PENSException(2007);
288
+        }
289
+    }
290
+	
291
+    public function getPackageUrl() {
292
+        return $this->_package_url;
293
+    }
294
+	
295
+    /**
296
+     * Sets the package url
297
+     * 
298
+     * @param string package url
299
+     * 
300
+     * @throws PENSException with code 2008 if invalid
301
+     */
302
+    public function setPackageUrl($package_url) {
303
+        if (preg_match('/'.ABSOLUTEURI_2396.'/', $package_url) && substr($package_url, -4) == ".".$this->_package_format) {
304
+            $this->_package_url = $package_url;
305
+        } else {
306
+            throw new PENSException(2008);
307
+        }
308
+    }
309
+	
310
+    public function getFilename() {
311
+        return substr(strrchr($this->_package_url, "/"), 1);
312
+    }
313
+	
314
+    public function getPackageUrlUserId() {
315
+        return $this->_package_url_user_id;
316
+    }
317
+	
318
+    public function setPackageUrlUserId($package_url_user_id) {
319
+        if(!empty($package_url_user_id)) {
320
+            $this->_package_url_user_id = $package_url_user_id;
321
+        }
322
+    }
323
+	
324
+    public function getPackageUrlAccount() {
325
+        return $this->_package_url_account;
326
+    }
327
+	
328
+    public function setPackageUrlAccount($package_url_account) {
329
+        if(!empty($package_url_account)) {
330
+            $this->_package_url_account = $package_url_account;
331
+        }
332
+    }
333
+	
334
+    public function getPackageUrlPassword() {
335
+        return $this->_package_url_password;
336
+    }
337
+	
338
+    public function setPackageUrlPassword($package_url_password) {
339
+        if(!empty($package_url_password)) {
340
+            $this->_package_url_password = $package_url_password;
341
+        }
342
+    }
343
+	
344
+    public function getPackageUrlExpiry() {
345
+        return $this->_package_url_expiry;
346
+    }
347
+	
348
+    /**
349
+     * Sets the package url expiry and transforms it into a php DateTime object
350
+     * 
351
+     * @param string package url expiry
352
+     * 
353
+     * @throws PENSException with code 2009 if invalid
354
+     * @todo Perform a better validation of the date
355
+     */
356
+    public function setPackageUrlExpiry($package_url_expiry) {
357
+        if(empty($package_url_expiry)) {
358
+            throw new PENSException(2009);
359
+        } else {
360
+            try {
361
+                $expiry = new DateTime($package_url_expiry, new DateTimeZone('UTC'));
362
+                $this->_package_url_expiry = $expiry;
363
+            } catch(Exception $e) {
364
+                throw new PENSException(2009);
365
+            }
366
+        }
367
+    }
368
+	
369
+    public function getClient() {
370
+        return $this->_client;
371
+    }
372
+	
373
+    /**
374
+     * Sets the client
375
+     * 
376
+     * @param string client
377
+     * 
378
+     * @throws PENSException with code 2010 if invalid
379
+     */
380
+    public function setClient($client) {
381
+        if(!empty($client)) {
382
+            $this->_client = $client;
383
+        } else {
384
+            throw new PENSException(2010);
385
+        }
386
+    }
387
+	
388
+    public function getSystemUserId() {
389
+        return $this->_system_user_id;
390
+    }
391
+	
392
+    public function setSystemUserId($system_user_id) {
393
+        if(!empty($system_user_id)) {
394
+            $this->_system_user_id = $system_user_id;
395
+        }
396
+    }
397
+	
398
+    public function getSystemPassword() {
399
+        return $this->_system_password;
400
+    }
401
+	
402
+    public function setSystemPassword($system_password) {
403
+        if(!empty($system_password)) {
404
+            $this->_system_password = $system_password;
405
+        }
406
+    }
407
+	
408
+    public function getReceipt() {
409
+        return $this->_receipt;
410
+    }
411
+	
412
+    /**
413
+     * Sets the receipt url
414
+     * 
415
+     * @param string receipt url
416
+     * 
417
+     * @throws PENSException with code 2011 if invalid
418
+     */
419
+    public function setReceipt($receipt) {
420
+        if($this instanceof PENSRequestCollect) {
421
+            if (preg_match('/'.ABSOLUTEURI_2396.'/', $receipt)) {
422
+                $this->_receipt = $receipt;
423
+            } else {
424
+                throw new PENSException(2011);
425
+            }
426
+        }
427
+    }
428
+	
429
+    public function getAlerts() {
430
+        return $this->_alerts;
431
+    }
432
+	
433
+    public function setAlerts($alerts) {
434
+        if(!empty($alerts)) {
435
+            if(preg_match('/'.ABSOLUTEURI_2396.'/', $alerts)) {
436
+                $this->_alerts = $alerts;
437
+            } else {
438
+                throw new PENSException(1201);
439
+            }
440
+        }
441
+    }
442
+	
443
+    public function getVendorData() {
444
+        return $this->_vendor_data;
445
+    }
446
+	
447
+    public function setVendorData($vendor_data) {
448
+        if(!empty($vendor_data)) {
449
+            $this->_vendor_data = $vendor_data;
450
+        }
451
+    }
452
+	
453
+    /**
454
+     * Returns an associative that contains all the fields needed to send a
455
+     * receipt or an alert to the client
456
+     * 
457
+     * @return array Associative array
458
+     */
459
+    protected function getSendReceiptAlertArray() {
460
+        return array("pens-version" => $this->getPensVersion(),
461
+            "package-type" => $this->getPackageType(),
462
+            "package-type-version" => $this->getPackageTypeVersion(),
463
+            "package-format" => $this->getPackageFormat(),
464
+            "package-id" => $this->getPackageId(),
465
+            "package-url" => $this->getPackageUrl(),
466
+            "package-url-expiry" => $this->getPackageUrlExpiry()->format(DateTime::ISO8601),
467
+            "client" => $this->getClient());
468
+    }
469
+	
470
+    /**
471
+     * Returns an associative that contains all the fields needed to send a
472
+     * receipt to the client
473
+     * 
474
+     * @return array Associative array
475
+     */
476
+    public function getSendReceiptArray() {
477
+        $receipt = $this->getSendReceiptAlertArray();
478
+        $receipt["command"] = "receipt";
479
+        return $receipt;
480
+    }
481
+	
482
+    /**
483
+     * Returns an associative that contains all the fields needed to send an
484
+     * alert to the client
485
+     * 
486
+     * @return array Associative array
487
+     */
488
+    public function getSendAlertArray() {
489
+        $alert = $this->getSendReceiptAlertArray();
490
+        $alert["command"] = "alert";
491
+        return $alert;
492
+    }
493 493
 	
494 494
 	
495 495
 }
Please login to merge, or discard this patch.
plugin/pens/lib/pens/pens_config.php 1 patch
Indentation   +43 added lines, -43 removed lines patch added patch discarded remove patch
@@ -16,54 +16,54 @@
 block discarded – undo
16 16
  * along with php-pens.  If not, see <http://www.gnu.org/licenses/>.
17 17
  */
18 18
  
19
- /**
20
- * PENSConfig
21
- * 
22
- * Provides the PENSConfig class
23
- * 
24
- * @package PENS
25
- * @author Guillaume Viguier-Just <[email protected]>
26
- * @licence http://www.gnu.org/licenses/gpl.txt
27
- */
19
+    /**
20
+     * PENSConfig
21
+     * 
22
+     * Provides the PENSConfig class
23
+     * 
24
+     * @package PENS
25
+     * @author Guillaume Viguier-Just <[email protected]>
26
+     * @licence http://www.gnu.org/licenses/gpl.txt
27
+     */
28 28
  
29
- /**
30
- * PENSConfig
31
- * 
32
- * This class provides different static variables to configure php-pens.
33
- * 
34
- * @package PENS
35
- * @author Guillaume Viguier-Just <[email protected]>
36
- * @licence http://www.gnu.org/licenses/gpl.txt
37
- */
29
+    /**
30
+     * PENSConfig
31
+     * 
32
+     * This class provides different static variables to configure php-pens.
33
+     * 
34
+     * @package PENS
35
+     * @author Guillaume Viguier-Just <[email protected]>
36
+     * @licence http://www.gnu.org/licenses/gpl.txt
37
+     */
38 38
 class PENSConfig {
39 39
 
40
-	/**
41
-	 * PENS version
42
-	 * @var string
43
-	 */
44
-	public static $version = "1.0.0";
40
+    /**
41
+     * PENS version
42
+     * @var string
43
+     */
44
+    public static $version = "1.0.0";
45 45
 	
46
-	/**
47
-	 * Allowed commands
48
-	 * @var array
49
-	 */
50
-	public static $allowed_commands = array("collect", "receipt", "alert");
46
+    /**
47
+     * Allowed commands
48
+     * @var array
49
+     */
50
+    public static $allowed_commands = array("collect", "receipt", "alert");
51 51
 	
52
-	/**
53
-	 * Allowed package types
54
-	 * @var array
55
-	 */
56
-	public static $allowed_package_types = array("aicc-pkg", "scorm-pif", "ims-qti");
52
+    /**
53
+     * Allowed package types
54
+     * @var array
55
+     */
56
+    public static $allowed_package_types = array("aicc-pkg", "scorm-pif", "ims-qti");
57 57
 	
58
-	/**
59
-	 * Allowed package formats
60
-	 * @var array
61
-	 */
62
-	public static $allowed_package_formats = array("zip", "url", "jar", "war", "xml");
58
+    /**
59
+     * Allowed package formats
60
+     * @var array
61
+     */
62
+    public static $allowed_package_formats = array("zip", "url", "jar", "war", "xml");
63 63
 	
64
-	/**
65
-	 * End of line as specified by the PENS specification
66
-	 * @var string
67
-	 */
68
-	public static $eol = "\r\n";
64
+    /**
65
+     * End of line as specified by the PENS specification
66
+     * @var string
67
+     */
68
+    public static $eol = "\r\n";
69 69
 }
Please login to merge, or discard this patch.
plugin/pens/lib/pens_client_test.php 1 patch
Indentation   +18 added lines, -18 removed lines patch added patch discarded remove patch
@@ -1,20 +1,20 @@  discard block
 block discarded – undo
1 1
 <?php
2 2
 /**
3
- * This file is part of php-pens.
4
- * 
5
- * php-pens is free software: you can redistribute it and/or modify 
6
- * it under the terms of the GNU General Public License as published by
7
- * the Free Software Foundation, either version 3 of the License, or
8
- * (at your option) any later version.
9
- * 
10
- * php-pens is distributed in the hope that it will be useful,
11
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
12
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13
- * GNU General Public License for more details.
14
- * 
15
- * You should have received a copy of the GNU General Public License
16
- * along with php-pens.  If not, see <http://www.gnu.org/licenses/>.
17
- */
3
+     * This file is part of php-pens.
4
+     * 
5
+     * php-pens is free software: you can redistribute it and/or modify 
6
+     * it under the terms of the GNU General Public License as published by
7
+     * the Free Software Foundation, either version 3 of the License, or
8
+     * (at your option) any later version.
9
+     * 
10
+     * php-pens is distributed in the hope that it will be useful,
11
+     * but WITHOUT ANY WARRANTY; without even the implied warranty of
12
+     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13
+     * GNU General Public License for more details.
14
+     * 
15
+     * You should have received a copy of the GNU General Public License
16
+     * along with php-pens.  If not, see <http://www.gnu.org/licenses/>.
17
+     */
18 18
  
19 19
 /**
20 20
  * Provides a test implementation of a PENS Client.
@@ -26,9 +26,9 @@  discard block
 block discarded – undo
26 26
 require_once __DIR__ . '/pens.php';
27 27
 
28 28
 class MyRequestHandler extends PENSRequestHandler {
29
-	public function processRequest($request, $response) {
30
-		// Do the processing of the alert or the receipt here
31
-	}
29
+    public function processRequest($request, $response) {
30
+        // Do the processing of the alert or the receipt here
31
+    }
32 32
 }
33 33
 
34 34
 $handler = new MyRequestHandler();
Please login to merge, or discard this patch.