Fix almost all PHPCS issues

Change-Id: Ic5f9a4ac304a6667068da59f292b05ff36a21878

.phpcs.xml

@@ -1,14 +1,7 @@
 <?xml version="1.0"?>
 <ruleset>
 	<rule ref="./vendor/mediawiki/mediawiki-codesniffer/MediaWiki">
-		<exclude name="MediaWiki.Commenting.FunctionComment.MissingDocumentationPrivate" />
-		<exclude name="MediaWiki.Commenting.FunctionComment.MissingDocumentationProtected" />
 		<exclude name="MediaWiki.Commenting.FunctionComment.MissingDocumentationPublic" />
-		<exclude name="MediaWiki.Commenting.FunctionComment.ObjectTypeHintParam" />
-		<exclude name="MediaWiki.Commenting.PropertyDocumentation.MissingDocumentationPrivate" />
-		<exclude name="MediaWiki.NamingConventions.LowerCamelFunctionsName.FunctionName" />
-		<exclude name="MediaWiki.Usage.ExtendClassUsage.FunctionVarUsage" />
-		<exclude name="MediaWiki.VariableAnalysis.MisleadingGlobalNames.Misleading$wgUploadWizardConfig" />
 		<exclude name="MediaWiki.WhiteSpace.SpaceBeforeSingleLineComment.NewLineComment" />
 	</rule>
 	<file>.</file>

includes/CampaignContent.php

@@ -45,7 +45,7 @@ class CampaignContent extends JsonContent {
 			}
 		}
 
-		$mergedConfig = UploadWizardConfig::array_replace_sanely( $defaultCampaignConfig, $campaign );
+		$mergedConfig = UploadWizardConfig::arrayReplaceSanely( $defaultCampaignConfig, $campaign );
 		return EventLogging::schemaValidate( $mergedConfig, $schema );
 	}
 

includes/CampaignContentHandler.php

@@ -12,14 +12,23 @@
 
 class CampaignContentHandler extends JsonContentHandler {
 
+	/**
+	 * @param string $modelId
+	 */
 	public function __construct( $modelId = 'Campaign' ) {
 		parent::__construct( $modelId );
 	}
 
+	/**
+	 * @inheritDoc
+	 */
 	protected function getContentClass() {
 		return CampaignContent::class;
 	}
 
+	/**
+	 * @return CampaignContent
+	 */
 	public function makeEmptyContent() {
 		$class = $this->getContentClass();
 		return new $class( '{"enabled":false}' );

includes/UploadWizardConfig.php

@@ -20,7 +20,7 @@ class UploadWizardConfig {
 	 *
 	 * @return bool
 	 */
-	private static function is_assoc( $array ) {
+	private static function isAssoc( $array ) {
 		return (bool)count( array_filter( array_keys( $array ), 'is_string' ) );
 	}
 
@@ -34,15 +34,15 @@ class UploadWizardConfig {
 	 *
 	 * @return array Yet another array, sanely replacing contents of $array with $array1
 	 */
-	public static function array_replace_sanely( $array, $array1 ) {
+	public static function arrayReplaceSanely( $array, $array1 ) {
 		$newArray = [];
 
 		foreach ( $array as $key => $value ) {
 			if ( array_key_exists( $key, $array1 ) ) {
 				switch ( gettype( $value ) ) {
 				case "array":
-					if ( self::is_assoc( $array[$key] ) ) {
-						$newArray[$key] = self::array_replace_sanely( $array[$key], $array1[$key] );
+					if ( self::isAssoc( $array[$key] ) ) {
+						$newArray[$key] = self::arrayReplaceSanely( $array[$key], $array1[$key] );
 						break;
 					}
 					# fall through
@@ -82,7 +82,7 @@ class UploadWizardConfig {
 		static $mergedConfig = false;
 
 		if ( !$mergedConfig ) {
-			$wgUploadWizardConfig = self::array_replace_sanely(
+			$wgUploadWizardConfig = self::arrayReplaceSanely(
 				self::getDefaultConfig(),
 				$wgUploadWizardConfig
 			);
@@ -90,7 +90,7 @@ class UploadWizardConfig {
 		}
 
 		if ( $campaignName !== null ) {
-			$wgUploadWizardConfig = self::array_replace_sanely(
+			$wgUploadWizardConfig = self::arrayReplaceSanely(
 				$wgUploadWizardConfig,
 				self::getCampaignConfig( $campaignName )
 			);

includes/specials/SpecialCampaigns.php

@@ -58,6 +58,11 @@ class SpecialCampaigns extends SpecialPage {
 		}
 	}
 
+	/**
+	 * @param UploadWizardCampaign $campaign
+	 *
+	 * @return string
+	 */
 	private function getHtmlForCampaign( UploadWizardCampaign $campaign ) {
 		$config = $campaign->getParsedConfig();
 		$campaignURL = $campaign->getTitle()->getLocalURL();
@@ -72,6 +77,11 @@ class SpecialCampaigns extends SpecialPage {
 		return $returnHTML;
 	}
 
+	/**
+	 * @param int $firstId
+	 *
+	 * @return string
+	 */
 	private function getHtmlForPagination( $firstId ) {
 		$nextHref = $this->getPageTitle()->getLocalURL( [ 'start' => $firstId ] );
 		return Html::rawElement( 'div',
@@ -83,6 +93,9 @@ class SpecialCampaigns extends SpecialPage {
 		);
 	}
 
+	/**
+	 * @inheritDoc
+	 */
 	protected function getGroupName() {
 		return 'media';
 	}

includes/specials/SpecialUploadWizard.php

@@ -344,7 +344,7 @@ class SpecialUploadWizard extends SpecialPage {
 				Html::element(
 					'p',
 					[ 'style' => 'text-align: center' ],
-					wfMessage( 'mwe-upwiz-extension-disabled' )->text()
+					$this->msg( 'mwe-upwiz-extension-disabled' )->text()
 				) . $linkHtml
 			);
 		}
@@ -367,6 +367,9 @@ class SpecialUploadWizard extends SpecialPage {
 		// @codingStandardsIgnoreEnd
 	}
 
+	/**
+	 * @inheritDoc
+	 */
 	protected function getGroupName() {
 		return 'media';
 	}

maintenance/migrateCampaigns.php

@@ -53,7 +53,7 @@ class MigrateCampaigns extends Maintenance {
 		$this->addOption( 'user', 'The user to perform the migration as', false, true, 'u' );
 	}
 
-	private $oldKeyDefaults = [
+	private const OLD_KEY_DEFAULTS = [
 		'headerLabelPage' => '',
 		'thanksLabelPage' => '',
 
@@ -89,7 +89,7 @@ class MigrateCampaigns extends Maintenance {
 		'idField2InitialValue' => ''
 	];
 
-	private $oldNumberConfigs = [
+	private const OLD_NUMBER_CONFIGS = [
 		'idFieldMaxLength',
 		'idField2MaxLength',
 		'tutorialWidth',
@@ -113,7 +113,7 @@ class MigrateCampaigns extends Maintenance {
 		);
 
 		foreach ( $confProps as $confProp ) {
-			if ( in_array( $confProp->cc_property, $this->oldNumberConfigs ) ) {
+			if ( in_array( $confProp->cc_property, self::OLD_NUMBER_CONFIGS ) ) {
 				$config[$confProp->cc_property] = intval( $confProp->cc_value );
 			} else {
 				$config[$confProp->cc_property] = $confProp->cc_value;
@@ -122,7 +122,7 @@ class MigrateCampaigns extends Maintenance {
 
 		$mergedConfig = [];
 
-		foreach ( $this->oldKeyDefaults as $key => $default ) {
+		foreach ( self::OLD_KEY_DEFAULTS as $key => $default ) {
 			if ( array_key_exists( $key, $config ) && $config[$key] !== $default ) {
 				$mergedConfig[$key] = $config[$key];
 			} else {
@@ -191,7 +191,7 @@ class MigrateCampaigns extends Maintenance {
 	}
 
 	/**
-	 * @param object $campaign
+	 * @param stdClass $campaign
 	 * @param array $oldConfig
 	 * @return array
 	 */

tests/phpunit/ApiFlickrBlacklistTest.php

@@ -157,19 +157,18 @@ class ApiFlickrBlacklistTest extends ApiTestCase {
 		// Don't actually run HTTP requests in unit test runs
 		$this->installMockHttp( $this->makeFakeHttpRequest( '', 0 ) );
 
-		// this is needed to initialize the global $wgUploadWizardConfig
-		$wgUploadWizardConfig = UploadWizardConfig::getConfig();
+		$config = UploadWizardConfig::getConfig();
 
-		if ( !isset( $wgUploadWizardConfig['flickrApiKey'] ) ) {
+		if ( !isset( $config['flickrApiKey'] ) ) {
 			$this->markTestSkipped( 'This test needs a Flickr API key to work' );
 		}
-		if ( !isset( $wgUploadWizardConfig['flickrApiUrl'] )
+		if ( !isset( $config['flickrApiUrl'] )
 			// FIXME: This will always return false due to MockHttpTrait.
-			|| Http::get( $wgUploadWizardConfig['flickrApiUrl'] ) === false
+			|| Http::get( $config['flickrApiUrl'] ) === false
 		) {
 			// Http::get returns false if the server is unreachable.
 			// Sometimes unit tests may be run in places without network access.
-			$this->markTestSkipped( $wgUploadWizardConfig['flickrApiUrl'] . ' is unreachable.' );
+			$this->markTestSkipped( $config['flickrApiUrl'] . ' is unreachable.' );
 		}
 	}