SimpleMachines / SMF2.1

other/upgrade.php

Doc Comments +18 added lines

@@ -207,6 +207,9 @@ 
 // MD5 Encryption.
 if (!function_exists('md5_hmac'))
 {
+	/**
+	 * @param string $key
+	 */
 	function md5_hmac($data, $key)
 	{
 		if (strlen($key) > 64)
@@ -441,6 +444,9 @@ 
 }
 
 // Used to direct the user to another location.
+/**
+ * @param string $location
+ */
 function redirectLocation($location, $addForm = true)
 {
 	global $upgradeurl, $upcontext, $command_line;
@@ -2128,6 +2134,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;
@@ -2414,6 +2423,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;
@@ -3043,6 +3055,9 @@ 
 	$upcontext['current_step'] = 1;
 }
 
+/**
+ * @param string $message
+ */
 function print_error($message, $fatal = false)
 {
 	static $fp = null;
@@ -3056,6 +3071,9 @@ 
 		exit;
 }
 
+/**
+ * @param string $message
+ */
 function throw_error($message)
 {
 	global $upcontext;

Spacing +112 added lines, -112 removed lines

@@ -426,11 +426,11 @@ 
 
 		$totalTime = '';
 		if ($hours > 0)
-			$totalTime .= $hours . ' hour' . ($hours > 1 ? 's':'') . ' ';
+			$totalTime .= $hours . ' hour' . ($hours > 1 ? 's' : '') . ' ';
 		if ($minutes > 0)
-			$totalTime .= $minutes . ' minute' . ($minutes > 1 ? 's':'') . ' ';
+			$totalTime .= $minutes . ' minute' . ($minutes > 1 ? 's' : '') . ' ';
 		if ($seconds > 0)
-			$totalTime .= $seconds . ' second' . ($seconds > 1 ? 's':'') . ' ';
+			$totalTime .= $seconds . ' second' . ($seconds > 1 ? 's' : '') . ' ';
 
 		if (!empty($totalTime))
 			echo "\n" . 'Upgrade completed in ' . $totalTime . "\n";
@@ -710,14 +710,14 @@ 
 	// Do we need to add this setting?
 	$need_settings_update = empty($modSettings['custom_avatar_dir']);
 
-	$custom_av_dir = !empty($modSettings['custom_avatar_dir']) ? $modSettings['custom_avatar_dir'] : $GLOBALS['boarddir'] .'/custom_avatar';
-	$custom_av_url = !empty($modSettings['custom_avatar_url']) ? $modSettings['custom_avatar_url'] : $boardurl .'/custom_avatar';
+	$custom_av_dir = !empty($modSettings['custom_avatar_dir']) ? $modSettings['custom_avatar_dir'] : $GLOBALS['boarddir'] . '/custom_avatar';
+	$custom_av_url = !empty($modSettings['custom_avatar_url']) ? $modSettings['custom_avatar_url'] : $boardurl . '/custom_avatar';
 
 	// This little fellow has to cooperate...
 	quickFileWritable($custom_av_dir);
 
 	// Are we good now?
-	if(!is_writable($custom_av_dir))
+	if (!is_writable($custom_av_dir))
 		return throw_error(sprintf('The directory: %1$s has to be writable to continue the upgrade. Please make sure permissions are correctly set to allow this.', $custom_av_dir));
 	elseif ($need_settings_update)
 	{
@@ -913,7 +913,7 @@ 
 				$upcontext['user']['id'] = 1;
 				$upcontext['user']['name'] = 'Administrator';
 			}
-			$upcontext['user']['pass'] = mt_rand(0,60000);
+			$upcontext['user']['pass'] = mt_rand(0, 60000);
 			// This basically is used to match the GET variables to Settings.php.
 			$upcontext['upgrade_status']['pass'] = $upcontext['user']['pass'];
 
@@ -1124,7 +1124,7 @@ 
 		if ($db_port != ini_get('mysql' . ($db_type == 'mysqli' || !empty($_POST['convertMysql']) ? 'i' : '') . '.default_port'))
 			$changes['db_port'] = (int) $db_port;
 	}
-	elseif(!empty($db_port))
+	elseif (!empty($db_port))
 	{
 		// If db_port is set and is the same as the default, set it to ''
 		if ($db_type == 'mysql' || $db_type == 'mysqli')
@@ -1728,7 +1728,7 @@ 
 		}
 
 		if (!empty($deletes))
-			upgrade_query( '
+			upgrade_query('
 				UPDATE ' . $db_prefix . 'log_packages
 				SET install_state = 0
 				WHERE id_install IN (' . implode(',', $deletes) . ')');
@@ -1807,7 +1807,7 @@ 
 	else
 	{
 		require_once($sourcedir . '/ScheduledTasks.php');
-		$forum_version = SMF_VERSION;  // The variable is usually defined in index.php so lets just use the constant to do it for us.
+		$forum_version = SMF_VERSION; // The variable is usually defined in index.php so lets just use the constant to do it for us.
 		scheduled_fetchSMfiles(); // Now go get those files!
 	}
 
@@ -2625,7 +2625,7 @@ 
 	}
 	elseif ($change['type'] === 'index')
 	{
-		$request = upgrade_query( '
+		$request = upgrade_query('
 			SHOW INDEX
 			FROM ' . $db_prefix . $change['table']);
 		if ($request !== false)
@@ -3272,7 +3272,7 @@ 
 	// Try 755 and 775 first since 777 doesn't always work and could be a risk...
 	$chmod_values = array(0755, 0775, 0777);
 
-	foreach($chmod_values as $val)
+	foreach ($chmod_values as $val)
 	{
 		// If it's writable, break out of the loop
 		if (is_writable($file))
@@ -3489,95 +3489,95 @@ 
 		// Translation table for the character sets not native for MySQL.
 		$translation_tables = array(
 			'windows-1255' => array(
-				'0x81' => '\'\'',		'0x8A' => '\'\'',		'0x8C' => '\'\'',
-				'0x8D' => '\'\'',		'0x8E' => '\'\'',		'0x8F' => '\'\'',
-				'0x90' => '\'\'',		'0x9A' => '\'\'',		'0x9C' => '\'\'',
-				'0x9D' => '\'\'',		'0x9E' => '\'\'',		'0x9F' => '\'\'',
-				'0xCA' => '\'\'',		'0xD9' => '\'\'',		'0xDA' => '\'\'',
-				'0xDB' => '\'\'',		'0xDC' => '\'\'',		'0xDD' => '\'\'',
-				'0xDE' => '\'\'',		'0xDF' => '\'\'',		'0xFB' => '\'\'',
-				'0xFC' => '\'\'',		'0xFF' => '\'\'',		'0xC2' => '0xFF',
-				'0x80' => '0xFC',		'0xE2' => '0xFB',		'0xA0' => '0xC2A0',
-				'0xA1' => '0xC2A1',		'0xA2' => '0xC2A2',		'0xA3' => '0xC2A3',
-				'0xA5' => '0xC2A5',		'0xA6' => '0xC2A6',		'0xA7' => '0xC2A7',
-				'0xA8' => '0xC2A8',		'0xA9' => '0xC2A9',		'0xAB' => '0xC2AB',
-				'0xAC' => '0xC2AC',		'0xAD' => '0xC2AD',		'0xAE' => '0xC2AE',
-				'0xAF' => '0xC2AF',		'0xB0' => '0xC2B0',		'0xB1' => '0xC2B1',
-				'0xB2' => '0xC2B2',		'0xB3' => '0xC2B3',		'0xB4' => '0xC2B4',
-				'0xB5' => '0xC2B5',		'0xB6' => '0xC2B6',		'0xB7' => '0xC2B7',
-				'0xB8' => '0xC2B8',		'0xB9' => '0xC2B9',		'0xBB' => '0xC2BB',
-				'0xBC' => '0xC2BC',		'0xBD' => '0xC2BD',		'0xBE' => '0xC2BE',
-				'0xBF' => '0xC2BF',		'0xD7' => '0xD7B3',		'0xD1' => '0xD781',
-				'0xD4' => '0xD7B0',		'0xD5' => '0xD7B1',		'0xD6' => '0xD7B2',
-				'0xE0' => '0xD790',		'0xEA' => '0xD79A',		'0xEC' => '0xD79C',
-				'0xED' => '0xD79D',		'0xEE' => '0xD79E',		'0xEF' => '0xD79F',
-				'0xF0' => '0xD7A0',		'0xF1' => '0xD7A1',		'0xF2' => '0xD7A2',
-				'0xF3' => '0xD7A3',		'0xF5' => '0xD7A5',		'0xF6' => '0xD7A6',
-				'0xF7' => '0xD7A7',		'0xF8' => '0xD7A8',		'0xF9' => '0xD7A9',
-				'0x82' => '0xE2809A',	'0x84' => '0xE2809E',	'0x85' => '0xE280A6',
-				'0x86' => '0xE280A0',	'0x87' => '0xE280A1',	'0x89' => '0xE280B0',
-				'0x8B' => '0xE280B9',	'0x93' => '0xE2809C',	'0x94' => '0xE2809D',
-				'0x95' => '0xE280A2',	'0x97' => '0xE28094',	'0x99' => '0xE284A2',
-				'0xC0' => '0xD6B0',		'0xC1' => '0xD6B1',		'0xC3' => '0xD6B3',
-				'0xC4' => '0xD6B4',		'0xC5' => '0xD6B5',		'0xC6' => '0xD6B6',
-				'0xC7' => '0xD6B7',		'0xC8' => '0xD6B8',		'0xC9' => '0xD6B9',
-				'0xCB' => '0xD6BB',		'0xCC' => '0xD6BC',		'0xCD' => '0xD6BD',
-				'0xCE' => '0xD6BE',		'0xCF' => '0xD6BF',		'0xD0' => '0xD780',
-				'0xD2' => '0xD782',		'0xE3' => '0xD793',		'0xE4' => '0xD794',
-				'0xE5' => '0xD795',		'0xE7' => '0xD797',		'0xE9' => '0xD799',
-				'0xFD' => '0xE2808E',	'0xFE' => '0xE2808F',	'0x92' => '0xE28099',
-				'0x83' => '0xC692',		'0xD3' => '0xD783',		'0x88' => '0xCB86',
-				'0x98' => '0xCB9C',		'0x91' => '0xE28098',	'0x96' => '0xE28093',
-				'0xBA' => '0xC3B7',		'0x9B' => '0xE280BA',	'0xAA' => '0xC397',
-				'0xA4' => '0xE282AA',	'0xE1' => '0xD791',		'0xE6' => '0xD796',
-				'0xE8' => '0xD798',		'0xEB' => '0xD79B',		'0xF4' => '0xD7A4',
-				'0xFA' => '0xD7AA',		'0xFF' => '0xD6B2',		'0xFC' => '0xE282AC',
+				'0x81' => '\'\'', '0x8A' => '\'\'', '0x8C' => '\'\'',
+				'0x8D' => '\'\'', '0x8E' => '\'\'', '0x8F' => '\'\'',
+				'0x90' => '\'\'', '0x9A' => '\'\'', '0x9C' => '\'\'',
+				'0x9D' => '\'\'', '0x9E' => '\'\'', '0x9F' => '\'\'',
+				'0xCA' => '\'\'', '0xD9' => '\'\'', '0xDA' => '\'\'',
+				'0xDB' => '\'\'', '0xDC' => '\'\'', '0xDD' => '\'\'',
+				'0xDE' => '\'\'', '0xDF' => '\'\'', '0xFB' => '\'\'',
+				'0xFC' => '\'\'', '0xFF' => '\'\'', '0xC2' => '0xFF',
+				'0x80' => '0xFC', '0xE2' => '0xFB', '0xA0' => '0xC2A0',
+				'0xA1' => '0xC2A1', '0xA2' => '0xC2A2', '0xA3' => '0xC2A3',
+				'0xA5' => '0xC2A5', '0xA6' => '0xC2A6', '0xA7' => '0xC2A7',
+				'0xA8' => '0xC2A8', '0xA9' => '0xC2A9', '0xAB' => '0xC2AB',
+				'0xAC' => '0xC2AC', '0xAD' => '0xC2AD', '0xAE' => '0xC2AE',
+				'0xAF' => '0xC2AF', '0xB0' => '0xC2B0', '0xB1' => '0xC2B1',
+				'0xB2' => '0xC2B2', '0xB3' => '0xC2B3', '0xB4' => '0xC2B4',
+				'0xB5' => '0xC2B5', '0xB6' => '0xC2B6', '0xB7' => '0xC2B7',
+				'0xB8' => '0xC2B8', '0xB9' => '0xC2B9', '0xBB' => '0xC2BB',
+				'0xBC' => '0xC2BC', '0xBD' => '0xC2BD', '0xBE' => '0xC2BE',
+				'0xBF' => '0xC2BF', '0xD7' => '0xD7B3', '0xD1' => '0xD781',
+				'0xD4' => '0xD7B0', '0xD5' => '0xD7B1', '0xD6' => '0xD7B2',
+				'0xE0' => '0xD790', '0xEA' => '0xD79A', '0xEC' => '0xD79C',
+				'0xED' => '0xD79D', '0xEE' => '0xD79E', '0xEF' => '0xD79F',
+				'0xF0' => '0xD7A0', '0xF1' => '0xD7A1', '0xF2' => '0xD7A2',
+				'0xF3' => '0xD7A3', '0xF5' => '0xD7A5', '0xF6' => '0xD7A6',
+				'0xF7' => '0xD7A7', '0xF8' => '0xD7A8', '0xF9' => '0xD7A9',
+				'0x82' => '0xE2809A', '0x84' => '0xE2809E', '0x85' => '0xE280A6',
+				'0x86' => '0xE280A0', '0x87' => '0xE280A1', '0x89' => '0xE280B0',
+				'0x8B' => '0xE280B9', '0x93' => '0xE2809C', '0x94' => '0xE2809D',
+				'0x95' => '0xE280A2', '0x97' => '0xE28094', '0x99' => '0xE284A2',
+				'0xC0' => '0xD6B0', '0xC1' => '0xD6B1', '0xC3' => '0xD6B3',
+				'0xC4' => '0xD6B4', '0xC5' => '0xD6B5', '0xC6' => '0xD6B6',
+				'0xC7' => '0xD6B7', '0xC8' => '0xD6B8', '0xC9' => '0xD6B9',
+				'0xCB' => '0xD6BB', '0xCC' => '0xD6BC', '0xCD' => '0xD6BD',
+				'0xCE' => '0xD6BE', '0xCF' => '0xD6BF', '0xD0' => '0xD780',
+				'0xD2' => '0xD782', '0xE3' => '0xD793', '0xE4' => '0xD794',
+				'0xE5' => '0xD795', '0xE7' => '0xD797', '0xE9' => '0xD799',
+				'0xFD' => '0xE2808E', '0xFE' => '0xE2808F', '0x92' => '0xE28099',
+				'0x83' => '0xC692', '0xD3' => '0xD783', '0x88' => '0xCB86',
+				'0x98' => '0xCB9C', '0x91' => '0xE28098', '0x96' => '0xE28093',
+				'0xBA' => '0xC3B7', '0x9B' => '0xE280BA', '0xAA' => '0xC397',
+				'0xA4' => '0xE282AA', '0xE1' => '0xD791', '0xE6' => '0xD796',
+				'0xE8' => '0xD798', '0xEB' => '0xD79B', '0xF4' => '0xD7A4',
+				'0xFA' => '0xD7AA', '0xFF' => '0xD6B2', '0xFC' => '0xE282AC',
 				'0xFB' => '0xD792',
 			),
 			'windows-1253' => array(
-				'0x81' => '\'\'',			'0x88' => '\'\'',			'0x8A' => '\'\'',
-				'0x8C' => '\'\'',			'0x8D' => '\'\'',			'0x8E' => '\'\'',
-				'0x8F' => '\'\'',			'0x90' => '\'\'',			'0x98' => '\'\'',
-				'0x9A' => '\'\'',			'0x9C' => '\'\'',			'0x9D' => '\'\'',
-				'0x9E' => '\'\'',			'0x9F' => '\'\'',			'0xAA' => '\'\'',
-				'0xD2' => '\'\'',			'0xFF' => '\'\'',			'0xCE' => '0xCE9E',
-				'0xB8' => '0xCE88',		'0xBA' => '0xCE8A',		'0xBC' => '0xCE8C',
-				'0xBE' => '0xCE8E',		'0xBF' => '0xCE8F',		'0xC0' => '0xCE90',
-				'0xC8' => '0xCE98',		'0xCA' => '0xCE9A',		'0xCC' => '0xCE9C',
-				'0xCD' => '0xCE9D',		'0xCF' => '0xCE9F',		'0xDA' => '0xCEAA',
-				'0xE8' => '0xCEB8',		'0xEA' => '0xCEBA',		'0xEC' => '0xCEBC',
-				'0xEE' => '0xCEBE',		'0xEF' => '0xCEBF',		'0xC2' => '0xFF',
-				'0xBD' => '0xC2BD',		'0xED' => '0xCEBD',		'0xB2' => '0xC2B2',
-				'0xA0' => '0xC2A0',		'0xA3' => '0xC2A3',		'0xA4' => '0xC2A4',
-				'0xA5' => '0xC2A5',		'0xA6' => '0xC2A6',		'0xA7' => '0xC2A7',
-				'0xA8' => '0xC2A8',		'0xA9' => '0xC2A9',		'0xAB' => '0xC2AB',
-				'0xAC' => '0xC2AC',		'0xAD' => '0xC2AD',		'0xAE' => '0xC2AE',
-				'0xB0' => '0xC2B0',		'0xB1' => '0xC2B1',		'0xB3' => '0xC2B3',
-				'0xB5' => '0xC2B5',		'0xB6' => '0xC2B6',		'0xB7' => '0xC2B7',
-				'0xBB' => '0xC2BB',		'0xE2' => '0xCEB2',		'0x80' => '0xD2',
-				'0x82' => '0xE2809A',	'0x84' => '0xE2809E',	'0x85' => '0xE280A6',
-				'0x86' => '0xE280A0',	'0xA1' => '0xCE85',		'0xA2' => '0xCE86',
-				'0x87' => '0xE280A1',	'0x89' => '0xE280B0',	'0xB9' => '0xCE89',
-				'0x8B' => '0xE280B9',	'0x91' => '0xE28098',	'0x99' => '0xE284A2',
-				'0x92' => '0xE28099',	'0x93' => '0xE2809C',	'0x94' => '0xE2809D',
-				'0x95' => '0xE280A2',	'0x96' => '0xE28093',	'0x97' => '0xE28094',
-				'0x9B' => '0xE280BA',	'0xAF' => '0xE28095',	'0xB4' => '0xCE84',
-				'0xC1' => '0xCE91',		'0xC3' => '0xCE93',		'0xC4' => '0xCE94',
-				'0xC5' => '0xCE95',		'0xC6' => '0xCE96',		'0x83' => '0xC692',
-				'0xC7' => '0xCE97',		'0xC9' => '0xCE99',		'0xCB' => '0xCE9B',
-				'0xD0' => '0xCEA0',		'0xD1' => '0xCEA1',		'0xD3' => '0xCEA3',
-				'0xD4' => '0xCEA4',		'0xD5' => '0xCEA5',		'0xD6' => '0xCEA6',
-				'0xD7' => '0xCEA7',		'0xD8' => '0xCEA8',		'0xD9' => '0xCEA9',
-				'0xDB' => '0xCEAB',		'0xDC' => '0xCEAC',		'0xDD' => '0xCEAD',
-				'0xDE' => '0xCEAE',		'0xDF' => '0xCEAF',		'0xE0' => '0xCEB0',
-				'0xE1' => '0xCEB1',		'0xE3' => '0xCEB3',		'0xE4' => '0xCEB4',
-				'0xE5' => '0xCEB5',		'0xE6' => '0xCEB6',		'0xE7' => '0xCEB7',
-				'0xE9' => '0xCEB9',		'0xEB' => '0xCEBB',		'0xF0' => '0xCF80',
-				'0xF1' => '0xCF81',		'0xF2' => '0xCF82',		'0xF3' => '0xCF83',
-				'0xF4' => '0xCF84',		'0xF5' => '0xCF85',		'0xF6' => '0xCF86',
-				'0xF7' => '0xCF87',		'0xF8' => '0xCF88',		'0xF9' => '0xCF89',
-				'0xFA' => '0xCF8A',		'0xFB' => '0xCF8B',		'0xFC' => '0xCF8C',
-				'0xFD' => '0xCF8D',		'0xFE' => '0xCF8E',		'0xFF' => '0xCE92',
+				'0x81' => '\'\'', '0x88' => '\'\'', '0x8A' => '\'\'',
+				'0x8C' => '\'\'', '0x8D' => '\'\'', '0x8E' => '\'\'',
+				'0x8F' => '\'\'', '0x90' => '\'\'', '0x98' => '\'\'',
+				'0x9A' => '\'\'', '0x9C' => '\'\'', '0x9D' => '\'\'',
+				'0x9E' => '\'\'', '0x9F' => '\'\'', '0xAA' => '\'\'',
+				'0xD2' => '\'\'', '0xFF' => '\'\'', '0xCE' => '0xCE9E',
+				'0xB8' => '0xCE88', '0xBA' => '0xCE8A', '0xBC' => '0xCE8C',
+				'0xBE' => '0xCE8E', '0xBF' => '0xCE8F', '0xC0' => '0xCE90',
+				'0xC8' => '0xCE98', '0xCA' => '0xCE9A', '0xCC' => '0xCE9C',
+				'0xCD' => '0xCE9D', '0xCF' => '0xCE9F', '0xDA' => '0xCEAA',
+				'0xE8' => '0xCEB8', '0xEA' => '0xCEBA', '0xEC' => '0xCEBC',
+				'0xEE' => '0xCEBE', '0xEF' => '0xCEBF', '0xC2' => '0xFF',
+				'0xBD' => '0xC2BD', '0xED' => '0xCEBD', '0xB2' => '0xC2B2',
+				'0xA0' => '0xC2A0', '0xA3' => '0xC2A3', '0xA4' => '0xC2A4',
+				'0xA5' => '0xC2A5', '0xA6' => '0xC2A6', '0xA7' => '0xC2A7',
+				'0xA8' => '0xC2A8', '0xA9' => '0xC2A9', '0xAB' => '0xC2AB',
+				'0xAC' => '0xC2AC', '0xAD' => '0xC2AD', '0xAE' => '0xC2AE',
+				'0xB0' => '0xC2B0', '0xB1' => '0xC2B1', '0xB3' => '0xC2B3',
+				'0xB5' => '0xC2B5', '0xB6' => '0xC2B6', '0xB7' => '0xC2B7',
+				'0xBB' => '0xC2BB', '0xE2' => '0xCEB2', '0x80' => '0xD2',
+				'0x82' => '0xE2809A', '0x84' => '0xE2809E', '0x85' => '0xE280A6',
+				'0x86' => '0xE280A0', '0xA1' => '0xCE85', '0xA2' => '0xCE86',
+				'0x87' => '0xE280A1', '0x89' => '0xE280B0', '0xB9' => '0xCE89',
+				'0x8B' => '0xE280B9', '0x91' => '0xE28098', '0x99' => '0xE284A2',
+				'0x92' => '0xE28099', '0x93' => '0xE2809C', '0x94' => '0xE2809D',
+				'0x95' => '0xE280A2', '0x96' => '0xE28093', '0x97' => '0xE28094',
+				'0x9B' => '0xE280BA', '0xAF' => '0xE28095', '0xB4' => '0xCE84',
+				'0xC1' => '0xCE91', '0xC3' => '0xCE93', '0xC4' => '0xCE94',
+				'0xC5' => '0xCE95', '0xC6' => '0xCE96', '0x83' => '0xC692',
+				'0xC7' => '0xCE97', '0xC9' => '0xCE99', '0xCB' => '0xCE9B',
+				'0xD0' => '0xCEA0', '0xD1' => '0xCEA1', '0xD3' => '0xCEA3',
+				'0xD4' => '0xCEA4', '0xD5' => '0xCEA5', '0xD6' => '0xCEA6',
+				'0xD7' => '0xCEA7', '0xD8' => '0xCEA8', '0xD9' => '0xCEA9',
+				'0xDB' => '0xCEAB', '0xDC' => '0xCEAC', '0xDD' => '0xCEAD',
+				'0xDE' => '0xCEAE', '0xDF' => '0xCEAF', '0xE0' => '0xCEB0',
+				'0xE1' => '0xCEB1', '0xE3' => '0xCEB3', '0xE4' => '0xCEB4',
+				'0xE5' => '0xCEB5', '0xE6' => '0xCEB6', '0xE7' => '0xCEB7',
+				'0xE9' => '0xCEB9', '0xEB' => '0xCEBB', '0xF0' => '0xCF80',
+				'0xF1' => '0xCF81', '0xF2' => '0xCF82', '0xF3' => '0xCF83',
+				'0xF4' => '0xCF84', '0xF5' => '0xCF85', '0xF6' => '0xCF86',
+				'0xF7' => '0xCF87', '0xF8' => '0xCF88', '0xF9' => '0xCF89',
+				'0xFA' => '0xCF8A', '0xFB' => '0xCF8B', '0xFC' => '0xCF8C',
+				'0xFD' => '0xCF8D', '0xFE' => '0xCF8E', '0xFF' => '0xCE92',
 				'0xD2' => '0xE282AC',
 			),
 		);
@@ -3599,7 +3599,7 @@ 
 		$upcontext['table_count'] = count($queryTables);
 		$file_steps = $upcontext['table_count'];
 
-		for($substep = $_GET['substep']; $substep < $upcontext['table_count']; $substep++)
+		for ($substep = $_GET['substep']; $substep < $upcontext['table_count']; $substep++)
 		{
 			$table = $queryTables[$_GET['substep']];
 
@@ -3827,7 +3827,7 @@ 
 	$upcontext['step_progress'] = (int) (($upcontext['cur_table_num'] / $upcontext['table_count']) * 100);
 	$file_steps = $upcontext['table_count'];
 
-	foreach($keys as $id => $table)
+	foreach ($keys as $id => $table)
 		if ($id < $_GET['substep'])
 			$upcontext['previous_tables'][] = $table;
 
@@ -3842,7 +3842,7 @@ 
 			$upcontext['cur_table_name'] = isset($keys[$substep + 1]) ? $keys[$substep + 1] : $keys[$substep];
 			$upcontext['cur_table_num'] = $substep + 1;
 
-			$upcontext['step_progress'] = (int)(($upcontext['cur_table_num'] / $upcontext['table_count']) * 100);
+			$upcontext['step_progress'] = (int) (($upcontext['cur_table_num'] / $upcontext['table_count']) * 100);
 
 			// Do we need to pause?
 			nextSubstep($substep);
@@ -4079,7 +4079,7 @@ 
 				The following files need to be writable to continue the upgrade. Please ensure the Windows permissions are correctly set to allow this:<br>
 				<ul style="margin: 2.5ex; font-family: monospace;">
 					<li>' . implode('</li>
-					<li>', $upcontext['chmod']['files']). '</li>
+					<li>', $upcontext['chmod']['files']) . '</li>
 				</ul>
 			</div>';
 
@@ -4175,7 +4175,7 @@ 
 		<title>', $txt['upgrade_upgrade_utility'], '</title>
 		<link rel="stylesheet" href="', $settings['default_theme_url'], '/css/index.css?alp21">
 		<link rel="stylesheet" href="', $settings['default_theme_url'], '/css/install.css?alp21">
-		', $txt['lang_rtl'] == true ? '<link rel="stylesheet" href="' . $settings['default_theme_url'] . '/css/rtl.css?alp21">' : '' , '
+		', $txt['lang_rtl'] == true ? '<link rel="stylesheet" href="' . $settings['default_theme_url'] . '/css/rtl.css?alp21">' : '', '
 		<script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.4/jquery.min.js"></script>
 		<script src="', $settings['default_theme_url'], '/scripts/script.js"></script>
 		<script>
@@ -4783,11 +4783,11 @@ 
 
 				$totalTime = '';
 				if ($hours > 0)
-					$totalTime .= $hours . ' hour' . ($hours > 1 ? 's':'') . ' ';
+					$totalTime .= $hours . ' hour' . ($hours > 1 ? 's' : '') . ' ';
 				if ($minutes > 0)
-					$totalTime .= $minutes . ' minute' . ($minutes > 1 ? 's':'') . ' ';
+					$totalTime .= $minutes . ' minute' . ($minutes > 1 ? 's' : '') . ' ';
 				if ($seconds > 0)
-					$totalTime .= $seconds . ' second' . ($seconds > 1 ? 's':'') . ' ';
+					$totalTime .= $seconds . ' second' . ($seconds > 1 ? 's' : '') . ' ';
 			}
 
 			if ($is_debug && !empty($totalTime))
@@ -4820,11 +4820,11 @@ 
 
 				$totalTime = '';
 				if ($hours > 0)
-					$totalTime .= $hours . ' hour' . ($hours > 1 ? 's':'') . ' ';
+					$totalTime .= $hours . ' hour' . ($hours > 1 ? 's' : '') . ' ';
 				if ($minutes > 0)
-					$totalTime .= $minutes . ' minute' . ($minutes > 1 ? 's':'') . ' ';
+					$totalTime .= $minutes . ' minute' . ($minutes > 1 ? 's' : '') . ' ';
 				if ($seconds > 0)
-					$totalTime .= $seconds . ' second' . ($seconds > 1 ? 's':'') . ' ';
+					$totalTime .= $seconds . ' second' . ($seconds > 1 ? 's' : '') . ' ';
 			}
 
 			echo '
@@ -5551,11 +5551,11 @@ 
 	{
 		$totalTime = '';
 		if ($hours > 0)
-			$totalTime .= $hours . ' hour' . ($hours > 1 ? 's':'') . ' ';
+			$totalTime .= $hours . ' hour' . ($hours > 1 ? 's' : '') . ' ';
 		if ($minutes > 0)
-			$totalTime .= $minutes . ' minute' . ($minutes > 1 ? 's':'') . ' ';
+			$totalTime .= $minutes . ' minute' . ($minutes > 1 ? 's' : '') . ' ';
 		if ($seconds > 0)
-			$totalTime .= $seconds . ' second' . ($seconds > 1 ? 's':'') . ' ';
+			$totalTime .= $seconds . ' second' . ($seconds > 1 ? 's' : '') . ' ';
 	}
 
 	if ($is_debug && !empty($totalTime))

Sources/CacheAPI-smf.php

Doc Comments +1 added lines, -1 removed lines

@@ -180,7 +180,7 @@
 	 *
 	 * @access public
 	 * @param string $dir A valid path
-	 * @return boolean If this was successful or not.
+	 * @return boolean|null If this was successful or not.
 	 */
 	public function setCachedir($dir = null)
 	{

Sources/Class-CurlFetchWeb.php

Doc Comments +4 added lines, -4 removed lines

@@ -62,7 +62,7 @@ 
 	* Start the curl object
 	* - allow for user override values
 	*
-	* @param array $options An array of cURL options
+	* @param integer[] $options An array of cURL options
 	* @param int $max_redirect Maximum number of redirects
 	* @return void
 	*/
@@ -81,8 +81,8 @@ 
 	*  - calls set_options to set the curl opts array values based on the defaults and user input
 	*
 	* @param string $url the site we are going to fetch
-	* @param array $post_data any post data as form name => value
-	* @return object An instance of the curl_fetch_web_data class
+	* @param string $post_data any post data as form name => value
+	* @return curl_fetch_web_data An instance of the curl_fetch_web_data class
 	*/
 	public function get_url_data($url, $post_data = array())
 	{
@@ -106,7 +106,7 @@ 
 	*
 	* @param string $url The site to fetch
 	* @param bool $redirect Whether or not this was a redirect request
-	* @return void|bool Sets various properties of the class or returns false if the URL isn't specified
+	* @return false|null Sets various properties of the class or returns false if the URL isn't specified
 	*/
 	private function curl_request($url, $redirect = false)
 	{

Sources/Class-Graphics.php

Doc Comments +28 added lines

@@ -44,6 +44,10 @@ 
 		$this->Buf   = range(0, 279);
 	}
 
+	/**
+	 * @param string $data
+	 * @param integer $datLen
+	 */
 	public function decompress($data, &$datLen)
 	{
 		$stLen  = strlen($data);
@@ -63,6 +67,11 @@ 
 		return $ret;
 	}
 
+	/**
+	 * @param boolean $bInit
+	 *
+	 * @return integer
+	 */
 	public function LZWCommand(&$data, $bInit)
 	{
 		if ($bInit)
@@ -253,6 +262,10 @@ 
 		unset($this->m_nColors, $this->m_arColors);
 	}
 
+	/**
+	 * @param string $lpData
+	 * @param integer $num
+	 */
 	public function load($lpData, $num)
 	{
 		$this->m_nColors  = 0;
@@ -324,6 +337,9 @@ 
 		unset($this->m_bSorted, $this->m_nTableSize, $this->m_nBgColor, $this->m_nPixelRatio, $this->m_colorTable);
 	}
 
+	/**
+	 * @param integer $hdrLen
+	 */
 	public function load($lpData, &$hdrLen)
 	{
 		$hdrLen = 0;
@@ -370,6 +386,10 @@ 
 		unset($this->m_bInterlace, $this->m_bSorted, $this->m_nTableSize, $this->m_colorTable);
 	}
 
+	/**
+	 * @param string $lpData
+	 * @param integer $hdrLen
+	 */
 	public function load($lpData, &$hdrLen)
 	{
 		$hdrLen = 0;
@@ -412,6 +432,10 @@ 
 		$this->m_lzw = new gif_lzw_compression();
 	}
 
+	/**
+	 * @param string $data
+	 * @param integer $datLen
+	 */
 	public function load($data, &$datLen)
 	{
 		$datLen = 0;
@@ -464,6 +488,10 @@ 
 		return false;
 	}
 
+	/**
+	 * @param string $data
+	 * @param integer $extLen
+	 */
 	public function skipExt(&$data, &$extLen)
 	{
 		$extLen = 0;

Spacing +7 added lines, -7 removed lines

@@ -38,8 +38,8 @@ 
 		$this->MAX_LZW_BITS = 12;
 		unset($this->Next, $this->Vals, $this->Stack, $this->Buf);
 
-		$this->Next  = range(0, (1 << $this->MAX_LZW_BITS)       - 1);
-		$this->Vals  = range(0, (1 << $this->MAX_LZW_BITS)       - 1);
+		$this->Next  = range(0, (1 << $this->MAX_LZW_BITS) - 1);
+		$this->Vals  = range(0, (1 << $this->MAX_LZW_BITS) - 1);
 		$this->Stack = range(0, (1 << ($this->MAX_LZW_BITS + 1)) - 1);
 		$this->Buf   = range(0, 279);
 	}
@@ -278,9 +278,9 @@ 
 		for ($i = 0; $i < $this->m_nColors; $i++)
 		{
 			$ret .=
-				chr(($this->m_arColors[$i] & 0x000000FF))       . // R
-				chr(($this->m_arColors[$i] & 0x0000FF00) >>  8) . // G
-				chr(($this->m_arColors[$i] & 0x00FF0000) >> 16);  // B
+				chr(($this->m_arColors[$i] & 0x000000FF)) . // R
+				chr(($this->m_arColors[$i] & 0x0000FF00) >> 8) . // G
+				chr(($this->m_arColors[$i] & 0x00FF0000) >> 16); // B
 		}
 
 		return $ret;
@@ -290,14 +290,14 @@ 
 	{
 		$rgb  = intval($rgb) & 0xFFFFFF;
 		$r1   = ($rgb & 0x0000FF);
-		$g1   = ($rgb & 0x00FF00) >>  8;
+		$g1   = ($rgb & 0x00FF00) >> 8;
 		$b1   = ($rgb & 0xFF0000) >> 16;
 		$idx  = -1;
 
 		for ($i = 0; $i < $this->m_nColors; $i++)
 		{
 			$r2 = ($this->m_arColors[$i] & 0x000000FF);
-			$g2 = ($this->m_arColors[$i] & 0x0000FF00) >>  8;
+			$g2 = ($this->m_arColors[$i] & 0x0000FF00) >> 8;
 			$b2 = ($this->m_arColors[$i] & 0x00FF0000) >> 16;
 			$d  = abs($r2 - $r1) + abs($g2 - $g1) + abs($b2 - $b1);
 

Sources/Class-Package.php

Doc Comments +4 added lines, -4 removed lines

@@ -257,7 +257,7 @@ 
 	 * of elements, an array of xmlArray's is returned for use with foreach.
 	 * Example use:
 	 *  foreach ($xml->set('html/body/p') as $p)
-	 * @param $path string The path to search for.
+	 * @param string $path string The path to search for.
 	 * @return array An array of xmlArray objects
 	 */
 	public function set($path)
@@ -855,7 +855,7 @@ 
 	 * Changes a files atrributes (chmod)
 	 *
 	 * @param string $ftp_file The file to CHMOD
-	 * @param int|string $chmod The value for the CHMOD operation
+	 * @param integer $chmod The value for the CHMOD operation
 	 * @return boolean Whether or not the operation was successful
 	 */
 	public function chmod($ftp_file, $chmod)
@@ -1025,7 +1025,7 @@ 
 	 *
 	 * @param string $ftp_path The path to the directory
 	 * @param bool $search Whether or not to get a recursive directory listing
-	 * @return string|boolean The results of the command or false if unsuccessful
+	 * @return false|string The results of the command or false if unsuccessful
 	 */
 	public function list_dir($ftp_path = '', $search = false)
 	{
@@ -1070,7 +1070,7 @@ 
 	 *
 	 * @param string $file The name of a file
 	 * @param string $listing A directory listing or null to generate one
-	 * @return string|boolean The name of the file or false if it wasn't found
+	 * @return string|false The name of the file or false if it wasn't found
 	 */
 	public function locate($file, $listing = null)
 	{

Spacing +5 added lines, -5 removed lines

@@ -424,7 +424,7 @@ 
 			if ((!isset($match[3]) || trim($match[3]) != '/') && (!isset($match[2]) || trim($match[2]) != '/'))
 			{
 				// Because PHP 5.2.0+ seems to croak using regex, we'll have to do this the less fun way.
-				$last_tag_end = strpos($data, '</' . $match[1]. '>');
+				$last_tag_end = strpos($data, '</' . $match[1] . '>');
 				if ($last_tag_end === false)
 					continue;
 
@@ -438,7 +438,7 @@ 
 						break;
 
 					// If not then find the next ending tag.
-					$next_tag_end = strpos($data, '</' . $match[1]. '>', $offset);
+					$next_tag_end = strpos($data, '</' . $match[1] . '>', $offset);
 
 					// Didn't find one? Then just use the last and sod it.
 					if ($next_tag_end === false)
@@ -452,7 +452,7 @@ 
 				// Parse the insides.
 				$inner_match = substr($data, 0, $last_tag_end);
 				// Data now starts from where this section ends.
-				$data = substr($data, $last_tag_end + strlen('</' . $match[1]. '>'));
+				$data = substr($data, $last_tag_end + strlen('</' . $match[1] . '>'));
 
 				if (!empty($inner_match))
 				{
@@ -618,7 +618,7 @@ 
 		$trans_tbl = array_flip(get_html_translation_table(HTML_ENTITIES, ENT_QUOTES));
 
 		// Translate all the entities out.
-		$data = strtr(preg_replace_callback('~&#(\d{1,4});~', function ($m)
+		$data = strtr(preg_replace_callback('~&#(\d{1,4});~', function($m)
 		{
 			return chr("$m[1]");
 		}, $data), $trans_tbl);
@@ -873,7 +873,7 @@ 
 		// Set different modes.
 		$chmod_values = $is_dir ? array(0750, 0755, 0775, 0777) : array(0644, 0664, 0666);
 
-		foreach($chmod_values as $val)
+		foreach ($chmod_values as $val)
 		{
 			// If it's writable, break out of the loop.
 			if (is_writable($ftp_file))

Sources/Class-SearchAPI.php

Doc Comments +2 added lines, -1 removed lines

@@ -56,6 +56,7 @@ 
 	 * @param array $wordsSearch Search words
 	 * @param array $wordsExclude Words to exclude
 	 * @param bool $isExcluded Whether the specfied word should be excluded
+	 * @return void
 	 */
 	public function prepareIndexes($word, array &$wordsSearch, array &$wordsExclude, $isExcluded);
 
@@ -130,7 +131,7 @@ 
 	 * @param array $excludedIndexWords Indexed words that should be excluded
 	 * @param array $participants
 	 * @param array $searchArray
-	 * @return mixed
+	 * @return integer
 	 */
 	public function searchQuery(array $query_params, array $searchWords, array $excludedIndexWords, array &$participants, array &$searchArray);
 }

Sources/Class-TOTP.php

Doc Comments +2 added lines, -2 removed lines

@@ -279,7 +279,7 @@ 
 	/**
 	 * Generate the timestamp for the calculation
 	 *
-	 * @return integer Timestamp
+	 * @return double Timestamp
 	 */
 	public function generateTimestamp()
 	{
@@ -290,7 +290,7 @@ 
 	 * Truncate the given hash down to just what we need
 	 *
 	 * @param string $hash Hash to truncate
-	 * @return string Truncated hash value
+	 * @return integer Truncated hash value
 	 */
 	public function truncateHash($hash)
 	{

Spacing +9 added lines, -9 removed lines

@@ -114,7 +114,7 @@ 
 	 */
 	public function setInitKey($key)
 	{
-		if (preg_match('/^['.implode('', array_keys($this->getLookup())).']+$/', $key) == false) {
+		if (preg_match('/^[' . implode('', array_keys($this->getLookup())) . ']+$/', $key) == false) {
 			throw new \InvalidArgumentException('Invalid base32 hash!');
 		}
 		$this->initKey = $key;
@@ -247,7 +247,7 @@ 
 		$initKey = ($initKey == null) ? $this->getInitKey() : $initKey;
 		$timestamp = ($timestamp == null) ? $this->generateTimestamp() : $timestamp;
 
-		$hash = hash_hmac (
+		$hash = hash_hmac(
 			'sha1',
 			pack('N*', 0) . pack('N*', $timestamp),
 			$initKey,
@@ -270,7 +270,7 @@ 
 		$code = '';
 
 		for ($i = 0; $i < $length; $i++) {
-			$code .= $lookup[mt_rand(0, strlen($lookup)-1)];
+			$code .= $lookup[mt_rand(0, strlen($lookup) - 1)];
 		}
 
 		return $code;
@@ -283,7 +283,7 @@ 
 	 */
 	public function generateTimestamp()
 	{
-		return floor(microtime(true)/$this->getRefresh());
+		return floor(microtime(true) / $this->getRefresh());
 	}
 
 	/**
@@ -297,10 +297,10 @@ 
 		$offset = ord($hash[19]) & 0xf;
 
 		return (
-			((ord($hash[$offset+0]) & 0x7f) << 24 ) |
-			((ord($hash[$offset+1]) & 0xff) << 16 ) |
-			((ord($hash[$offset+2]) & 0xff) << 8 ) |
-			(ord($hash[$offset+3]) & 0xff)
+			((ord($hash[$offset + 0]) & 0x7f) << 24) |
+			((ord($hash[$offset + 1]) & 0xff) << 16) |
+			((ord($hash[$offset + 2]) & 0xff) << 8) |
+			(ord($hash[$offset + 3]) & 0xff)
 		) % pow(10, $this->getCodeLength());
 	}
 
@@ -315,7 +315,7 @@ 
 	{
 		$lookup = $this->getLookup();
 
-		if (preg_match('/^['.implode('', array_keys($lookup)).']+$/', $hash) == false) {
+		if (preg_match('/^[' . implode('', array_keys($lookup)) . ']+$/', $hash) == false) {
 			throw new \InvalidArgumentException('Invalid base32 hash!');
 		}
 

Sources/DbPackages-mysql.php

Doc Comments +1 added lines, -1 removed lines

@@ -382,7 +382,7 @@
  * @param array $parameters Not used?
  * @param string $if_exists What to do if the index exists. If 'update', the definition will be updated.
  * @param string $error
- * @return boolean Whether or not the operation was successful
+ * @return false|null Whether or not the operation was successful
  */
 function smf_db_add_index($table_name, $index_info, $parameters = array(), $if_exists = 'update', $error = 'fatal')
 {

Spacing +2 added lines, -2 removed lines

@@ -125,7 +125,7 @@ 
 	// Righty - let's do the damn thing!
 	$table_query = 'CREATE TABLE ' . $table_name . "\n" . '(';
 	foreach ($columns as $column)
-		$table_query .= "\n\t" . smf_db_create_query_column($column)  . ',';
+		$table_query .= "\n\t" . smf_db_create_query_column($column) . ',';
 
 	// Loop through the indexes next...
 	foreach ($indexes as $index)
@@ -744,7 +744,7 @@ 
 		$type = $type . '(' . $size . ')';
 
 	// Now just put it together!
-	return '`' .$column['name'] . '` ' . $type . ' ' . (!empty($unsigned) ? $unsigned : '') . (!empty($column['null']) ? '' : 'NOT NULL') . ' ' . $default;
+	return '`' . $column['name'] . '` ' . $type . ' ' . (!empty($unsigned) ? $unsigned : '') . (!empty($column['null']) ? '' : 'NOT NULL') . ' ' . $default;
 }
 
 ?>
\ No newline at end of file

Sources/DbPackages-postgresql.php

Doc Comments +1 added lines, -1 removed lines

@@ -518,7 +518,7 @@
  * @param array $parameters Not used?
  * @param string $if_exists What to do if the index exists. If 'update', the definition will be updated.
  * @param string $error
- * @return boolean Whether or not the operation was successful
+ * @return false|null Whether or not the operation was successful
  */
 function smf_db_add_index($table_name, $index_info, $parameters = array(), $if_exists = 'update', $error = 'fatal')
 {