MapsHooks::onExtensionFunction() - Code Metrics - Inspection of "[DO NOT MERGE] Add support for extension.json" - JeroenDeDauw/Maps - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#131)

by None

created 2017-06-02 11:58 UTC

MapsHooks::onExtensionFunction() C

↳ Parent: MapsHooks

Complexity

Conditions	10
Paths	27

Size

Total Lines	56
Code Lines	31

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	56
rs	6.7741
c	0
b	0
f	0
cc	10
eloc	31
nc	27
nop	0

How to fix Long Method Complexity

<?php

/**
 * Static class for hooks handled by the Maps extension.
 *
 * @since 0.7
 *
 * @licence GNU GPL v2+
 * @author Jeroen De Dauw < [email protected] >
 */
final class MapsHooks {

 	public static function onExtensionCallback() {
// 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( 'Maps_COORDS_FLOAT' ) ) {
			// Do not initialize more than once.
			return 1;
		}

		// The different coordinate notations.
		define( 'Maps_COORDS_FLOAT' , 'float' );
		define( 'Maps_COORDS_DMS' , 'dms' );
		define( 'Maps_COORDS_DM' , 'dm' );
		define( 'Maps_COORDS_DD' , 'dd' );

		require_once __DIR__ . '/Maps_Settings.php';

		define( 'Maps_VERSION' , '4.2.1' );
		define( 'SM_VERSION', Maps_VERSION );

		// Only initialize the extension when all dependencies are present.
		if ( !defined( 'Validator_VERSION' ) ) {
			throw new Exception( 'You need to have Validator installed in order to use Maps' );
		}

		$GLOBALS['egMapsStyleVersion'] = $GLOBALS['wgStyleVersion'] . '-' . Maps_VERSION;
	}

	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 ( $GLOBALS['egMapsDisableExtension'] ) {
			return true;
		}
		if ( defined( 'Maps_VERSION' ) ) {
			// Do not initialize more than once.
			return true;
		}

		// Only initialize the extension when all dependencies are present.
		if ( !defined( 'Validator_VERSION' ) ) {
			throw new Exception( 'You need to have Validator installed in order to use Maps' );
		}

		define( 'Maps_VERSION' , '4.2.1' );
		define( 'SM_VERSION', Maps_VERSION );

		if ( $GLOBALS['egMapsGMaps3Language'] === '' ) {
			$GLOBALS['egMapsGMaps3Language'] = $GLOBALS['wgLang'];
		}

		MapsMappingServices::registerService( 'googlemaps3', MapsGoogleMaps3::class );

		$googleMaps = MapsMappingServices::getServiceInstance( 'googlemaps3' );
		$googleMaps->addFeature( 'display_map', MapsDisplayMapRenderer::class );

		MapsMappingServices::registerService(
			'openlayers',
			MapsOpenLayers::class,
			[ 'display_map' => MapsDisplayMapRenderer::class ]
		);

		MapsMappingServices::registerService( 'leaflet', MapsLeaflet::class );
		$leafletMaps = MapsMappingServices::getServiceInstance( 'leaflet' );
		$leafletMaps->addFeature( 'display_map', MapsDisplayMapRenderer::class );

		if ( in_array( 'googlemaps3', $GLOBALS['egMapsAvailableServices'] ) ) {
			$GLOBALS['wgSpecialPages']['MapEditor'] = 'SpecialMapEditor';
			$GLOBALS['wgSpecialPageGroups']['MapEditor'] = 'maps';
		}

		$GLOBALS['egMapsStyleVersion'] = $GLOBALS['wgStyleVersion'] . '-' . Maps_VERSION;

		// Users that can geocode. By default the same as those that can edit.
		foreach ( $GLOBALS['wgGroupPermissions'] as $group => $rights ) {
			if ( array_key_exists( 'edit' , $rights ) ) {
				$GLOBALS['wgGroupPermissions'][$group]['geocode'] = $GLOBALS['wgGroupPermissions'][$group]['edit'];
			}
		}

		if ( !$GLOBALS['egMapsDisableSmwIntegration'] && defined( 'SMW_VERSION' ) ) {
			SemanticMaps::newFromMediaWikiGlobals( $GLOBALS )->initExtension();
		}

		return true;
	}

	public static function onParserFirstCallInit1( Parser &$parser ) {
		$instance = new MapsCoordinates();
		return $instance->init( $parser );
	}

	public static function onParserFirstCallInit2( Parser &$parser ) {
		$instance = new MapsDisplayMap();
		return $instance->init( $parser );
	}

	public static function onParserFirstCallInit3( Parser &$parser ) {
		$instance = new MapsDistance();
		return $instance->init( $parser );
	}

	public static function onParserFirstCallInit4( Parser &$parser ) {
		$instance = new MapsFinddestination();
		return $instance->init( $parser );
	}

	public static function onParserFirstCallInit5( Parser &$parser ) {
		$instance = new MapsGeocode();
		return $instance->init( $parser );
	}

	public static function onParserFirstCallInit6( Parser &$parser ) {
		$instance = new MapsGeodistance();
		return $instance->init( $parser );
	}

	public static function onParserFirstCallInit7( Parser &$parser ) {
		$instance = new MapsMapsDoc();
		return $instance->init( $parser );
	}

	/**
	 * Adds a link to Admin Links page.
	 *
	 * @since 0.7
	 *
	 * @param ALTree $admin_links_tree
	 *
	 * @return boolean
	 */
	public static function addToAdminLinks( ALTree &$admin_links_tree ) {
		$displaying_data_section = $admin_links_tree->getSection( wfMessage( 'smw_adminlinks_displayingdata' )->text() );

		// Escape if SMW hasn't added links.
		if ( is_null( $displaying_data_section ) ) {
			return true;
		}

		$smw_docu_row = $displaying_data_section->getRow( 'smw' );

		$maps_docu_label = wfMessage( 'adminlinks_documentation', 'Maps' )->text();
		$smw_docu_row->addItem( AlItem::newFromExternalLink( 'https://semantic-mediawiki.org/wiki/Maps', $maps_docu_label ) );

		return true;
	}

	/**
	 * Adds global JavaScript variables.
	 *
	 * @since 1.0
	 * @see http://www.mediawiki.org/wiki/Manual:Hooks/MakeGlobalVariablesScript
	 * @param array &$vars Variables to be added into the output
	 * @param OutputPage $outputPage OutputPage instance calling the hook
	 * @return boolean true in all cases
	 */
	public static function onMakeGlobalVariablesScript( array &$vars, OutputPage $outputPage ) {
// 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);
    }
}
		global $egMapsGlobalJSVars;

		$vars['egMapsDebugJS'] = $GLOBALS['egMapsDebugJS'];
                $vars[ 'egMapsAvailableServices' ] = $GLOBALS['egMapsAvailableServices'];

		$vars += $egMapsGlobalJSVars;

		return true;
	}

}



1			<?php
2
3			/**
4			* Static class for hooks handled by the Maps extension.
5			*
6			* @since 0.7
7			*
8			* @licence GNU GPL v2+
9			* @author Jeroen De Dauw < [email protected] >
10			*/
11			final class MapsHooks {
12
13			public static function onExtensionCallback() {
			0 ignored issues – show Coding Style introduced 2016-04-06 21:20 UTC by Report Bug Copy Issue Report `onExtensionCallback` 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...
14			if ( defined( 'Maps_COORDS_FLOAT' ) ) {
15			// Do not initialize more than once.
16			return 1;
17			}
18
19			// The different coordinate notations.
20			define( 'Maps_COORDS_FLOAT' , 'float' );
21			define( 'Maps_COORDS_DMS' , 'dms' );
22			define( 'Maps_COORDS_DM' , 'dm' );
23			define( 'Maps_COORDS_DD' , 'dd' );
24
25			require_once __DIR__ . '/Maps_Settings.php';
26
27			define( 'Maps_VERSION' , '4.2.1' );
28			define( 'SM_VERSION', Maps_VERSION );
29
30			// Only initialize the extension when all dependencies are present.
31			if ( !defined( 'Validator_VERSION' ) ) {
32			throw new Exception( 'You need to have Validator installed in order to use Maps' );
33			}
34
35			$GLOBALS['egMapsStyleVersion'] = $GLOBALS['wgStyleVersion'] . '-' . Maps_VERSION;
36			}
37
38			public static function onExtensionFunction() {
			0 ignored issues – show Coding Style introduced 2016-04-06 19:55 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...
39			if ( $GLOBALS['egMapsDisableExtension'] ) {
40			return true;
41			}
42			if ( defined( 'Maps_VERSION' ) ) {
43			// Do not initialize more than once.
44			return true;
45			}
46
47			// Only initialize the extension when all dependencies are present.
48			if ( !defined( 'Validator_VERSION' ) ) {
49			throw new Exception( 'You need to have Validator installed in order to use Maps' );
50			}
51
52			define( 'Maps_VERSION' , '4.2.1' );
53			define( 'SM_VERSION', Maps_VERSION );
54
55			if ( $GLOBALS['egMapsGMaps3Language'] === '' ) {
56			$GLOBALS['egMapsGMaps3Language'] = $GLOBALS['wgLang'];
57			}
58
59			MapsMappingServices::registerService( 'googlemaps3', MapsGoogleMaps3::class );
60
61			$googleMaps = MapsMappingServices::getServiceInstance( 'googlemaps3' );
62			$googleMaps->addFeature( 'display_map', MapsDisplayMapRenderer::class );
63
64			MapsMappingServices::registerService(
65			'openlayers',
66			MapsOpenLayers::class,
67			[ 'display_map' => MapsDisplayMapRenderer::class ]
68			);
69
70			MapsMappingServices::registerService( 'leaflet', MapsLeaflet::class );
71			$leafletMaps = MapsMappingServices::getServiceInstance( 'leaflet' );
72			$leafletMaps->addFeature( 'display_map', MapsDisplayMapRenderer::class );
73
74			if ( in_array( 'googlemaps3', $GLOBALS['egMapsAvailableServices'] ) ) {
75			$GLOBALS['wgSpecialPages']['MapEditor'] = 'SpecialMapEditor';
76			$GLOBALS['wgSpecialPageGroups']['MapEditor'] = 'maps';
77			}
78
79			$GLOBALS['egMapsStyleVersion'] = $GLOBALS['wgStyleVersion'] . '-' . Maps_VERSION;
80
81			// Users that can geocode. By default the same as those that can edit.
82			foreach ( $GLOBALS['wgGroupPermissions'] as $group => $rights ) {
83			if ( array_key_exists( 'edit' , $rights ) ) {
84			$GLOBALS['wgGroupPermissions'][$group]['geocode'] = $GLOBALS['wgGroupPermissions'][$group]['edit'];
85			}
86			}
87
88			if ( !$GLOBALS['egMapsDisableSmwIntegration'] && defined( 'SMW_VERSION' ) ) {
89			SemanticMaps::newFromMediaWikiGlobals( $GLOBALS )->initExtension();
90			}
91
92			return true;
93			}
94
95			public static function onParserFirstCallInit1( Parser &$parser ) {
96			$instance = new MapsCoordinates();
97			return $instance->init( $parser );
98			}
99
100			public static function onParserFirstCallInit2( Parser &$parser ) {
101			$instance = new MapsDisplayMap();
102			return $instance->init( $parser );
103			}
104
105			public static function onParserFirstCallInit3( Parser &$parser ) {
106			$instance = new MapsDistance();
107			return $instance->init( $parser );
108			}
109
110			public static function onParserFirstCallInit4( Parser &$parser ) {
111			$instance = new MapsFinddestination();
112			return $instance->init( $parser );
113			}
114
115			public static function onParserFirstCallInit5( Parser &$parser ) {
116			$instance = new MapsGeocode();
117			return $instance->init( $parser );
118			}
119
120			public static function onParserFirstCallInit6( Parser &$parser ) {
121			$instance = new MapsGeodistance();
122			return $instance->init( $parser );
123			}
124
125			public static function onParserFirstCallInit7( Parser &$parser ) {
126			$instance = new MapsMapsDoc();
127			return $instance->init( $parser );
128			}
129
130			/**
131			* Adds a link to Admin Links page.
132			*
133			* @since 0.7
134			*
135			* @param ALTree $admin_links_tree
136			*
137			* @return boolean
138			*/
139			public static function addToAdminLinks( ALTree &$admin_links_tree ) {
140			$displaying_data_section = $admin_links_tree->getSection( wfMessage( 'smw_adminlinks_displayingdata' )->text() );
141
142			// Escape if SMW hasn't added links.
143			if ( is_null( $displaying_data_section ) ) {
144			return true;
145			}
146
147			$smw_docu_row = $displaying_data_section->getRow( 'smw' );
148
149			$maps_docu_label = wfMessage( 'adminlinks_documentation', 'Maps' )->text();
150			$smw_docu_row->addItem( AlItem::newFromExternalLink( 'https://semantic-mediawiki.org/wiki/Maps', $maps_docu_label ) );
151
152			return true;
153			}
154
155			/**
156			* Adds global JavaScript variables.
157			*
158			* @since 1.0
159			* @see http://www.mediawiki.org/wiki/Manual:Hooks/MakeGlobalVariablesScript
160			* @param array &$vars Variables to be added into the output
161			* @param OutputPage $outputPage OutputPage instance calling the hook
162			* @return boolean true in all cases
163			*/
164			public static function onMakeGlobalVariablesScript( array &$vars, OutputPage $outputPage ) {
			0 ignored issues – show Unused Code introduced 2015-12-04 20:45 UTC by Report Bug Copy Issue Report The parameter `$outputPage` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Coding Style introduced 2015-12-04 20:45 UTC by Report Bug Copy Issue Report `onMakeGlobalVariablesScript` 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...
165			global $egMapsGlobalJSVars;
166
167			$vars['egMapsDebugJS'] = $GLOBALS['egMapsDebugJS'];
168			$vars[ 'egMapsAvailableServices' ] = $GLOBALS['egMapsAvailableServices'];
169
170			$vars += $egMapsGlobalJSVars;
171
172			return true;
173			}
174
175			}
176
177

JeroenDeDauw / Maps

Pull Request — master (#131)

MapsHooks::onExtensionFunction() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like