helper_plugin_openlayersmap_staticmap::getMap() - Code Metrics - Inspection of "Merge pull request #1 from mprins/github-actions" - mprins/dokuwiki-plugin-openlayersmap - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 630eee...e4be3b )

by Mark

created 2021-04-23 20:29 UTC

helper_plugin_openlayersmap_staticmap::getMap() A

↳ Parent: helper_plugin_openlayersmap_staticmap

Complexity

Conditions	5
Paths	8

Size

Total Lines	54
Code Lines	21

Duplication

Lines	0
Ratio	0 %

Importance

Changes	3
Bugs	0	Features	0

Metric	Value
eloc	21
c	3
b	0
f	0
dl	0
loc	54
rs	9.2728
cc	5
nc	8
nop	10

How to fix Long Method Many Parameters

<?php
/*
 * Copyright (c) 2008-2021 Mark C. Prins <[email protected]>
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 *
 * @phpcs:disable Squiz.Classes.ValidClassName.NotCamelCaps
 */

/**
 * DokuWiki Plugin openlayersmap (staticmap Helper Component).
 * This provides the interface to generate a static map based on predefined OSM layers.
 *
 * @author Mark Prins
 */
class helper_plugin_openlayersmap_staticmap extends DokuWiki_Plugin {
filter:
    dependency_paths: ["lib/*"]
    /** maximum width of the resulting image. */
    private $maxWidth = 1024;
    /** maximum heigth of the resulting image. */
    private $maxHeight = 1024;

    /**
     * Provide metadata of the public methods of this class.
     *
     * @return array Information to all provided methods.
     */
    public function getMethods(): array {
        $result   = array();
        $result[] = array(
            'name'   => 'getMap',
            'desc'   => 'returns url to the image',
            'params' => array(
                'lat'     => 'float',
                'lon'     => 'float',
                'zoom'    => 'integer',
                'size'    => 'string',
                'maptype' => 'string',
                'markers' => 'string',
                'gpx'     => 'string',
                'kml'     => 'string',
                'geojson' => 'string',
                'apikey'  => 'string'
            ),
            'return' => array('image' => 'string'),
        );
        return $result;
    }

    /**
     * Create the map.
     *
     * @param float  $lat     the latitude of the map's center, eg. 40.714728
     * @param float  $lon     the longitude of the map's center, eg -73.998672
     * @param int    $zoom    the zoom level in the tile cache, eg. 14
     * @param string $size    the size in WxH px, eg. 512x512
     * @param string $maptype the maptype, eg. cycle
     * @param array  $markers associative array of markers, array('lat'=>$lat,'lon'=>$lon,'type'=>$iconStyle),
     *                        eg. array('lat'=>40.702147,'lon'=>-74.015794,'type'=>lightblue1);
     * @param string $gpx     media link
     * @param string $kml     media link
     * @param string $geojson media link
     * @param string $apikey  optional API key eg. for Thunderforest maps
     *
     * @return string
     */
    public function getMap(
        float $lat,
        float $lon,
        int $zoom,
        string $size,
        string $maptype,
        array $markers,
        string $gpx,
        string $kml,
        string $geojson,
        string $apikey = ''
    ): string {
        global $conf;
        // dbglog($markers,'helper_plugin_openlayersmap_staticmap::getMap: markers :');

        // normalize zoom
        $zoom = $zoom ?: 0;
        if($zoom > 18) {
            $zoom = 18;
        }
        // normalize WxH
        list($width, $height) = explode('x', $size);
        $width = (int) $width;
        if($width > $this->maxWidth) {
            $width = $this->maxWidth;
        }
        $height = (int) $height;
        if($height > $this->maxHeight) {
            $height = $this->maxHeight;
        }

        // cleanup/validate gpx/kml
        $kml = $this->mediaIdToPath($kml);
        // dbglog($kml,'helper_plugin_openlayersmap_staticmap::getMap: kml file:');
        $gpx = $this->mediaIdToPath($gpx);
        // dbglog($gpx,'helper_plugin_openlayersmap_staticmap::getMap: gpx file:');
        $geojson = $this->mediaIdToPath($geojson);

        // create map
        require_once DOKU_PLUGIN.'openlayersmap/StaticMap.php';

        $map = new StaticMap(
            $lat, $lon, $zoom, $width, $height, $maptype,
            $markers, $gpx, $kml, $geojson, $conf['mediadir'], $conf['cachedir'],
            $this->getConf('autoZoomMap'),
            $apikey
        );

        // return the media id url
        // $mediaId = str_replace('/', ':', $map->getMap());
        // if($this->startsWith($mediaId,':')) {
        //     $mediaId = substr($mediaId, 1);
        // }
        // return $mediaId;
        return str_replace('/', ':', $map->getMap());
    }

    /**
     * Constructs the path to a file.
     * @param string $id the DW media id
     * @return string the path to the file
     */
    private function mediaIdToPath(string $id): string {
        global $conf;
        if(empty($id)) {
            return "";
        }
        $id = str_replace(array("[[", "]]"), "", $id);
        if((strpos($id, ':') === 0)) {
            $id = substr($id, 1);
        }
        $id = str_replace(":", "/", $id);
        return $conf['mediadir'] . '/' . $id;
    }
}


1			<?php
2			/*
3			* Copyright (c) 2008-2021 Mark C. Prins <[email protected]>
4			*
5			* Permission to use, copy, modify, and distribute this software for any
6			* purpose with or without fee is hereby granted, provided that the above
7			* copyright notice and this permission notice appear in all copies.
8			*
9			* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10			* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11			* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12			* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13			* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14			* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15			* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16			*
17			* @phpcs:disable Squiz.Classes.ValidClassName.NotCamelCaps
18			*/
19
20			/**
21			* DokuWiki Plugin openlayersmap (staticmap Helper Component).
22			* This provides the interface to generate a static map based on predefined OSM layers.
23			*
24			* @author Mark Prins
25			*/
26			class helper_plugin_openlayersmap_staticmap extends DokuWiki_Plugin {
			0 ignored issues – show Bug introduced 2021-04-21 11:10 UTC by Report Bug Copy Issue Report The type `DokuWiki_Plugin` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
27			/** maximum width of the resulting image. */
28			private $maxWidth = 1024;
29			/** maximum heigth of the resulting image. */
30			private $maxHeight = 1024;
31
32			/**
33			* Provide metadata of the public methods of this class.
34			*
35			* @return array Information to all provided methods.
36			*/
37			public function getMethods(): array {
38			$result = array();
39			$result[] = array(
40			'name' => 'getMap',
41			'desc' => 'returns url to the image',
42			'params' => array(
43			'lat' => 'float',
44			'lon' => 'float',
45			'zoom' => 'integer',
46			'size' => 'string',
47			'maptype' => 'string',
48			'markers' => 'string',
49			'gpx' => 'string',
50			'kml' => 'string',
51			'geojson' => 'string',
52			'apikey' => 'string'
53			),
54			'return' => array('image' => 'string'),
55			);
56			return $result;
57			}
58
59			/**
60			* Create the map.
61			*
62			* @param float $lat the latitude of the map's center, eg. 40.714728
63			* @param float $lon the longitude of the map's center, eg -73.998672
64			* @param int $zoom the zoom level in the tile cache, eg. 14
65			* @param string $size the size in WxH px, eg. 512x512
66			* @param string $maptype the maptype, eg. cycle
67			* @param array $markers associative array of markers, array('lat'=>$lat,'lon'=>$lon,'type'=>$iconStyle),
68			* eg. array('lat'=>40.702147,'lon'=>-74.015794,'type'=>lightblue1);
69			* @param string $gpx media link
70			* @param string $kml media link
71			* @param string $geojson media link
72			* @param string $apikey optional API key eg. for Thunderforest maps
73			*
74			* @return string
75			*/
76			public function getMap(
77			float $lat,
78			float $lon,
79			int $zoom,
80			string $size,
81			string $maptype,
82			array $markers,
83			string $gpx,
84			string $kml,
85			string $geojson,
86			string $apikey = ''
87			): string {
88			global $conf;
89			// dbglog($markers,'helper_plugin_openlayersmap_staticmap::getMap: markers :');
90
91			// normalize zoom
92			$zoom = $zoom ?: 0;
93			if($zoom > 18) {
94			$zoom = 18;
95			}
96			// normalize WxH
97			list($width, $height) = explode('x', $size);
98			$width = (int) $width;
99			if($width > $this->maxWidth) {
100			$width = $this->maxWidth;
101			}
102			$height = (int) $height;
103			if($height > $this->maxHeight) {
104			$height = $this->maxHeight;
105			}
106
107			// cleanup/validate gpx/kml
108			$kml = $this->mediaIdToPath($kml);
109			// dbglog($kml,'helper_plugin_openlayersmap_staticmap::getMap: kml file:');
110			$gpx = $this->mediaIdToPath($gpx);
111			// dbglog($gpx,'helper_plugin_openlayersmap_staticmap::getMap: gpx file:');
112			$geojson = $this->mediaIdToPath($geojson);
113
114			// create map
115			require_once DOKU_PLUGIN.'openlayersmap/StaticMap.php';
			0 ignored issues – show Bug introduced 2021-04-23 15:48 UTC by Report Bug Copy Issue Report The constant `DOKU_PLUGIN` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
116			$map = new StaticMap(
117			$lat, $lon, $zoom, $width, $height, $maptype,
118			$markers, $gpx, $kml, $geojson, $conf['mediadir'], $conf['cachedir'],
119			$this->getConf('autoZoomMap'),
120			$apikey
121			);
122
123			// return the media id url
124			// $mediaId = str_replace('/', ':', $map->getMap());
125			// if($this->startsWith($mediaId,':')) {
126			// $mediaId = substr($mediaId, 1);
127			// }
128			// return $mediaId;
129			return str_replace('/', ':', $map->getMap());
130			}
131
132			/**
133			* Constructs the path to a file.
134			* @param string $id the DW media id
135			* @return string the path to the file
136			*/
137			private function mediaIdToPath(string $id): string {
138			global $conf;
139			if(empty($id)) {
140			return "";
141			}
142			$id = str_replace(array("[[", "]]"), "", $id);
143			if((strpos($id, ':') === 0)) {
144			$id = substr($id, 1);
145			}
146			$id = str_replace(":", "/", $id);
147			return $conf['mediadir'] . '/' . $id;
148			}
149			}
150

mprins / dokuwiki-plugin-openlayersmap

Push — master ( 630eee...e4be3b )

helper_plugin_openlayersmap_staticmap::getMap() A

Complexity

Size

Duplication

Importance

How to fix Long Method Many Parameters

Long Method

Many Parameters

Duplication Side-by-Side

Filter issues like