Merge pull request #1 from Wikia/PLATFORM-6983

PLATFORM-6983 - Code reformatting

Author: slayful

.phpcs.xml

@@ -1,7 +1,7 @@
 <?xml version="1.0"?>
 <ruleset name="MediaWiki">
-    <rule ref="./vendor/hydrawiki/hydrawiki-codesniffer/HydraWiki" />
-    <file>.</file>
-    <arg name="encoding" value="utf8"/>
-    <arg name="extensions" value="php"/>
+	<rule ref="./vendor/hydrawiki/hydrawiki-codesniffer/HydraWiki"/>
+	<file>.</file>
+	<arg name="encoding" value="utf8"/>
+	<arg name="extensions" value="php"/>
 </ruleset>

PvXCode.hooks.php

@@ -1,28 +1,31 @@
 <?php
+
 /**
  * Curse Inc.
  * PvX Code
  * Guild Wars Template to PvXCode Handling
  *
- * @author		Cameron Chunn
- * @copyright	(c) 2015 Curse Inc.
- * @license		GNU General Public License v2.0 or later
- * @package		PvXCode
- * @link		https://gitlab.com/hydrawiki
+ * @author        Cameron Chunn
+ * @copyright    (c) 2015 Curse Inc.
+ * @license        GPL-2.0-or-later
+ * @package        PvXCode
+ * @link        https://gitlab.com/hydrawiki
  *
  * Purpose of this file:
  *  Declares how the extension will interpret pvxbig tag
  *  Loads the gwbbcode.inc.php file for builds and tooltips
-**/
+ */
 class PvXCodeHooks {
 	/**
 	 * @see https://www.mediawiki.org/wiki/Manual:Hooks/ParserFirstCallInit
-	 * @param Parser $parser
+	 * @param Parser &$parser
 	 * @return true
+	 * @throws MWException
 	 */
-	public static function onParserFirstCallInit( Parser &$parser ) {
+	public static function onParserFirstCallInit( Parser &$parser ): bool {
 		// Calls PvXCode.php within the classes folder
-		$parser->setHook('pvxbig', 'PvXCode::ParserRender');
+		$parser->setHook( 'pvxbig', 'PvXCode::parserRender' );
+
 		return true;
 	}
 
@@ -31,23 +34,25 @@ public static function onParserFirstCallInit( Parser &$parser ) {
 	 * @return void
 	 */
 	public static function onRegistration() {
-		// Retrieve config settings from localSettings.php - probably a better way of doing this via "use MediaWiki\MediaWikiServices;"
+		// Retrieve config settings from localSettings.php -
+		// probably a better way of doing this via "use MediaWiki\MediaWikiServices;"
 		global $wgServer, $wgScriptPath, $wgExtensionAssetsPath;
 
 		// Local file path for includes
-		define('GWBBCODE_ROOT', __DIR__.'/gwbbcode');
+		define( 'GWBBCODE_ROOT', __DIR__ . '/gwbbcode' );
 
-		// Website URL for the image folder within extension/PvXCode folder, e.g. '/extensions/PvXCode/images'/img_skills/83.jpg
-		define('GWBBCODE_IMAGES_FOLDER_URL', $wgExtensionAssetsPath.'/PvXCode/images');
+		// Website URL for the image folder within extension/PvXCode folder,
+		//e.g. '/extensions/PvXCode/images'/img_skills/83.jpg
+		define( 'GWBBCODE_IMAGES_FOLDER_URL', $wgExtensionAssetsPath . '/PvXCode/images' );
 
-		// Website URL for the page prefix, e.g. 'https://gwpvx.gamepedia.com/index.php?title='/Archive:Team_-_Frostmaw_Searing_Spike
-		define('PVX_WIKI_PAGE_URL', $wgServer.$wgScriptPath );
+		// Website URL for the page prefix,
+		// e.g. 'https://gwpvx.gamepedia.com/index.php?title='/Archive:Team_-_Frostmaw_Searing_Spike
+		define( 'PVX_WIKI_PAGE_URL', $wgServer . $wgScriptPath );
 
 		// Website URL for the page prefix on the prefered wiki database
-		define('GW_WIKI_PAGE_URL', 'https://wiki.guildwars.com/wiki');
+		define( 'GW_WIKI_PAGE_URL', 'https://wiki.guildwars.com/wiki' );
 
 		// Load main script
-		require_once(GWBBCODE_ROOT.'/gwbbcode.inc.php');
+		require_once( GWBBCODE_ROOT . '/gwbbcode.inc.php' );
 	}
-
 }

PvXCode.php

@@ -4,26 +4,27 @@
  * PvX Code
  * Guildwiki / Guild Wars Template to PvXCode Handling
  *
- * @author		Cameron Chunn
- * @copyright	(c) 2015 Curse Inc.
- * @license		GNU General Public License v2.0 or later
- * @package		PvXCode
- * @link		https://gitlab.com/hydrawiki
+ * @author        Cameron Chunn
+ * @copyright    (c) 2015 Curse Inc.
+ * @license        GPL-2.0-or-later
+ * @package        PvXCode
+ * @link        https://gitlab.com/hydrawiki
  *
  * Purpose of this file:
  *  Allows the extension to be loaded from localSettings.php
-**/
+ */
 if ( function_exists( 'wfLoadExtension' ) ) {
-   // The following line seeks the PvXCode/extension.json file
-   wfLoadExtension( 'PvXCode' );
+	// The following line seeks the PvXCode/extension.json file
+	wfLoadExtension( 'PvXCode' );
 
-   // Keep i18n globals so mergeMessageFileList.php doesn't break
-   $wgMessagesDirs['PvXCode'] = __DIR__ . '/i18n';
-   wfWarn(
-	   'Deprecated PHP entry point used for PvX Vote extension. Please use wfLoadExtension instead, ' .
-	   'see https://www.mediawiki.org/wiki/Extension_registration for more details.'
-   );
-   return;
+	// Keep i18n globals so mergeMessageFileList.php doesn't break
+	$wgMessagesDirs['PvXCode'] = __DIR__ . '/i18n';
+	wfWarn(
+		'Deprecated PHP entry point used for PvX Vote extension. Please use wfLoadExtension instead, ' .
+		'see https://www.mediawiki.org/wiki/Extension_registration for more details.'
+	);
+
+	return;
 } else {
-   die( 'This version of the PvXCode extension requires MediaWiki 1.25+' );
+	die( 'This version of the PvXCode extension requires MediaWiki 1.25+' );
 }

classes/PvXCode.php

@@ -4,30 +4,32 @@
  * PvX Code
  * Guildwiki / Guild Wars Template to PvXCode Handling
  *
- * @author		Cameron Chunn
- * @copyright	(c) 2015 Curse Inc.
- * @license		GNU General Public License v2.0 or later
- * @package		PvXCode
- * @link		https://gitlab.com/hydrawiki
+ * @author        Cameron Chunn
+ * @copyright    (c) 2015 Curse Inc.
+ * @license        GPL-2.0-or-later
+ * @package        PvXCode
+ * @link        https://gitlab.com/hydrawiki
  *
-**/
+ */
 
 class PvXCode {
 	/**
 	 * Parser Renderer
-	 * @param string $input  text input into parser
-	 * @param array $args  parsing arguements, not used in this function, but neaded by mediawiki.
-	 * @param Parser $parser  reference to the parser
-	 * @param string $frame  not used in this function, but needed by mediawiki.
+	 * @param string $input text input into parser
+	 * @param array $args parsing arguements, not used in this function, but neaded by mediawiki.
+	 * @param Parser $parser reference to the parser
+	 * @param string $frame not used in this function, but needed by mediawiki.
+	 * @return array|string|string[]|null
 	 */
-	public static function ParserRender($input, $args, $parser, $frame) {
-		$parser->getOutput()->addModuleStyles('ext.PvXCode.css');
-		$parser->getOutput()->addModules('ext.PvXCode.js');
+	public static function parserRender( string $input, array $args, Parser $parser, string $frame ) {
+		$parser->getOutput()->addModuleStyles( 'ext.PvXCode.css' );
+		$parser->getOutput()->addModules( 'ext.PvXCode.js' );
 		$title = $parser->getTitle()->getText();
 
-		// Using recursiveTagParse() instead of parse() to avoid wrapping result in a div and the associated processing time hidden HTML comment
-		$parsed_input = $parser->recursiveTagParse($input, $frame = false);
-		$results = parse_gwbbcode($parsed_input, $title);
-		return $results;
+		// Using recursiveTagParse() instead of parse() to avoid wrapping result
+		// in a div and the associated processing time hidden HTML comment
+		$parsed_input = $parser->recursiveTagParse( $input, $frame = false );
+
+		return parseGwbbcode( $parsed_input, $title );
 	}
 }