From 4a1517b3e1ffcf7ac134bc273dafe3e19810da33 Mon Sep 17 00:00:00 2001
From: Aaron Schulz <aschulz@wikimedia.org>
Date: Thu, 1 Aug 2019 15:49:38 -0400
Subject: [PATCH] resourceloader: reorganize ResourceLoaderModule fields

Also use AtEase for error suppression to avoid phpstorm warnings

Change-Id: Iaa8ca107f4e7c923e894416b40b4fadd2b3d162e
---
 .../resourceloader/ResourceLoaderModule.php   | 96 +++++++++----------
 1 file changed, 47 insertions(+), 49 deletions(-)

diff --git a/includes/resourceloader/ResourceLoaderModule.php b/includes/resourceloader/ResourceLoaderModule.php
index c376fa7362..ed2d09c8dc 100644
--- a/includes/resourceloader/ResourceLoaderModule.php
+++ b/includes/resourceloader/ResourceLoaderModule.php
@@ -26,6 +26,7 @@ use MediaWiki\MediaWikiServices;
 use Psr\Log\LoggerAwareInterface;
 use Psr\Log\LoggerInterface;
 use Psr\Log\NullLogger;
+use Wikimedia\AtEase\AtEase;
 use Wikimedia\RelPath;
 use Wikimedia\ScopedCallback;
 
@@ -33,65 +34,63 @@ use Wikimedia\ScopedCallback;
  * Abstraction for ResourceLoader modules, with name registration and maxage functionality.
  */
 abstract class ResourceLoaderModule implements LoggerAwareInterface {
-	# Type of resource
-	const TYPE_SCRIPTS = 'scripts';
-	const TYPE_STYLES = 'styles';
-	const TYPE_COMBINED = 'combined';
-
-	# Desired load type
-	// Module only has styles (loaded via <style> or <link rel=stylesheet>)
-	const LOAD_STYLES = 'styles';
-	// Module may have other resources (loaded via mw.loader from a script)
-	const LOAD_GENERAL = 'general';
-
-	# sitewide core module like a skin file or jQuery component
-	const ORIGIN_CORE_SITEWIDE = 1;
-
-	# per-user module generated by the software
-	const ORIGIN_CORE_INDIVIDUAL = 2;
-
-	# sitewide module generated from user-editable files, like MediaWiki:Common.js, or
-	# modules accessible to multiple users, such as those generated by the Gadgets extension.
-	const ORIGIN_USER_SITEWIDE = 3;
-
-	# per-user module generated from user-editable files, like User:Me/vector.js
-	const ORIGIN_USER_INDIVIDUAL = 4;
-
-	# an access constant; make sure this is kept as the largest number in this group
-	const ORIGIN_ALL = 10;
+	/** @var Config */
+	protected $config;
+	/** @var LoggerInterface */
+	protected $logger;
 
-	# script and style modules form a hierarchy of trustworthiness, with core modules like
-	# skins and jQuery as most trustworthy, and user scripts as least trustworthy.  We can
-	# limit the types of scripts and styles we allow to load on, say, sensitive special
-	# pages like Special:UserLogin and Special:Preferences
+	/**
+	 * Script and style modules form a hierarchy of trustworthiness, with core modules
+	 * like skins and jQuery as most trustworthy, and user scripts as least trustworthy. We can
+	 * limit the types of scripts and styles we allow to load on, say, sensitive special
+	 * pages like Special:UserLogin and Special:Preferences
+	 * @var int
+	 */
 	protected $origin = self::ORIGIN_CORE_SITEWIDE;
 
+	/** @var string|null Module name */
 	protected $name = null;
+	/** @var string[] What client platforms the module targets (e.g. desktop, mobile) */
 	protected $targets = [ 'desktop' ];
 
-	// In-object cache for file dependencies
+	/** @var array Map of (variant => indirect file dependencies) */
 	protected $fileDeps = [];
-	// In-object cache for message blob (keyed by language)
+	/** @var array Map of (language => in-object cache for message blob) */
 	protected $msgBlobs = [];
-	// In-object cache for version hash
+	/** @var array Map of (context hash => cached module version hash) */
 	protected $versionHash = [];
-	// In-object cache for module content
+	/** @var array Map of (context hash => cached module content) */
 	protected $contents = [];
 
-	/**
-	 * @var Config
-	 */
-	protected $config;
-
-	/**
-	 * @var array|bool
-	 */
+	/** @var string|bool Deprecation string or true if deprecated; false otherwise */
 	protected $deprecated = false;
 
+	/** @var string Scripts only */
+	const TYPE_SCRIPTS = 'scripts';
+	/** @var string Styles only */
+	const TYPE_STYLES = 'styles';
+	/** @var string Scripts and styles */
+	const TYPE_COMBINED = 'combined';
+
+	/** @var string Module only has styles (loaded via <style> or <link rel=stylesheet>) */
+	const LOAD_STYLES = 'styles';
+	/** @var string Module may have other resources (loaded via mw.loader from a script) */
+	const LOAD_GENERAL = 'general';
+
+	/** @var int Sitewide core module like a skin file or jQuery component */
+	const ORIGIN_CORE_SITEWIDE = 1;
+	/** @var int Per-user module generated by the software */
+	const ORIGIN_CORE_INDIVIDUAL = 2;
 	/**
-	 * @var LoggerInterface
+	 * Sitewide module generated from user-editable files, like MediaWiki:Common.js,
+	 * or modules accessible to multiple users, such as those generated by the Gadgets extension.
+	 * @var int
 	 */
-	protected $logger;
+	const ORIGIN_USER_SITEWIDE = 3;
+	/** @var int Per-user module generated from user-editable files, like User:Me/vector.js */
+	const ORIGIN_USER_INDIVIDUAL = 4;
+	/** @var int An access constant; make sure this is kept as the largest number in this group */
+	const ORIGIN_ALL = 10;
 
 	/**
 	 * Get this module's name. This is set when the module is registered
@@ -210,7 +209,6 @@ abstract class ResourceLoaderModule implements LoggerAwareInterface {
 	/**
 	 * @since 1.27
 	 * @param LoggerInterface $logger
-	 * @return null
 	 */
 	public function setLogger( LoggerInterface $logger ) {
 		$this->logger = $logger;
@@ -950,12 +948,12 @@ abstract class ResourceLoaderModule implements LoggerAwareInterface {
 				$parser = self::javaScriptParser();
 				$err = null;
 				try {
-					Wikimedia\suppressWarnings();
+					AtEase::suppressWarnings();
 					$parser->parse( $contents, $fileName, 1 );
 				} catch ( Exception $e ) {
 					$err = $e;
 				} finally {
-					Wikimedia\restoreWarnings();
+					AtEase::restoreWarnings();
 				}
 				if ( $err ) {
 					// Send the error to the browser console client-side.
@@ -989,9 +987,9 @@ abstract class ResourceLoaderModule implements LoggerAwareInterface {
 	 * @return int UNIX timestamp
 	 */
 	protected static function safeFilemtime( $filePath ) {
-		Wikimedia\suppressWarnings();
+		AtEase::suppressWarnings();
 		$mtime = filemtime( $filePath ) ?: 1;
-		Wikimedia\restoreWarnings();
+		AtEase::restoreWarnings();
 		return $mtime;
 	}
 
-- 
2.20.1