View GitHub Repository re-pro

Schedule Inspection
Subscribe

StreetAdvisorAPI::get_location_reviews()   A
last analyzed

↳ Parent: StreetAdvisorAPI

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 3

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
eloc 3
nc 1
nop 4
dl 0
loc 4
rs 10
c 0
b 0
f 0
1 
<?php
0 ignored issues
– show
Coding Style Compatibility introduced by
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 25 and the first side effect is on line 19.

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 StreetAdvisor API
4 
 *
5 
 * @package WP-StreetAdvisor-API
6 
 */
7 
/*
8 
* Plugin Name: WP Street Advisor API
9 
* Plugin URI: https://github.com/wp-api-libraries/wp-streetadvisor-api
10 
* Description: Perform API requests to streetadvisor.com in WordPress.
11 
* Author: WP API Libraries
12 
* Author URI: https://wp-api-libraries.com
13 
* Version: 1.0.0
14 
* Author URI: https://www.imforza.com
15 
* GitHub Plugin URI: https://github.com/wp-api-libraries/wp-streetadvisor-api
16 
* GitHub Branch: master
17 
*/
18 
/* Exit if accessed directly */
19 
if ( ! defined( 'ABSPATH' ) ) { exit; }
20 
/* Check if Class Exists. */
21 
if ( ! class_exists( 'StreetAdvisorAPI' ) ) {
22 
	/**
23 
	 * StreetAdvisor API Class.
24 
	 */
25 
	class StreetAdvisorAPI {
0 ignored issues
– show
Coding Style Compatibility introduced by
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...
26 
		/**
27 
		 * API Key.
28 
		 *
29 
		 * @var string
30 
		 */
31 
		static private $api_key;
32 
		/**
33 
		 * URL to the API.
34 
		 *
35 
		 * @var string
36 
		 */
37 
		private $base_uri = 'https://web-api-legacy.streetadvisor.com';
38 
		/**
39 
		 * __construct function.
40 
		 *
41 
		 * @access public
42 
		 * @param mixed $api_key API Key.
43 
		 * @return void
0 ignored issues
– show
Comprehensibility Best Practice introduced by
Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

Adding a @return annotation to a constructor is not recommended, since a constructor does not have a meaningful return value.

Please refer to the PHP core documentation on constructors.

Loading history...
44 
		 */
45 
		public function __construct( $api_key ) {
46 
			static::$api_key = $api_key;
0 ignored issues
– show
Bug introduced by
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...
47 
			$this->args['headers'] = array(
0 ignored issues
– show
Bug introduced by
The property args does not exist. Did you maybe forget to declare it?

In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:

class MyClass { }

$x = new MyClass();
$x->foo = true;

Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion:

class MyClass {
    public $foo;
}

$x = new MyClass();
$x->foo = true;
Loading history...
48 
				'Content-Type' => 'application/json',
49 
				'Authorization' => $api_key,
50 
			);
51 
		}
52 
		/**
53 
		 * Fetch the request from the API.
54 
		 *
55 
		 * @access private
56 
		 * @param mixed $request Request URL.
57 
		 * @return $body Body.
0 ignored issues
– show
Documentation introduced by
The doc-type $body could not be parsed: Unknown type name "$body" 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...
58 
		 */
59 View Code Duplication 
		private function fetch( $request ) {
0 ignored issues
– show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
60 
			$response = wp_remote_get( $request, $this->args );
61 
			$code = wp_remote_retrieve_response_code( $response );
62 
			if ( 200 !== $code ) {
63 
				return new WP_Error( 'response-error', sprintf( __( 'Server response code: %d', 'text-domain' ), $code ) );
64 
			}
65 
			$body = wp_remote_retrieve_body( $response );
66 
			return json_decode( $body, true );
67 
		}
68 
		/**
69 
		 * Get Location Data.
70 
		 *
71 
		 * @access public
72 
		 * @param mixed $latitude Latitude.
73 
		 * @param mixed $longitude Longitude.
74 
		 * @param mixed $level Level.
75 
		 * @return void
76 
		 */
77 
		public function get_location_data( $latitude, $longitude, $level ) {
78 
			$request = $this->base_uri . '/locations/overview/'.$latitude.'/'.$longitude.'/'.$level;
79 
			return $this->fetch( $request );
80 
		}
81 
		/**
82 
		 * Get Location Reviews.
83 
		 *
84 
		 * @access public
85 
		 * @param mixed $latitude Latitude.
86 
		 * @param mixed $longitude Longitude.
87 
		 * @param mixed $level Level.
88 
		 * @param int $review_count (default: 5) Total # of Reviews to display.
89 
		 * @return void
90 
		 */
91 
		public function get_location_reviews( $latitude, $longitude, $level, $review_count = '5' ) {
92 
			$request = $this->base_uri . '/reviews/'.$latitude.'/'.$longitude.'/'.$level . '?take='. $review_count;
93 
			return $this->fetch( $request );
94 
		}
95 
	}
96 
}
97