SemanticFormsSelect::onExtensionFunction() - Code Metrics - Inspection of "Update SemanticFormsSelect.php" - SemanticMediaWiki/SemanticFormsSelect - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 2a4fe5...e752fc )

by mw

created 2017-07-08 07:03 UTC

SemanticFormsSelect::onExtensionFunction() A

↳ Parent: SemanticFormsSelect

Complexity

Conditions	3
Paths	3

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	10
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	5
nc	3
nop	0

<?php

use SFS\HookRegistry;

/**
 * @see https://github.com/SemanticMediaWiki/SemanticFormsSelect/
 *
 * @defgroup SemanticFormsSelect Semantic Forms Select
 * @codeCoverageIgnore
 */
class SemanticFormsSelect {
namespace YourVendor;

class YourClass { }

	/**
	 * @since 1.0
	 */
	public static function initExtension( $credits = array() ) {
// 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);
    }
}

		// See https://phabricator.wikimedia.org/T151136 (extension.json)
		define( 'SFS_VERSION', isset( $credits['version'] ) ? $credits['version'] : '2.2.0-alpha' );

		// Api modules
		$GLOBALS['wgAPIModules']['sformsselect'] = 'SFS\ApiSemanticFormsSelect';

		$GLOBALS['wgScriptSelectCount'] = 0;
		$GLOBALS['wgSF_Select_debug'] = 0;

		// Register resource files
		$GLOBALS['wgResourceModules']['ext.sf_select.scriptselect'] = array(
			'localBasePath' => __DIR__ ,
			'remoteExtPath' => 'SemanticFormsSelect',
			'position' => 'bottom',
			'scripts' => array(
				'res/scriptSelect.js'
			),
			'dependencies' => array(
				'ext.pageforms.main'
			)
		);
	}

	/**
	 * @since 1.0
	 */
	public static function onExtensionFunction() {
// 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 ( !defined( 'PF_VERSION' ) ) {
			die( '<b>Error:</b><a href="https://github.com/SemanticMediaWiki/SemanticFormsSelect/">Semantic Forms Select</a> requires the <a href="https://www.mediawiki.org/wiki/Extension:PageForms">Page Forms</a> extension. Please install and activate this extension first.' );

		}

		if ( isset( $GLOBALS['wgPageFormsFormPrinter'] )) {
			$GLOBALS['wgPageFormsFormPrinter']->setInputTypeHook( 'SF_Select', '\SFS\SemanticFormsSelect::init', array() );
		}
	}

	/**
	 * @since 1.0
	 *
	 * @param string $dependency
	 *
	 * @return string|null
	 */
	public static function getVersion( $dependency = null ) {

		if ( $dependency === null && defined( 'SFS_VERSION' ) ) {
			return SFS_VERSION;
		}

		if ( $dependency === 'PageForms' && defined( 'PF_VERSION' ) ) {
			return PF_VERSION;
		}

		return null;
	}

}


1			<?php
2
3			use SFS\HookRegistry;
4
5			/**
6			* @see https://github.com/SemanticMediaWiki/SemanticFormsSelect/
7			*
8			* @defgroup SemanticFormsSelect Semantic Forms Select
9			* @codeCoverageIgnore
10			*/
11			class SemanticFormsSelect {
			0 ignored issues – show Coding Style Compatibility introduced 2017-04-19 09:23 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
12
13			/**
14			* @since 1.0
15			*/
16			public static function initExtension( $credits = array() ) {
			0 ignored issues – show Coding Style introduced 2017-07-08 07:05 UTC by Report Bug Copy Issue Report `initExtension` 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...
17
18			// See https://phabricator.wikimedia.org/T151136 (extension.json)
19			define( 'SFS_VERSION', isset( $credits['version'] ) ? $credits['version'] : '2.2.0-alpha' );
20
21			// Api modules
22			$GLOBALS['wgAPIModules']['sformsselect'] = 'SFS\ApiSemanticFormsSelect';
23
24			$GLOBALS['wgScriptSelectCount'] = 0;
25			$GLOBALS['wgSF_Select_debug'] = 0;
26
27			// Register resource files
28			$GLOBALS['wgResourceModules']['ext.sf_select.scriptselect'] = array(
29			'localBasePath' => __DIR__ ,
30			'remoteExtPath' => 'SemanticFormsSelect',
31			'position' => 'bottom',
32			'scripts' => array(
33			'res/scriptSelect.js'
34			),
35			'dependencies' => array(
36			'ext.pageforms.main'
37			)
38			);
39			}
40
41			/**
42			* @since 1.0
43			*/
44			public static function onExtensionFunction() {
			0 ignored issues – show Coding Style introduced 2016-11-12 11:20 UTC by Report Bug Copy Issue Report `onExtensionFunction` 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...
45
46			if ( !defined( 'PF_VERSION' ) ) {
47			die( '<b>Error:</b><a href="https://github.com/SemanticMediaWiki/SemanticFormsSelect/">Semantic Forms Select</a> requires the <a href="https://www.mediawiki.org/wiki/Extension:PageForms">Page Forms</a> extension. Please install and activate this extension first.' );
			0 ignored issues – show Coding Style Compatibility introduced 2016-11-12 11:20 UTC by Report Bug Copy Issue Report The method `onExtensionFunction()` contains an exit expression. An exit expression should only be used in rare cases. For example, if you write a short command line script. In most cases however, using an `exit` expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage. Loading history...
48			}
49
50			if ( isset( $GLOBALS['wgPageFormsFormPrinter'] )) {
51			$GLOBALS['wgPageFormsFormPrinter']->setInputTypeHook( 'SF_Select', '\SFS\SemanticFormsSelect::init', array() );
52			}
53			}
54
55			/**
56			* @since 1.0
57			*
58			* @param string $dependency
59			*
60			* @return string\|null
61			*/
62			public static function getVersion( $dependency = null ) {
63
64			if ( $dependency === null && defined( 'SFS_VERSION' ) ) {
65			return SFS_VERSION;
66			}
67
68			if ( $dependency === 'PageForms' && defined( 'PF_VERSION' ) ) {
69			return PF_VERSION;
70			}
71
72			return null;
73			}
74
75			}
76

SemanticMediaWiki / SemanticFormsSelect

Push — master ( 2a4fe5...e752fc )

SemanticFormsSelect::onExtensionFunction() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like