Completed
Pull Request — master (#190)
by
unknown
03:42
created
application/libraries/MY_DB_cache.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -245,7 +245,7 @@
 block discarded – undo
245 245
 	}
246 246
 
247 247
 	/**
248
-	 * @param $md5
248
+	 * @param string $md5
249 249
 	 *
250 250
 	 * @return array
251 251
 	 */
Please login to merge, or discard this patch.
application/models/User_Options_Model.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -114,7 +114,7 @@
 block discarded – undo
114 114
 	 * @param string   $option
115 115
 	 * @param int|null $userID
116 116
 	 *
117
-	 * @return mixed Returns option value as STRING, or FALSE if option does not exist.
117
+	 * @return string Returns option value as STRING, or FALSE if option does not exist.
118 118
 	 */
119 119
 	public function get(string $option, ?int $userID = NULL) {
120 120
 		$userID = (is_null($userID) ? (int) $this->User->id : $userID);
Please login to merge, or discard this patch.
application/models/Tracker/Tracker_Title_Model.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -122,7 +122,7 @@
 block discarded – undo
122 122
 	/**
123 123
 	 * @param string $site_url
124 124
 	 *
125
-	 * @return stdClass|object|null
125
+	 * @return string
126 126
 	 */
127 127
 	public function getSiteDataFromURL(string $site_url) {
128 128
 		$query = $this->db->select('*')
Please login to merge, or discard this patch.
application/models/User_Model.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -55,7 +55,7 @@
 block discarded – undo
55 55
 	/**
56 56
 	 * @param $identity
57 57
 	 *
58
-	 * @return mixed
58
+	 * @return boolean
59 59
 	 */
60 60
 	public function find_email_from_identity(string $identity) {
61 61
 		//login allows using email or username, but ion_auth doesn't support this
Please login to merge, or discard this patch.
application/third_party/Ion-Auth/libraries/Ion_auth.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -379,7 +379,7 @@
 block discarded – undo
379 379
 	/**
380 380
 	 * logout
381 381
 	 *
382
-	 * @return void
382
+	 * @return boolean
383 383
 	 * @author Mathew
384 384
 	 **/
385 385
 	public function logout()
Please login to merge, or discard this patch.
application/third_party/Ion-Auth/models/Ion_auth_model.php 1 patch
Doc Comments   +33 added lines, -18 removed lines patch added patch discarded remove patch
@@ -257,7 +257,7 @@  discard block
 block discarded – undo
257 257
 	/**
258 258
 	 * Hashes the password to be stored in the database.
259 259
 	 *
260
-	 * @return void
260
+	 * @return false|string
261 261
 	 * @author Mathew
262 262
 	 **/
263 263
 	public function hash_password($password, $salt=false, $use_sha1_override=FALSE)
@@ -289,7 +289,7 @@  discard block
 block discarded – undo
289 289
 	 * This function takes a password and validates it
290 290
 	 * against an entry in the users table.
291 291
 	 *
292
-	 * @return void
292
+	 * @return boolean
293 293
 	 * @author Mathew
294 294
 	 **/
295 295
 	public function hash_password_db($id, $password, $use_sha1_override=FALSE)
@@ -350,7 +350,8 @@  discard block
 block discarded – undo
350 350
 	/**
351 351
 	 * Generates a random salt value for forgotten passwords or any other keys. Uses SHA1.
352 352
 	 *
353
-	 * @return void
353
+	 * @param string $password
354
+	 * @return false|string
354 355
 	 * @author Mathew
355 356
 	 **/
356 357
 	public function hash_code($password)
@@ -363,7 +364,7 @@  discard block
 block discarded – undo
363 364
 	 *
364 365
 	 * Salt generation code taken from https://github.com/ircmaxell/password_compat/blob/master/lib/password.php
365 366
 	 *
366
-	 * @return void
367
+	 * @return string
367 368
 	 * @author Anthony Ferrera
368 369
 	 **/
369 370
 	public function salt()
@@ -446,7 +447,7 @@  discard block
 block discarded – undo
446 447
 	/**
447 448
 	 * activate
448 449
 	 *
449
-	 * @return void
450
+	 * @return boolean
450 451
 	 * @author Mathew
451 452
 	 **/
452 453
 	public function activate($id, $code = false)
@@ -512,7 +513,7 @@  discard block
 block discarded – undo
512 513
 	/**
513 514
 	 * Deactivate
514 515
 	 *
515
-	 * @return void
516
+	 * @return boolean
516 517
 	 * @author Mathew
517 518
 	 **/
518 519
 	public function deactivate($id = NULL)
@@ -1257,6 +1258,9 @@  discard block
 block discarded – undo
1257 1258
 		return FALSE;
1258 1259
 	}
1259 1260
 
1261
+	/**
1262
+	 * @param integer $limit
1263
+	 */
1260 1264
 	public function limit($limit)
1261 1265
 	{
1262 1266
 		$this->trigger_events('limit');
@@ -1273,6 +1277,9 @@  discard block
 block discarded – undo
1273 1277
 		return $this;
1274 1278
 	}
1275 1279
 
1280
+	/**
1281
+	 * @param string $where
1282
+	 */
1276 1283
 	public function where($where, $value = NULL)
1277 1284
 	{
1278 1285
 		$this->trigger_events('where');
@@ -1309,6 +1316,9 @@  discard block
 block discarded – undo
1309 1316
 		return $this;
1310 1317
 	}
1311 1318
 
1319
+	/**
1320
+	 * @param string $by
1321
+	 */
1312 1322
 	public function order_by($by, $order='desc')
1313 1323
 	{
1314 1324
 		$this->trigger_events('order_by');
@@ -1367,7 +1377,7 @@  discard block
 block discarded – undo
1367 1377
 	/**
1368 1378
 	 * users
1369 1379
 	 *
1370
-	 * @return object Users
1380
+	 * @return Ion_auth_model Users
1371 1381
 	 * @author Ben Edmunds
1372 1382
 	 **/
1373 1383
 	public function users($groups = NULL)
@@ -1488,7 +1498,7 @@  discard block
 block discarded – undo
1488 1498
 	/**
1489 1499
 	 * user
1490 1500
 	 *
1491
-	 * @return object
1501
+	 * @return Ion_auth_model
1492 1502
 	 * @author Ben Edmunds
1493 1503
 	 **/
1494 1504
 	public function user($id = NULL)
@@ -1510,7 +1520,7 @@  discard block
 block discarded – undo
1510 1520
 	/**
1511 1521
 	 * get_users_groups
1512 1522
 	 *
1513
-	 * @return array
1523
+	 * @return CI_DB_result
1514 1524
 	 * @author Ben Edmunds
1515 1525
 	 **/
1516 1526
 	public function get_users_groups($id=FALSE)
@@ -1529,7 +1539,7 @@  discard block
 block discarded – undo
1529 1539
 	/**
1530 1540
 	 * add_to_group
1531 1541
 	 *
1532
-	 * @return bool
1542
+	 * @return integer
1533 1543
 	 * @author Ben Edmunds
1534 1544
 	 **/
1535 1545
 	public function add_to_group($group_ids, $user_id=false)
@@ -1617,7 +1627,7 @@  discard block
 block discarded – undo
1617 1627
 	/**
1618 1628
 	 * groups
1619 1629
 	 *
1620
-	 * @return object
1630
+	 * @return Ion_auth_model
1621 1631
 	 * @author Ben Edmunds
1622 1632
 	 **/
1623 1633
 	public function groups()
@@ -1662,7 +1672,7 @@  discard block
 block discarded – undo
1662 1672
 	/**
1663 1673
 	 * group
1664 1674
 	 *
1665
-	 * @return object
1675
+	 * @return Ion_auth_model
1666 1676
 	 * @author Ben Edmunds
1667 1677
 	 **/
1668 1678
 	public function group($id = NULL)
@@ -2160,7 +2170,7 @@  discard block
 block discarded – undo
2160 2170
 	 *
2161 2171
 	 * Set the message delimiters
2162 2172
 	 *
2163
-	 * @return void
2173
+	 * @return boolean
2164 2174
 	 * @author Ben Edmunds
2165 2175
 	 **/
2166 2176
 	public function set_message_delimiters($start_delimiter, $end_delimiter)
@@ -2176,7 +2186,7 @@  discard block
 block discarded – undo
2176 2186
 	 *
2177 2187
 	 * Set the error delimiters
2178 2188
 	 *
2179
-	 * @return void
2189
+	 * @return boolean
2180 2190
 	 * @author Ben Edmunds
2181 2191
 	 **/
2182 2192
 	public function set_error_delimiters($start_delimiter, $end_delimiter)
@@ -2192,6 +2202,7 @@  discard block
 block discarded – undo
2192 2202
 	 *
2193 2203
 	 * Set a message
2194 2204
 	 *
2205
+	 * @param string $message
2195 2206
 	 * @return void
2196 2207
 	 * @author Ben Edmunds
2197 2208
 	 **/
@@ -2209,7 +2220,7 @@  discard block
 block discarded – undo
2209 2220
 	 *
2210 2221
 	 * Get the messages
2211 2222
 	 *
2212
-	 * @return void
2223
+	 * @return string
2213 2224
 	 * @author Ben Edmunds
2214 2225
 	 **/
2215 2226
 	public function messages()
@@ -2256,7 +2267,7 @@  discard block
 block discarded – undo
2256 2267
 	 *
2257 2268
 	 * Clear messages
2258 2269
 	 *
2259
-	 * @return void
2270
+	 * @return boolean
2260 2271
 	 * @author Ben Edmunds
2261 2272
 	 **/
2262 2273
 	public function clear_messages()
@@ -2272,6 +2283,7 @@  discard block
 block discarded – undo
2272 2283
 	 *
2273 2284
 	 * Set an error message
2274 2285
 	 *
2286
+	 * @param string $error
2275 2287
 	 * @return void
2276 2288
 	 * @author Ben Edmunds
2277 2289
 	 **/
@@ -2287,7 +2299,7 @@  discard block
 block discarded – undo
2287 2299
 	 *
2288 2300
 	 * Get the error message
2289 2301
 	 *
2290
-	 * @return void
2302
+	 * @return string
2291 2303
 	 * @author Ben Edmunds
2292 2304
 	 **/
2293 2305
 	public function errors()
@@ -2334,7 +2346,7 @@  discard block
 block discarded – undo
2334 2346
 	 *
2335 2347
 	 * Clear Errors
2336 2348
 	 *
2337
-	 * @return void
2349
+	 * @return boolean
2338 2350
 	 * @author Ben Edmunds
2339 2351
 	 **/
2340 2352
 	public function clear_errors()
@@ -2363,6 +2375,9 @@  discard block
 block discarded – undo
2363 2375
 		return $filtered_data;
2364 2376
 	}
2365 2377
 
2378
+	/**
2379
+	 * @param string $ip_address
2380
+	 */
2366 2381
 	protected function _prepare_ip($ip_address) {
2367 2382
 		// just return the string IP address now for better compatibility
2368 2383
 		return $ip_address;
Please login to merge, or discard this patch.
application/third_party/Limiter/libraries/Limiter.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -66,7 +66,7 @@
 block discarded – undo
66 66
      * @param int $req_per_hour Overrides base_limit setting if set
67 67
      * @param bool $flush_on_abort Overrides flush_on_abort setting if set
68 68
      * @param bool $show_header Overrides header_show setting if set
69
-     * @return bool Should request be aborted
69
+     * @return null|boolean Should request be aborted
70 70
      */
71 71
     public function limit($target = '_global', $req_per_hour = null, $flush_on_abort = null, $show_header = null) {
72 72
         $req_per_hour   = $req_per_hour !== null ? $req_per_hour : $this->base_limit;
Please login to merge, or discard this patch.