WPAPI_GOOGLE_MAPS::__construct() - Code Metrics - imFORZA/re-pro - Measure and Improve Code Quality continuously with Scrutinizer

WPAPI_GOOGLE_MAPS::__construct() A
last analyzed 2017-11-20 19:23 UTC

↳ Parent: WPAPI_GOOGLE_MAPS

Complexity

Conditions	1
Paths	1

Size

Total Lines	8
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

/**
 * WP Google Maps API
 *
 * @package WP-Google-Maps-API
 */

/*
 * Plugin Name: WP Google Maps API
 * Plugin URI: https://github.com/wp-api-libraries/wp-google-maps-api
 * Description: Perform API requests to Google Maps API.
 * Author: WP API Libraries, sgarza
 * Version: 1.0.0
 * Author URI: https://wp-api-libraries.com
 * GitHub Plugin URI: https://github.com/wp-api-libraries/wp-google-maps-api
 * GitHub Branch: master
 */

// Exit if accessed directly.
if ( ! defined( 'ABSPATH' ) ) { exit; }
if ( ! class_exists( 'WPAPI_GOOGLE_MAPS' ) ) {
	require_once( 'maps-widget.php' );

	/**
	 * Google Maps Class.
	 */
	class WPAPI_GOOGLE_MAPS {
namespace YourVendor;

class YourClass { }

		/**
		 * API Key.
		 *
		 * @var string
		 */
		static private $api_key;

		/**
		 * Output Type.
		 *
		 * @var string
		 */
		static private $output;


		/**
		 * Map data to be sent to JS.
		 *
		 * @var [Array]
		 */
		static private $map_data;

		/**
		 * Default map options.
		 *
		 * @var [Array]
		 */
		static public $defaults = array(
			'width'	 => '300px',
			'height' => '300px',
			'lat'		 => '-17.7134',
			'lng'		 => '178.0650',
			'info'	 => '',
			'style'	 => '[]',
			'zoom'	 => 14,
			'scrollwheel' => 0,
		);

		/**
		 * __construct function.
		 *
		 * @access public
		 * @param String $api_key : API Key.
		 */
		public function __construct( $api_key ) {
			static::$api_key = $api_key;
class YourClass
{
    private static $someVariable;

    public static function getSomeVariable()
    {
        return static::$someVariable;
    }
}

			add_action( 'wp_footer', array( $this, 'footer' ),  11 );
			add_action( 'widgets_init', array( $this, 'register_widgets' ) );
			add_action( 'wp_enqueue_scripts', array( $this, 'enqueue' ) );
			add_shortcode( 'wp_google_maps', array( $this, 'shortcode' ) );
		}

		/**
		 * Enqueue JS.
		 */
		public function enqueue() {
			wp_enqueue_script( 'wpapi-google-maps', plugins_url( 'assets/js/google-maps.min.js', REPRO_PLUGIN_FILE ), array( 'jquery' ), null, true );
		}

		/**
		 * Handle multiple google maps js api enqueues on the footer.
		 */
		public function footer() {
			wp_localize_script( 'wpapi-google-maps', 'wpapi_gmaps', static::$map_data );
class YourClass
{
    private static $someVariable;

    public static function getSomeVariable()
    {
        return static::$someVariable;
    }
}

			// Only enqueue google maps API if yoast hasnt enqueued it already.
			if ( ! wp_script_is( 'maps-geocoder' ) ) {
				wp_enqueue_script( 'google-maps-api', 'https://maps.googleapis.com/maps/api/js?key=' . static::$api_key, array(), null );
class YourClass
{
    private static $someVariable;

    public static function getSomeVariable()
    {
        return static::$someVariable;
    }
}
			}
		}

		/**
		 * Print dat map.
		 *
		 * @param  [Mixed] $map_data : Array of map data to send to js.

		 * @param  [Bool]  $echo     : If html should be returned or echoed, defaults to true.

		 */
		public static function print_map( $map_data, $echo = true ) {

			$map_data = apply_filters( 'wpapi_google_map_data', wp_parse_args( $map_data, static::$defaults ) );
			static::$map_data[] = $map_data;
class YourClass
{
    private static $someVariable;

    public static function getSomeVariable()
    {
        return static::$someVariable;
    }
}

			$index = count( static::$map_data ) - 1;
class YourClass
{
    private static $someVariable;

    public static function getSomeVariable()
    {
        return static::$someVariable;
    }
}

			$html = '<div id="wpapi-gmap-' . $index . '" style="width:' . esc_attr( $map_data['width'] ) . ';height:' . esc_attr( $map_data['height'] ) . '"></div>';

			if ( $echo ) {
				echo $html;
			} else {
				return $html;
			}
		}

		/**
		 * Shortcode for printing a single map.
		 *
		 * @param  [type] $atts : shortcode attributes.

		 */
		public function shortcode( $atts ) {
			// Set widget info.
			$atts = shortcode_atts( static::$defaults, $atts, 'wp_google_maps' );

			return static::print_map( $atts, false );

		}

		/**
		 * Register Google maps Widgets.
		 *
		 * @access public
		 * @return void
		 */
		public function register_widgets() {
			register_widget( 'WP_API_MAPS_WIDGET' );
		}
	}

}


1			<?php
			0 ignored issues – show Coding Style Compatibility introduced 2017-02-17 02:11 UTC by Report Bug Copy Issue Report For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 27 and the first side effect is on line 22. The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file. The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place. To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1. Loading history...
2			/**
3			* WP Google Maps API
4			*
5			* @package WP-Google-Maps-API
6			*/
7
8			/*
9			* Plugin Name: WP Google Maps API
10			* Plugin URI: https://github.com/wp-api-libraries/wp-google-maps-api
11			* Description: Perform API requests to Google Maps API.
12			* Author: WP API Libraries, sgarza
13			* Version: 1.0.0
14			* Author URI: https://wp-api-libraries.com
15			* GitHub Plugin URI: https://github.com/wp-api-libraries/wp-google-maps-api
16			* GitHub Branch: master
17			*/
18
19			// Exit if accessed directly.
20			if ( ! defined( 'ABSPATH' ) ) { exit; }
21			if ( ! class_exists( 'WPAPI_GOOGLE_MAPS' ) ) {
22			require_once( 'maps-widget.php' );
23
24			/**
25			* Google Maps Class.
26			*/
27			class WPAPI_GOOGLE_MAPS {
			0 ignored issues – show Coding Style Compatibility introduced 2017-02-17 02:11 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
28
29			/**
30			* API Key.
31			*
32			* @var string
33			*/
34			static private $api_key;
35
36			/**
37			* Output Type.
38			*
39			* @var string
40			*/
41			static private $output;
			0 ignored issues – show Unused Code introduced 2017-02-17 02:11 UTC by Report Bug Copy Issue Report The property `$output` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
42
43			/**
44			* Map data to be sent to JS.
45			*
46			* @var [Array]
47			*/
48			static private $map_data;
49
50			/**
51			* Default map options.
52			*
53			* @var [Array]
54			*/
55			static public $defaults = array(
56			'width' => '300px',
57			'height' => '300px',
58			'lat' => '-17.7134',
59			'lng' => '178.0650',
60			'info' => '',
61			'style' => '[]',
62			'zoom' => 14,
63			'scrollwheel' => 0,
64			);
65
66			/**
67			* __construct function.
68			*
69			* @access public
70			* @param String $api_key : API Key.
71			*/
72			public function __construct( $api_key ) {
73			static::$api_key = $api_key;
			0 ignored issues – show Bug introduced 2017-02-17 02:11 UTC by Report Bug Copy Issue Report Since `$api_key` is declared private, accessing it with `static` will lead to errors in possible sub-classes; consider using `self`, or increasing the visibility of `$api_key` to at least protected. Let’s assume you have a class which uses late-static binding: class YourClass { private static $someVariable; public static function getSomeVariable() { return static::$someVariable; } } The code above will run fine in your PHP runtime. However, if you now create a sub-class and call the `getSomeVariable()` on that sub-class, you will receive a runtime error: class YourSubClass extends YourClass { } YourSubClass::getSomeVariable(); // Will cause an access error. In the case above, it makes sense to update `SomeClass` to use `self` instead: class SomeClass { private static $someVariable; public static function getSomeVariable() { return self::$someVariable; // self works fine with private. } } Loading history...
74
75			add_action( 'wp_footer', array( $this, 'footer' ), 11 );
76			add_action( 'widgets_init', array( $this, 'register_widgets' ) );
77			add_action( 'wp_enqueue_scripts', array( $this, 'enqueue' ) );
78			add_shortcode( 'wp_google_maps', array( $this, 'shortcode' ) );
79			}
80
81			/**
82			* Enqueue JS.
83			*/
84			public function enqueue() {
85			wp_enqueue_script( 'wpapi-google-maps', plugins_url( 'assets/js/google-maps.min.js', REPRO_PLUGIN_FILE ), array( 'jquery' ), null, true );
86			}
87
88			/**
89			* Handle multiple google maps js api enqueues on the footer.
90			*/
91			public function footer() {
92			wp_localize_script( 'wpapi-google-maps', 'wpapi_gmaps', static::$map_data );
			0 ignored issues – show Bug introduced 2017-02-17 02:11 UTC by Report Bug Copy Issue Report Since `$map_data` is declared private, accessing it with `static` will lead to errors in possible sub-classes; consider using `self`, or increasing the visibility of `$map_data` to at least protected. Let’s assume you have a class which uses late-static binding: class YourClass { private static $someVariable; public static function getSomeVariable() { return static::$someVariable; } } The code above will run fine in your PHP runtime. However, if you now create a sub-class and call the `getSomeVariable()` on that sub-class, you will receive a runtime error: class YourSubClass extends YourClass { } YourSubClass::getSomeVariable(); // Will cause an access error. In the case above, it makes sense to update `SomeClass` to use `self` instead: class SomeClass { private static $someVariable; public static function getSomeVariable() { return self::$someVariable; // self works fine with private. } } Loading history...
93
94			// Only enqueue google maps API if yoast hasnt enqueued it already.
95			if ( ! wp_script_is( 'maps-geocoder' ) ) {
96			wp_enqueue_script( 'google-maps-api', 'https://maps.googleapis.com/maps/api/js?key=' . static::$api_key, array(), null );
			0 ignored issues – show Bug introduced 2017-02-17 02:11 UTC by Report Bug Copy Issue Report Since `$api_key` is declared private, accessing it with `static` will lead to errors in possible sub-classes; consider using `self`, or increasing the visibility of `$api_key` to at least protected. Let’s assume you have a class which uses late-static binding: class YourClass { private static $someVariable; public static function getSomeVariable() { return static::$someVariable; } } The code above will run fine in your PHP runtime. However, if you now create a sub-class and call the `getSomeVariable()` on that sub-class, you will receive a runtime error: class YourSubClass extends YourClass { } YourSubClass::getSomeVariable(); // Will cause an access error. In the case above, it makes sense to update `SomeClass` to use `self` instead: class SomeClass { private static $someVariable; public static function getSomeVariable() { return self::$someVariable; // self works fine with private. } } Loading history...
97			}
98			}
99
100			/**
101			* Print dat map.
102			*
103			* @param [Mixed] $map_data : Array of map data to send to js.
			0 ignored issues – show Documentation introduced 2017-02-17 02:11 UTC by Report Bug Copy Issue Report The doc-type `[Mixed]` could not be parsed: Unknown type name "" at position 0. [(view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
104			* @param [Bool] $echo : If html should be returned or echoed, defaults to true.
			0 ignored issues – show Documentation introduced 2017-02-17 02:11 UTC by Report Bug Copy Issue Report The doc-type `[Bool]` could not be parsed: Unknown type name "" at position 0. [(view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
105			*/
106			public static function print_map( $map_data, $echo = true ) {
107
108			$map_data = apply_filters( 'wpapi_google_map_data', wp_parse_args( $map_data, static::$defaults ) );
109			static::$map_data[] = $map_data;
			0 ignored issues – show Bug introduced 2017-02-17 02:11 UTC by Report Bug Copy Issue Report Since `$map_data` is declared private, accessing it with `static` will lead to errors in possible sub-classes; consider using `self`, or increasing the visibility of `$map_data` to at least protected. Let’s assume you have a class which uses late-static binding: class YourClass { private static $someVariable; public static function getSomeVariable() { return static::$someVariable; } } The code above will run fine in your PHP runtime. However, if you now create a sub-class and call the `getSomeVariable()` on that sub-class, you will receive a runtime error: class YourSubClass extends YourClass { } YourSubClass::getSomeVariable(); // Will cause an access error. In the case above, it makes sense to update `SomeClass` to use `self` instead: class SomeClass { private static $someVariable; public static function getSomeVariable() { return self::$someVariable; // self works fine with private. } } Loading history...
110
111			$index = count( static::$map_data ) - 1;
			0 ignored issues – show Bug introduced 2017-02-17 02:11 UTC by Report Bug Copy Issue Report Since `$map_data` is declared private, accessing it with `static` will lead to errors in possible sub-classes; consider using `self`, or increasing the visibility of `$map_data` to at least protected. Let’s assume you have a class which uses late-static binding: class YourClass { private static $someVariable; public static function getSomeVariable() { return static::$someVariable; } } The code above will run fine in your PHP runtime. However, if you now create a sub-class and call the `getSomeVariable()` on that sub-class, you will receive a runtime error: class YourSubClass extends YourClass { } YourSubClass::getSomeVariable(); // Will cause an access error. In the case above, it makes sense to update `SomeClass` to use `self` instead: class SomeClass { private static $someVariable; public static function getSomeVariable() { return self::$someVariable; // self works fine with private. } } Loading history...
112
113			$html = '<div id="wpapi-gmap-' . $index . '" style="width:' . esc_attr( $map_data['width'] ) . ';height:' . esc_attr( $map_data['height'] ) . '"></div>';
114
115			if ( $echo ) {
116			echo $html;
117			} else {
118			return $html;
119			}
120			}
121
122			/**
123			* Shortcode for printing a single map.
124			*
125			* @param [type] $atts : shortcode attributes.
			0 ignored issues – show Documentation introduced 2017-02-17 02:11 UTC by Report Bug Copy Issue Report The doc-type `[type]` could not be parsed: Unknown type name "" at position 0. [(view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
126			*/
127			public function shortcode( $atts ) {
128			// Set widget info.
129			$atts = shortcode_atts( static::$defaults, $atts, 'wp_google_maps' );
130
131			return static::print_map( $atts, false );
132
133			}
134
135			/**
136			* Register Google maps Widgets.
137			*
138			* @access public
139			* @return void
140			*/
141			public function register_widgets() {
142			register_widget( 'WP_API_MAPS_WIDGET' );
143			}
144			}
145
146			}
147

imFORZA / re-pro

WPAPI_GOOGLE_MAPS::__construct() A last analyzed 2017-11-20 19:23 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

WPAPI_GOOGLE_MAPS::__construct() A
last analyzed 2017-11-20 19:23 UTC