MapsHooks::onMakeGlobalVariablesScript() - Code Metrics - Inspection of "Restore ability to run tests independently from MW" - JeroenDeDauw/Maps - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — independent-tests ( 271ef5...4802c4 )

by Jeroen De

created 2018-05-17 06:32 UTC

MapsHooks::onMakeGlobalVariablesScript() A

↳ Parent: MapsHooks

Complexity

Conditions	1
Paths	1

Size

Total Lines	10
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	6
nc	1
nop	2
dl	0
loc	10
rs	9.4285
c	0
b	0
f	0

<?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 {

	/**
	 * 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://www.semantic-mediawiki.org/wiki/Extension: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			/**
14			* Adds a link to Admin Links page.
15			*
16			* @since 0.7
17			*
18			* @param ALTree $admin_links_tree
19			*
20			* @return boolean
21			*/
22			public static function addToAdminLinks( ALTree &$admin_links_tree ) {
23			$displaying_data_section = $admin_links_tree->getSection(
24			wfMessage( 'smw_adminlinks_displayingdata' )->text()
25			);
26
27			// Escape if SMW hasn't added links.
28			if ( is_null( $displaying_data_section ) ) {
29			return true;
30			}
31
32			$smw_docu_row = $displaying_data_section->getRow( 'smw' );
33
34			$maps_docu_label = wfMessage( 'adminlinks_documentation', 'Maps' )->text();
35			$smw_docu_row->addItem(
36			AlItem::newFromExternalLink( 'https://www.semantic-mediawiki.org/wiki/Extension:Maps', $maps_docu_label )
37			);
38
39			return true;
40			}
41
42			/**
43			* Adds global JavaScript variables.
44			*
45			* @since 1.0
46			* @see http://www.mediawiki.org/wiki/Manual:Hooks/MakeGlobalVariablesScript
47			*
48			* @param array &$vars Variables to be added into the output
49			* @param OutputPage $outputPage OutputPage instance calling the hook
50			*
51			* @return boolean true in all cases
52			*/
53			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...
54			global $egMapsGlobalJSVars;
55
56			$vars['egMapsDebugJS'] = $GLOBALS['egMapsDebugJS'];
57			$vars['egMapsAvailableServices'] = $GLOBALS['egMapsAvailableServices'];
58
59			$vars += $egMapsGlobalJSVars;
60
61			return true;
62			}
63
64			}
65

JeroenDeDauw / Maps

Push — independent-tests ( 271ef5...4802c4 )

MapsHooks::onMakeGlobalVariablesScript() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like