MapsHooks::onMakeGlobalVariablesScript() - Code Metrics - Inspection of "Move SMW result printers" - JeroenDeDauw/Maps - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — move ( 875a6f )

by Jeroen De

created 2018-11-19 21:02 UTC

MapsHooks::onMakeGlobalVariablesScript() A

↳ Parent: MapsHooks

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	10
ccs	0
cts	8
cp	0
rs	9.9332
c	0
b	0
f	0
cc	1
nc	1
nop	1
crap	2

<?php

namespace Maps\MediaWiki;

use AlItem;
use ALTree;

/**
 * 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
	 *
	 * @return boolean true in all cases
	 */
	public static function onMakeGlobalVariablesScript( array &$vars ) {
// 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);
    }
}
		$vars['egMapsScriptPath'] = $GLOBALS['wgScriptPath'] . '/extensions/Maps/'; // TODO: wgExtensionDirectory?
		$vars['egMapsDebugJS'] = $GLOBALS['egMapsDebugJS'];
		$vars['egMapsAvailableServices'] = $GLOBALS['egMapsAvailableServices'];
		$vars['egMapsLeafletLayersApiKeys'] = $GLOBALS['egMapsLeafletLayersApiKeys'];

		$vars += $GLOBALS['egMapsGlobalJSVars'];

		return true;
	}

}


1			<?php
2
3			namespace Maps\MediaWiki;
4
5			use AlItem;
6			use ALTree;
7
8			/**
9			* Static class for hooks handled by the Maps extension.
10			*
11			* @since 0.7
12			*
13			* @licence GNU GPL v2+
14			* @author Jeroen De Dauw < [email protected] >
15			*/
16			final class MapsHooks {
17
18			/**
19			* Adds a link to Admin Links page.
20			*
21			* @since 0.7
22			*
23			* @param ALTree $admin_links_tree
24			*
25			* @return boolean
26			*/
27			public static function addToAdminLinks( ALTree &$admin_links_tree ) {
28			$displaying_data_section = $admin_links_tree->getSection(
29			wfMessage( 'smw_adminlinks_displayingdata' )->text()
30			);
31
32			// Escape if SMW hasn't added links.
33			if ( is_null( $displaying_data_section ) ) {
34			return true;
35			}
36
37			$smw_docu_row = $displaying_data_section->getRow( 'smw' );
38
39			$maps_docu_label = wfMessage( 'adminlinks_documentation', 'Maps' )->text();
40			$smw_docu_row->addItem(
41			AlItem::newFromExternalLink( 'https://www.semantic-mediawiki.org/wiki/Extension:Maps', $maps_docu_label )
42			);
43
44			return true;
45			}
46
47			/**
48			* Adds global JavaScript variables.
49			*
50			* @since 1.0
51			* @see http://www.mediawiki.org/wiki/Manual:Hooks/MakeGlobalVariablesScript
52			*
53			* @param array &$vars Variables to be added into the output
54			*
55			* @return boolean true in all cases
56			*/
57			public static function onMakeGlobalVariablesScript( array &$vars ) {
			0 ignored issues – show Coding Style introduced 2018-07-07 02:54 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...
58			$vars['egMapsScriptPath'] = $GLOBALS['wgScriptPath'] . '/extensions/Maps/'; // TODO: wgExtensionDirectory?
59			$vars['egMapsDebugJS'] = $GLOBALS['egMapsDebugJS'];
60			$vars['egMapsAvailableServices'] = $GLOBALS['egMapsAvailableServices'];
61			$vars['egMapsLeafletLayersApiKeys'] = $GLOBALS['egMapsLeafletLayersApiKeys'];
62
63			$vars += $GLOBALS['egMapsGlobalJSVars'];
64
65			return true;
66			}
67
68			}
69

JeroenDeDauw / Maps

Push — move ( 875a6f )

MapsHooks::onMakeGlobalVariablesScript() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like