SimpleBatchUpload::registerResourceModule() - Code Metrics - Inspection of "Refactor SimpleBatchUpload class" - ProfessionalWiki/SimpleBatchUpload - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 507809...5ac601 )

by Stephan

created 2016-06-06 22:05 UTC

SimpleBatchUpload::registerResourceModule() A

↳ Parent: SimpleBatchUpload

Complexity

Conditions	3
Paths	2

Size

Total Lines	14
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	14
rs	9.4285
cc	3
eloc	9
nc	2
nop	3

<?php
/**
 * File containing the SimpleBatchUpload class
 *
 * @copyright (C) 2016, Stephan Gambke
 * @license   GNU General Public License, version 2 (or any later version)
 *
 * This software is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, see <http://www.gnu.org/licenses/>.
 *
 * @file
 * @ingroup SimpleBatchUpload
 */

namespace SimpleBatchUpload;

/**
 * Class ExtensionManager
 *
 * @package SimpleBatchUpload
 */
class SimpleBatchUpload {

	private static $singleton;

	/**
	 * @return SimpleBatchUpload
	 */
	public static function singleton() {
		if ( !isset( self::$singleton ) ) {
			self::$singleton = new self();
		}

		return self::$singleton;
	}

	public static function initCallback() {
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
		$GLOBALS[ 'wgHooks' ][ 'SetupAfterCache' ][ ] = function() {
			self::singleton()->init();
		};
	}

	public function init() {
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}

		$GLOBALS[ 'wgExtensionMessagesFiles' ][ 'SimpleBatchUploadAlias' ] = __DIR__ . '/SimpleBatchUpload.alias.php';
		$GLOBALS[ 'wgSpecialPages' ][ 'BatchUpload' ] = '\SimpleBatchUpload\SpecialBatchUpload';

		$this->registerUploadProvidingModule();
		$this->registerUploadUtilizingModule();
	}

	protected function registerUploadProvidingModule() {


		$moduleDescription = [
			'scripts' => [ '/vendor/blueimp/jquery-file-upload/js/jquery.fileupload.js' ],
			'styles'       => [	'/vendor/blueimp/jquery-file-upload/css/jquery.fileupload.css' ],
			'position'     => 'top',
			'dependencies' => [ 'jquery.ui.widget' ],
		];

		$this->registerResourceModule( 'ext.SimpleBatchUpload.jquery-file-upload', $moduleDescription, true );

	}

	protected function registerUploadUtilizingModule() {


		$moduleDescription = [
			'scripts'       => [ 'res/ext.SimpleBatchUpload.js' ],
			'styles'        => [ 'res/ext.SimpleBatchUpload.css' ],
			'position'      => 'top',
			'dependencies'  => [ 'ext.SimpleBatchUpload.jquery-file-upload', 'mediawiki.Title' ],
		];

		$this->registerResourceModule( 'ext.SimpleBatchUpload', $moduleDescription, false );
	}

	/**
	 * @return array
	 */
	protected function registerResourceModule( $moduleName, $moduleDefinition, $isDependency = false ) {
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}

		if ( file_exists( dirname( __DIR__ ) . '/vendor' ) || !$isDependency ) {
			$localBasePath = dirname( __DIR__ );
			$remoteBasePath = $GLOBALS[ 'wgExtensionAssetsPath' ] . '/SimpleBatchUpload';
		} else {
			$localBasePath = $GLOBALS[ 'IP' ];
			$remoteBasePath = $GLOBALS[ 'wgScriptPath' ];
		}

		$GLOBALS[ 'wgResourceModules' ][ $moduleName ] =
			array_merge( [ 'localBasePath'  => $localBasePath, 'remoteBasePath' => $remoteBasePath ], $moduleDefinition );

	}
}


1		<?php
2		/**
3		* File containing the SimpleBatchUpload class
4		*
5		* @copyright (C) 2016, Stephan Gambke
6		* @license GNU General Public License, version 2 (or any later version)
7		*
8		* This software is free software; you can redistribute it and/or
9		* modify it under the terms of the GNU General Public License
10		* as published by the Free Software Foundation; either version 2
11		* of the License, or (at your option) any later version.
12		* This software is distributed in the hope that it will be useful,
13		* but WITHOUT ANY WARRANTY; without even the implied warranty of
14		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15		* GNU General Public License for more details.
16		* You should have received a copy of the GNU General Public License
17		* along with this program; if not, see <http://www.gnu.org/licenses/>.
18		*
19		* @file
20		* @ingroup SimpleBatchUpload
21		*/
22
23		namespace SimpleBatchUpload;
24
25		/**
26		* Class ExtensionManager
27		*
28		* @package SimpleBatchUpload
29		*/
30		class SimpleBatchUpload {
31
32		private static $singleton;
33
34		/**
35		* @return SimpleBatchUpload
36		*/
37		public static function singleton() {
38		if ( !isset( self::$singleton ) ) {
39		self::$singleton = new self();
40		}
41
42		return self::$singleton;
43		}
44
45		public static function initCallback() {
		0 ignored issues – show Coding Style introduced 2016-06-06 22:08 UTC by Report Bug Copy Issue Report `initCallback` uses the super-global variable `$GLOBALS` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
46		$GLOBALS[ 'wgHooks' ][ 'SetupAfterCache' ][ ] = function() {
47		self::singleton()->init();
48		};
49		}
50
51		public function init() {
		0 ignored issues – show Coding Style introduced 2016-06-06 10:21 UTC by Report Bug Copy Issue Report `init` uses the super-global variable `$GLOBALS` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
52
53		$GLOBALS[ 'wgExtensionMessagesFiles' ][ 'SimpleBatchUploadAlias' ] = __DIR__ . '/SimpleBatchUpload.alias.php';
54		$GLOBALS[ 'wgSpecialPages' ][ 'BatchUpload' ] = '\SimpleBatchUpload\SpecialBatchUpload';
55
56		$this->registerUploadProvidingModule();
57		$this->registerUploadUtilizingModule();
58		}
59
60	View Code Duplication	protected function registerUploadProvidingModule() {
		0 ignored issues – show Duplication introduced 2016-06-06 22:08 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
61
62		$moduleDescription = [
63		'scripts' => [ '/vendor/blueimp/jquery-file-upload/js/jquery.fileupload.js' ],
64		'styles' => [ '/vendor/blueimp/jquery-file-upload/css/jquery.fileupload.css' ],
65		'position' => 'top',
66		'dependencies' => [ 'jquery.ui.widget' ],
67		];
68
69		$this->registerResourceModule( 'ext.SimpleBatchUpload.jquery-file-upload', $moduleDescription, true );
70
71		}
72
73	View Code Duplication	protected function registerUploadUtilizingModule() {
		0 ignored issues – show Duplication introduced 2016-06-06 22:08 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
74
75		$moduleDescription = [
76		'scripts' => [ 'res/ext.SimpleBatchUpload.js' ],
77		'styles' => [ 'res/ext.SimpleBatchUpload.css' ],
78		'position' => 'top',
79		'dependencies' => [ 'ext.SimpleBatchUpload.jquery-file-upload', 'mediawiki.Title' ],
80		];
81
82		$this->registerResourceModule( 'ext.SimpleBatchUpload', $moduleDescription, false );
83		}
84
85		/**
86		* @return array
87		*/
88		protected function registerResourceModule( $moduleName, $moduleDefinition, $isDependency = false ) {
		0 ignored issues – show Coding Style introduced 2016-06-06 22:08 UTC by Report Bug Copy Issue Report `registerResourceModule` uses the super-global variable `$GLOBALS` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
89
90		if ( file_exists( dirname( __DIR__ ) . '/vendor' ) \|\| !$isDependency ) {
91		$localBasePath = dirname( __DIR__ );
92		$remoteBasePath = $GLOBALS[ 'wgExtensionAssetsPath' ] . '/SimpleBatchUpload';
93		} else {
94		$localBasePath = $GLOBALS[ 'IP' ];
95		$remoteBasePath = $GLOBALS[ 'wgScriptPath' ];
96		}
97
98		$GLOBALS[ 'wgResourceModules' ][ $moduleName ] =
99		array_merge( [ 'localBasePath' => $localBasePath, 'remoteBasePath' => $remoteBasePath ], $moduleDefinition );
100
101		}
102		}
103

ProfessionalWiki / SimpleBatchUpload

Push — master ( 507809...5ac601 )

SimpleBatchUpload::registerResourceModule() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like