albertlast / SMF2.1

Sources/QueryString.php

Doc Comments +1 added lines, -1 removed lines

@@ -325,7 +325,7 @@
  * Validates a IPv6 address. returns true if it is ipv6.
  *
  * @param string $ip The ip address to be validated
- * @return boolean Whether the specified IP is a valid IPv6 address
+ * @return false|string Whether the specified IP is a valid IPv6 address
  */
 function isValidIPv6($ip)
 {

Indentation +2 added lines, -2 removed lines

@@ -426,8 +426,8 @@
 */
 function matchIPtoCIDR($ip_address, $cidr_address)
 {
-    list ($cidr_network, $cidr_subnetmask) = preg_split('/', $cidr_address);
-    return (ip2long($ip_address) & (~((1 << (32 - $cidr_subnetmask)) - 1))) == ip2long($cidr_network);
+	list ($cidr_network, $cidr_subnetmask) = preg_split('/', $cidr_address);
+	return (ip2long($ip_address) & (~((1 << (32 - $cidr_subnetmask)) - 1))) == ip2long($cidr_network);
 }
 
 /**

Sources/ScheduledTasks.php

Doc Comments +1 added lines, -1 removed lines

@@ -807,7 +807,7 @@
 /**
  * Send a group of emails from the mail queue.
  *
- * @param bool|int $number The number to send each loop through or false to use the standard limits
+ * @param integer $number The number to send each loop through or false to use the standard limits
  * @param bool $override_limit Whether to bypass the limit
  * @param bool $force_send Whether to forcibly send the messages now (useful when using cron jobs)
  * @return bool Whether things were sent

Sources/Subs-Db-postgresql.php

Doc Comments +1 added lines, -2 removed lines

@@ -457,7 +457,6 @@ 
 
 /**
  * affected_rows
- * @param resource $connection
  */
 function smf_db_affected_rows($result = null)
 {
@@ -800,7 +799,7 @@ 
  *
  * @param string $db_name The database name
  * @param resource $db_connection The database connection
- * @return true Always returns true
+ * @return boolean Always returns true
  */
 function smf_db_select_db($db_name, $db_connection)
 {

Sources/Subs.php

Indentation -2 removed lines

@@ -5370,7 +5370,6 @@ 
 
 /**
  * Tries different modes to make file/dirs writable. Wrapper function for chmod()
-
  * @param string $file The file/dir full path.
  * @param int $value Not needed, added for legacy reasons.
  * @return boolean  true if the file/dir is already writable or the function was able to make it writable, false if the function couldn't make the file/dir writable.
@@ -5410,7 +5409,6 @@ 
 
 /**
  * Wrapper function for json_decode() with error handling.
-
  * @param string $json The string to decode.
  * @param bool $returnAsArray To return the decoded string as an array or an object, SMF only uses Arrays but to keep on compatibility with json_decode its set to false as default.
  * @param bool $logIt To specify if the error will be logged if theres any.

Doc Comments +2 added lines, -2 removed lines

@@ -676,7 +676,7 @@ 
  * - caches the formatting data from the setting for optimization.
  *
  * @param float $number A number
- * @param bool|int $override_decimal_count If set, will use the specified number of decimal places. Otherwise it's automatically determined
+ * @param integer $override_decimal_count If set, will use the specified number of decimal places. Otherwise it's automatically determined
  * @return string A formatted number
  */
 function comma_format($number, $override_decimal_count = false)
@@ -5527,7 +5527,7 @@ 
  * It assumes the data is already a string.
  * @param string $data The data to print
  * @param string $type The content type. Defaults to Json.
- * @return void
+ * @return false|null
  */
 function smf_serverResponse($data = '', $type = 'Content-Type: application/json')
 {

other/upgrade.php

Doc Comments +14 added lines, -1 removed lines

@@ -393,6 +393,9 @@ 
 }
 
 // Used to direct the user to another location.
+/**
+ * @param string $location
+ */
 function redirectLocation($location, $addForm = true)
 {
 	global $upgradeurl, $upcontext, $command_line;
@@ -1573,6 +1576,9 @@ 
 	return addslashes(preg_replace(array('~^\.([/\\\]|$)~', '~[/]+~', '~[\\\]+~', '~[/\\\]$~'), array($install_path . '$1', '/', '\\', ''), $path));
 }
 
+/**
+ * @param string $filename
+ */
 function parse_sql($filename)
 {
 	global $db_prefix, $db_collation, $boarddir, $boardurl, $command_line, $file_steps, $step_progress, $custom_warning;
@@ -1607,6 +1613,10 @@ 
 
 	// Our custom error handler - does nothing but does stop public errors from XML!
 	set_error_handler(
+
+		/**
+		 * @param string $errno
+		 */
 		function ($errno, $errstr, $errfile, $errline) use ($support_js)
 		{
 			if ($support_js)
@@ -1853,6 +1863,9 @@ 
 	return true;
 }
 
+/**
+ * @param string $string
+ */
 function upgrade_query($string, $unbuffered = false)
 {
 	global $db_connection, $db_server, $db_user, $db_passwd, $db_type, $command_line, $upcontext, $upgradeurl, $modSettings;
@@ -4512,7 +4525,7 @@ 
  * @param int $setSize The amount of entries after which to update the database.
  *
  * newCol needs to be a varbinary(16) null able field
- * @return bool
+ * @return boolean|null
  */
 function MySQLConvertOldIp($targetTable, $oldCol, $newCol, $limit = 50000, $setSize = 100)
 {

Indentation +1 added lines, -1 removed lines

@@ -82,7 +82,7 @@
 
 // The helper is crucial. Include it first thing.
 if (!file_exists($upgrade_path . '/upgrade-helper.php'))
-    die('upgrade-helper.php not found where it was expected: ' . $upgrade_path . '/upgrade-helper.php! Make sure you have uploaded ALL files from the upgrade package. The upgrader cannot continue.');
+	die('upgrade-helper.php not found where it was expected: ' . $upgrade_path . '/upgrade-helper.php! Make sure you have uploaded ALL files from the upgrade package. The upgrader cannot continue.');
 
 require_once($upgrade_path . '/upgrade-helper.php');