MapsLeaflet::addLayerDependencies() - Code Metrics - Inspection of "Add Leaflet layers" - JeroenDeDauw/Maps - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#215)

by Peter

created 2016-08-25 15:22 UTC

MapsLeaflet::addLayerDependencies() A

↳ Parent: MapsLeaflet

Complexity

Conditions	2
Paths	2

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes	1
Bugs	1	Features	0

Metric	Value
cc	2
eloc	3
c	1
b	1
f	0
nc	2
nop	1
dl	0
loc	5
ccs	0
cts	5
cp	0
crap	6
rs	9.4285

<?php

/**
 * Class holding information and functionality specific to Leaflet.
 * This information and features can be used by any mapping feature.
 *
 * @licence GNU GPL v2+
 * @author Pavel Astakhov < [email protected] >
 */
class MapsLeaflet extends MapsMappingService {

	/**
	 * Constructor
	 */
	public function __construct( $serviceName ) {
		parent::__construct(
			$serviceName,
			[ 'leafletmaps', 'leaflet' ]
		);
	}

	/**
	 * @see MapsMappingService::addParameterInfo
	 *
	 * @since 3.0
	 */
	public function addParameterInfo( array &$params ) {
// 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 $GLOBALS;

		$params['zoom'] = [
			'type' => 'integer',
			'range' => [ 0, 20 ],
			'default' => false,
			'message' => 'maps-par-zoom'
		];

		$params['defzoom'] = [
			'type' => 'integer',
			'range' => [ 0, 20 ],
			'default' => self::getDefaultZoom(),
			'message' => 'maps-leaflet-par-defzoom'
		];

		$params['layer'] = [
			'type' => 'string',
			'values' => $GLOBALS['egMapsLeafletAvailableLayers'],
			'default' => $GLOBALS['egMapsLeafletLayer'],
			'message' =>'maps-leaflet-par-layer',
		];

		$params['overlaylayers'] = [
			'type' => 'string',
			'values' => $GLOBALS['egMapsLeafletAvailableOverlayLayers'],
			'default' => $GLOBALS['egMapsLeafletOverlayLayers'],
			'message' =>'maps-leaflet-par-overlaylayers',
			'islist' => true,
		];

		$params['resizable'] = [
			'type' => 'boolean',
			'default' => $GLOBALS['egMapsResizableByDefault'],
			'message' => 'maps-par-resizable'
		];

		$params['enablefullscreen'] = [
			'type' => 'boolean',
			'default' => false,
			'message' => 'maps-par-enable-fullscreen',
		];

		$params['markercluster'] = [
			'type' => 'boolean',
			'default' => false,
			'message' => 'maps-par-markercluster',
		];

		$params['clustermaxzoom'] = [
			'type' => 'integer',
			'default' => 20,
			'message' => 'maps-par-clustermaxzoom',
		];

		$params['clusterzoomonclick'] = [
			'type' => 'boolean',
			'default' => true,
			'message' => 'maps-par-clusterzoomonclick',
		];

		$params['clustermaxradius'] = [
			'type' => 'integer',
			'default' => 80,
			'message' => 'maps-par-maxclusterradius',
		];

		$params['clusterspiderfy'] = [
			'type' => 'boolean',
			'default' => true,
			'message' => 'maps-leaflet-par-clusterspiderfy',
		];
	}

	/**
	 * @see iMappingService::getDefaultZoom
	 *
	 * @since 3.0
	 */
	public function getDefaultZoom() {
// 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);
    }
}
		return $GLOBALS['egMapsLeafletZoom'];
	}

	/**
	 * @see MapsMappingService::getMapId
	 *
	 * @since 3.0
	 */
	public function getMapId( $increment = true ) {
		static $mapsOnThisPage = 0;

		if ( $increment ) {
			$mapsOnThisPage++;
		}

		return 'map_leaflet_' . $mapsOnThisPage;
	}

	/**
	 * @see MapsMappingService::getResourceModules
	 *
	 * @since 3.0
	 *
	 * @return array of string
	 */
	public function getResourceModules() {
		return array_merge(
			parent::getResourceModules(),
			[ 'ext.maps.leaflet' ]
		);
	}

	protected function getDependencies() {
// 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);
    }
}
		$leafletPath = $GLOBALS['wgScriptPath'] . '/extensions/Maps/includes/services/Leaflet/leaflet';
		return [
			Html::linkedStyle( "$leafletPath/leaflet.css" ),
			Html::linkedScript( "$leafletPath/leaflet.js" ),
		];
	}

	/**
	 * Adds the layer dependencies.
	 *
	 * @since 3.8
	 *
	 * @param array $dependencies
	 */
	public function addLayerDependencies( array $dependencies ) {
		foreach ( $dependencies as $dependency ) {
			$this->addDependency( $dependency );
		}
	}

}


1			<?php
2
3			/**
4			* Class holding information and functionality specific to Leaflet.
5			* This information and features can be used by any mapping feature.
6			*
7			* @licence GNU GPL v2+
8			* @author Pavel Astakhov < [email protected] >
9			*/
10			class MapsLeaflet extends MapsMappingService {
11
12			/**
13			* Constructor
14			*/
15			public function __construct( $serviceName ) {
16			parent::__construct(
17			$serviceName,
18			[ 'leafletmaps', 'leaflet' ]
19			);
20			}
21
22			/**
23			* @see MapsMappingService::addParameterInfo
24			*
25			* @since 3.0
26			*/
27			public function addParameterInfo( array &$params ) {
			0 ignored issues – show Coding Style introduced 2015-12-04 20:45 UTC by Report Bug Copy Issue Report `addParameterInfo` 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...
28			global $GLOBALS;
29
30			$params['zoom'] = [
31			'type' => 'integer',
32			'range' => [ 0, 20 ],
33			'default' => false,
34			'message' => 'maps-par-zoom'
35			];
36
37			$params['defzoom'] = [
38			'type' => 'integer',
39			'range' => [ 0, 20 ],
40			'default' => self::getDefaultZoom(),
41			'message' => 'maps-leaflet-par-defzoom'
42			];
43
44			$params['layer'] = [
45			'type' => 'string',
46			'values' => $GLOBALS['egMapsLeafletAvailableLayers'],
47			'default' => $GLOBALS['egMapsLeafletLayer'],
48			'message' =>'maps-leaflet-par-layer',
49			];
50
51			$params['overlaylayers'] = [
52			'type' => 'string',
53			'values' => $GLOBALS['egMapsLeafletAvailableOverlayLayers'],
54			'default' => $GLOBALS['egMapsLeafletOverlayLayers'],
55			'message' =>'maps-leaflet-par-overlaylayers',
56			'islist' => true,
57			];
58
59			$params['resizable'] = [
60			'type' => 'boolean',
61			'default' => $GLOBALS['egMapsResizableByDefault'],
62			'message' => 'maps-par-resizable'
63			];
64
65			$params['enablefullscreen'] = [
66			'type' => 'boolean',
67			'default' => false,
68			'message' => 'maps-par-enable-fullscreen',
69			];
70
71			$params['markercluster'] = [
72			'type' => 'boolean',
73			'default' => false,
74			'message' => 'maps-par-markercluster',
75			];
76
77			$params['clustermaxzoom'] = [
78			'type' => 'integer',
79			'default' => 20,
80			'message' => 'maps-par-clustermaxzoom',
81			];
82
83			$params['clusterzoomonclick'] = [
84			'type' => 'boolean',
85			'default' => true,
86			'message' => 'maps-par-clusterzoomonclick',
87			];
88
89			$params['clustermaxradius'] = [
90			'type' => 'integer',
91			'default' => 80,
92			'message' => 'maps-par-maxclusterradius',
93			];
94
95			$params['clusterspiderfy'] = [
96			'type' => 'boolean',
97			'default' => true,
98			'message' => 'maps-leaflet-par-clusterspiderfy',
99			];
100			}
101
102			/**
103			* @see iMappingService::getDefaultZoom
104			*
105			* @since 3.0
106			*/
107			public function getDefaultZoom() {
			0 ignored issues – show Coding Style introduced 2015-12-04 20:45 UTC by Report Bug Copy Issue Report `getDefaultZoom` 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...
108			return $GLOBALS['egMapsLeafletZoom'];
109			}
110
111			/**
112			* @see MapsMappingService::getMapId
113			*
114			* @since 3.0
115			*/
116			public function getMapId( $increment = true ) {
117			static $mapsOnThisPage = 0;
118
119			if ( $increment ) {
120			$mapsOnThisPage++;
121			}
122
123			return 'map_leaflet_' . $mapsOnThisPage;
124			}
125
126			/**
127			* @see MapsMappingService::getResourceModules
128			*
129			* @since 3.0
130			*
131			* @return array of string
132			*/
133			public function getResourceModules() {
134			return array_merge(
135			parent::getResourceModules(),
136			[ 'ext.maps.leaflet' ]
137			);
138			}
139
140			protected function getDependencies() {
			0 ignored issues – show Coding Style introduced 2015-12-04 20:45 UTC by Report Bug Copy Issue Report `getDependencies` 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...
141			$leafletPath = $GLOBALS['wgScriptPath'] . '/extensions/Maps/includes/services/Leaflet/leaflet';
142			return [
143			Html::linkedStyle( "$leafletPath/leaflet.css" ),
144			Html::linkedScript( "$leafletPath/leaflet.js" ),
145			];
146			}
147
148			/**
149			* Adds the layer dependencies.
150			*
151			* @since 3.8
152			*
153			* @param array $dependencies
154			*/
155			public function addLayerDependencies( array $dependencies ) {
156			foreach ( $dependencies as $dependency ) {
157			$this->addDependency( $dependency );
158			}
159			}
160
161			}
162

JeroenDeDauw / Maps

Pull Request — master (#215)

MapsLeaflet::addLayerDependencies() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like