ApiObject::jsonSerialize() - Code Metrics - Inspection of "Support JsonSerializable and drop getJson()" - allejo/PhpPulse - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( fc3a8f...d318be )

by Vladimir

created 2016-11-07 17:11 UTC

ApiObject::jsonSerialize() A

↳ Parent: ApiObject

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	4
rs	10
cc	1
eloc	2
nc	1
nop	0

<?php

/**
 * This file contains the ApiObject class
 *
 * @copyright 2015 Vladimir Jimenez
 * @license   https://github.com/allejo/PhpPulse/blob/master/LICENSE.md MIT
 */

namespace allejo\DaPulse\Objects;

use allejo\DaPulse\Exceptions\InvalidObjectException;
use allejo\DaPulse\Utilities\UrlQuery;

/**
 * The base class for all DaPulse API objects
 *
 * @internal
 * @package allejo\DaPulse\Objects
 * @since   0.1.0
 */
abstract class ApiObject implements \JsonSerializable
{
    /**
     * The namespace used for all main PhpPulse objects. This is value is prepended before PhpPulse objects when being
     * checked with `instanceof`.
     *
     * @internal
     */
    const OBJ_NAMESPACE = "\\allejo\\DaPulse\\";

    /**
     * The default API protocol used for URL calls
     *
     * @internal
     */
    const API_PROTOCOL = "https";

    /**
     * The API end point for URL calls
     *
     * @internal
     */
    const API_ENDPOINT = "api.dapulse.com";

    /**
     * The API version used for URL calls
     *
     * @internal
     */
    const API_VERSION = "v1";

    /**
     * The suffix that is appended to the URL to access functionality for certain objects
     *
     * @internal
     */
    const API_PREFIX = "";

    /**
     * The API key used to make the URL calls
     *
     * @var string
     */
    protected static $apiKey;

    /**
     * When set to true, the object can only be constructed from an associative array of data. It will not attempt
     * to fetch the data with an API call; this is intended for objects are not directly accessible via the API.
     *
     * @var bool
     */
    protected $arrayConstructionOnly = false;

    /**
     * Set to true if the object has been deleted via an API call but the instance still exists. This variable will
     * prevent further API calls to a nonexistent object.
     *
     * @var bool
     */
    protected $deletedObject = false;

    /**
     * An associative array representing the original JSON response from DaPulse
     *
     * @var array
     */
    protected $jsonResponse;

    /**
     * Create an object from an API call
     *
     * @param int|array $idOrArray Either the numerical ID of an object or an associative array representing a JSON
     *                             response from an API call
     *
     * @throw \InvalidArgumentException The specified object cannot be created directly from an API call but instead
     *                                  requires an associative array of information gathered from other API calls.
     *
     * @since 0.1.0
     */
    public function __construct ($idOrArray)
    {
        $urlEndPoint = "";
        $staticClass = explode("\\", get_called_class());
        $staticClass = end($staticClass);

        if (is_null($idOrArray))
        {
            throw new \InvalidArgumentException("You may not initialize " . $staticClass . " with null.");
        }

        if (!is_array($idOrArray))
        {
            $urlEndPoint = sprintf("%s/%d.json", self::apiEndpoint(), $idOrArray);
        }

        if ($this->arrayConstructionOnly && !is_array($idOrArray))
        {
            throw new \InvalidArgumentException("A " . $staticClass . " cannot be fetched from an ID.");
        }

        $this->jsonResponse = (is_array($idOrArray)) ? $idOrArray : $this::sendGet($urlEndPoint);


        $this->initializeValues();
        $this->assignResults();
    }

    /**
     * {@inheritdoc}
     */
    public function jsonSerialize()
    {
        return $this->jsonResponse;
    }

    // ================================================================================================================
    //   Getter functions
    // ================================================================================================================

    /**
     * Access the JSON response from DaPulse directly
     *
     * @api
     * @deprecated 0.3.0 Feed this object to json_encode() to get the JSON representation of this object instead
     * @since  0.1.0
     * @todo   Remove this in the next major release

     * @return array
     */
    final public function getJson ()
    {
        return $this->jsonSerialize();
    }

    // ================================================================================================================
    //   Helper functions
    // ================================================================================================================

    /**
     * Assign an associative array from a JSON response and map them to instance variables
     *
     * @since 0.1.0
     */
    final protected function assignResults ()
    {
        foreach ($this->jsonResponse as $key => $val)
        {
            if (property_exists(get_called_class(), $key))
            {
                $this->$key = $val;
            }
        }
    }

    /**
     * Check if the current object has been marked as deleted from DaPulse. If so, throw an exception.
     *
     * @throws InvalidObjectException
     */
    final protected function checkInvalid ()
    {
        if ($this->deletedObject)
        {
            throw new InvalidObjectException("This object no longer exists on DaPulse", 2);
        }
    }

    /**
     * Store the value in an array if the value is not null. This function is a shortcut of setting values in an array
     * only if they are not null, if not leave them unset; used ideally for PUT requests.
     *
     * @param array  $array The array that will store all of the POST parameters
     * @param string $name  The name of the field
     * @param mixed  $value The value to be stored in a given field
     */
    final protected static function setIfNotNullOrEmpty (&$array, $name, $value)
    {
        if (!is_null($value) || !empty($value))
        {
            $array[$name] = $value;
        }
    }

    // ================================================================================================================
    //   Empty functions
    // ================================================================================================================

    /**
     * Overload this function if any class variables need to be initialized to a default value
     */
    protected function initializeValues ()
    {
    }

    // ================================================================================================================
    //   Lazy loading functions
    // ================================================================================================================

    /**
     * Inject data into the array that will be mapped into individual instance variables. This function must be called
     * **before** lazyCastAll() is called and maps the associative array to objects.
     *
     * @param array $target An array of associative arrays with data to be converted into objects
     * @param array $array  An associative array containing data to be merged with the key being the name of the
     *                      instance variable.
     *
     * @since 0.1.0
     *
     * @throw \InvalidArgumentException If either parameters are not arrays
     */
    final protected static function lazyInject (&$target, $array)
    {
        if (!is_array($target) || !is_array($array))
        {
            throw new \InvalidArgumentException("Both the target and array must be arrays");
        }

        // If the first element is an array, let's assume $target hasn't been lazily casted into objects
        if (is_array($target[0]))
        {
            foreach ($target as &$element)
            {
                $element = array_merge($element, $array);
            }
        }
    }

    /**
     * Convert the specified array into an array of object types if needed
     *
     * @param  string $objectType The class name of the Objects the items should be
     * @param  array  $array      The array to check
     *
     * @since  0.2.0
     */
    final protected static function lazyCastAll (&$array, $objectType)
    {
        if (self::lazyCastNeededOnArray($objectType, $array))
        {
            $array = self::castArrayToObjectArray($objectType, $array);
        }
    }

    /**
     * Convert the specified item into the specified object if needed
     *
     * @param mixed  $target     The item to check
     * @param string $objectType The class name of the Objects the items should be
     *
     * @since 0.2.0
     */
    final protected static function lazyCast (&$target, $objectType)
    {
        if (self::lazyCastNeeded($target, $objectType))
        {
            $object = ($objectType[0] == "\\") ? $objectType : self::OBJ_NAMESPACE . $objectType;
            $target = new $object($target);
        }
    }

    /**
     * Check whether it is required for an array of JSON data to be converted into an array of the specified objects
     *
     * @param  string $objectType The class name of the Objects the items should be
     * @param  array  $array      The array to check
     *
     * @since  0.2.0
     *
     * @return bool True if the array needs to converted into an array of objects
     */
    final protected static function lazyCastNeededOnArray ($objectType, $array)
    {
        $firstItem = $array[0];

        return self::lazyCastNeeded($firstItem, $objectType);
    }

    /**
     * Check if an individual item needs to be lazily converted into an object
     *
     * @param  mixed  $target     The item to check
     * @param  string $objectType The class name of the Objects the items should be
     *
     * @since  0.2.0
     *
     * @return bool
     */
    final protected static function lazyCastNeeded ($target, $objectType)
    {
        $objectDefinition = ($objectType[0] === "\\") ? $objectType : self::OBJ_NAMESPACE . $objectType;

        return !($target instanceof $objectDefinition);
    }

    /**
     * Sends a GET request for a JSON array and casts the response into an array of objects
     *
     * @param  string $url       The API endpoint to call to get the JSON response from
     * @param  string $className The class name of the Object type to cast to
     * @param  array  $params    An associative array of URL parameters that will be passed to the specific call. For
     *                           example, limiting the number of results or the pagination of results. **Warning** The
     *                           API key does NOT need to be passed here
     *
     * @since  0.2.0
     *
     * @return array
     */
    final protected static function fetchAndCastToObjectArray ($url, $className, $params = array())
    {
        $objects = self::sendGet($url, $params);

        return self::castArrayToObjectArray($className, $objects);
    }

    /**
     * Convert an array of associative arrays into a specific object
     *
     * @param  string $className The class name of the Object type
     * @param  array  $objects   An associative array to be converted into an object
     *
     * @since  0.2.0
     *
     * @return array An array of the specified objects
     */
    final protected static function castArrayToObjectArray ($className, $objects)
    {
        $class = self::OBJ_NAMESPACE . $className;
        $array = array();

        foreach ($objects as $post)
        {
            $array[] = new $class($post);
        }

        return $array;
    }

    // ================================================================================================================
    //   URL jobs functions
    // ================================================================================================================

    /**
     * Send a GET request to fetch the data from the specified URL
     *
     * @param  string $url    The API endpoint to call
     * @param  array  $params An associative array of URL parameters that will be passed to the specific call. For
     *                        example, limiting the number of results or the pagination of results. **Warning** The API
     *                        key does NOT need to be passed here
     *
     * @since  0.1.0
     *
     * @return mixed          An associative array of the JSON response from DaPulse
     */
    final protected static function sendGet ($url, $params = array())
    {
        $params["api_key"] = self::$apiKey;

        $urlQuery = new UrlQuery($url, $params);

        return $urlQuery->sendGet();
    }

    /**
     * Send a POST request to a specified URL
     *
     * @param  string $url
     * @param  array  $postParams
     * @param  array  $getParams
     *
     * @since  0.1.0
     *
     * @return mixed
     */
    final protected static function sendPost ($url, $postParams, $getParams = array())
    {
        return self::sendRequest("POST", $url, $postParams, $getParams);
    }

    /**
     * Send a PUT request to a specified URL
     *
     * @param  string $url
     * @param  array  $postParams
     * @param  array  $getParams
     *
     * @since  0.1.0
     *
     * @return mixed
     */
    final protected static function sendPut ($url, $postParams, $getParams = array())
    {
        return self::sendRequest("PUT", $url, $postParams, $getParams);
    }

    /**
     * Send a DELETE request to a specified URL
     *
     * @param  string $url
     * @param  array  $getParams
     *
     * @since  0.1.0
     *
     * @return mixed
     */
    final protected static function sendDelete ($url, $getParams = array())
    {
        return self::sendRequest("DELETE", $url, NULL, $getParams);
    }

    /**
     * Send the appropriate URL request
     *
     * @param  string $type
     * @param  string $url
     * @param  array  $postParams
     * @param  array  $getParams
     *
     * @since  0.1.0
     *
     * @return mixed
     */
    private static function sendRequest ($type, $url, $postParams, $getParams)
    {
        $getParams["api_key"] = self::$apiKey;

        $urlQuery = new UrlQuery($url, $getParams);

        switch ($type)
        {
            case "POST":
                return $urlQuery->sendPost($postParams);

            case "PUT":
                return $urlQuery->sendPut($postParams);

            case "DELETE":
                return $urlQuery->sendDelete();

            default:
                throw new \InvalidArgumentException();
        }
    }

    // ================================================================================================================
    //   API key functions
    // ================================================================================================================

    /**
     * Get the base URL to use in all of the API calls
     *
     * @param  string|null $apiPrefix If the API end point is different from the class's constant, this value will be
     *                                used as the suffix for the API endpoint
     *
     * @since  0.1.0
     *
     * @return string The base URL to call
     */
    final protected static function apiEndpoint ($apiPrefix = NULL)
    {
        $apiSection = isset($apiPrefix) ? $apiPrefix : static::API_PREFIX;

        return sprintf("%s://%s/%s/%s", self::API_PROTOCOL, self::API_ENDPOINT, self::API_VERSION, $apiSection);
    }

    /**
     * Set the API for all calls to the API
     *
     * @param string $apiKey The API key used to access the DaPulse API
     *
     * @since 0.1.0
     */
    final public static function setApiKey ($apiKey)
    {
        self::$apiKey = $apiKey;
    }
}

1			<?php
2
3			/**
4			* This file contains the ApiObject class
5			*
6			* @copyright 2015 Vladimir Jimenez
7			* @license https://github.com/allejo/PhpPulse/blob/master/LICENSE.md MIT
8			*/
9
10			namespace allejo\DaPulse\Objects;
11
12			use allejo\DaPulse\Exceptions\InvalidObjectException;
13			use allejo\DaPulse\Utilities\UrlQuery;
14
15			/**
16			* The base class for all DaPulse API objects
17			*
18			* @internal
19			* @package allejo\DaPulse\Objects
20			* @since 0.1.0
21			*/
22			abstract class ApiObject implements \JsonSerializable
23			{
24			/**
25			* The namespace used for all main PhpPulse objects. This is value is prepended before PhpPulse objects when being
26			* checked with `instanceof`.
27			*
28			* @internal
29			*/
30			const OBJ_NAMESPACE = "\\allejo\\DaPulse\\";
31
32			/**
33			* The default API protocol used for URL calls
34			*
35			* @internal
36			*/
37			const API_PROTOCOL = "https";
38
39			/**
40			* The API end point for URL calls
41			*
42			* @internal
43			*/
44			const API_ENDPOINT = "api.dapulse.com";
45
46			/**
47			* The API version used for URL calls
48			*
49			* @internal
50			*/
51			const API_VERSION = "v1";
52
53			/**
54			* The suffix that is appended to the URL to access functionality for certain objects
55			*
56			* @internal
57			*/
58			const API_PREFIX = "";
59
60			/**
61			* The API key used to make the URL calls
62			*
63			* @var string
64			*/
65			protected static $apiKey;
66
67			/**
68			* When set to true, the object can only be constructed from an associative array of data. It will not attempt
69			* to fetch the data with an API call; this is intended for objects are not directly accessible via the API.
70			*
71			* @var bool
72			*/
73			protected $arrayConstructionOnly = false;
74
75			/**
76			* Set to true if the object has been deleted via an API call but the instance still exists. This variable will
77			* prevent further API calls to a nonexistent object.
78			*
79			* @var bool
80			*/
81			protected $deletedObject = false;
82
83			/**
84			* An associative array representing the original JSON response from DaPulse
85			*
86			* @var array
87			*/
88			protected $jsonResponse;
89
90			/**
91			* Create an object from an API call
92			*
93			* @param int\|array $idOrArray Either the numerical ID of an object or an associative array representing a JSON
94			* response from an API call
95			*
96			* @throw \InvalidArgumentException The specified object cannot be created directly from an API call but instead
97			* requires an associative array of information gathered from other API calls.
98			*
99			* @since 0.1.0
100			*/
101			public function __construct ($idOrArray)
102			{
103			$urlEndPoint = "";
104			$staticClass = explode("\\", get_called_class());
105			$staticClass = end($staticClass);
106
107			if (is_null($idOrArray))
108			{
109			throw new \InvalidArgumentException("You may not initialize " . $staticClass . " with null.");
110			}
111
112			if (!is_array($idOrArray))
113			{
114			$urlEndPoint = sprintf("%s/%d.json", self::apiEndpoint(), $idOrArray);
115			}
116
117			if ($this->arrayConstructionOnly && !is_array($idOrArray))
118			{
119			throw new \InvalidArgumentException("A " . $staticClass . " cannot be fetched from an ID.");
120			}
121
122			$this->jsonResponse = (is_array($idOrArray)) ? $idOrArray : $this::sendGet($urlEndPoint);
			0 ignored issues – show Documentation Bug introduced 2015-11-24 07:30 UTC by Report Bug Copy Issue Report It seems like `is_array($idOrArray) ? $...::sendGet($urlEndPoint)` of type `*` is incompatible with the declared type `array` of property `$jsonResponse`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
123
124			$this->initializeValues();
125			$this->assignResults();
126			}
127
128			/**
129			* {@inheritdoc}
130			*/
131			public function jsonSerialize()
132			{
133			return $this->jsonResponse;
134			}
135
136			// ================================================================================================================
137			// Getter functions
138			// ================================================================================================================
139
140			/**
141			* Access the JSON response from DaPulse directly
142			*
143			* @api
144			* @deprecated 0.3.0 Feed this object to json_encode() to get the JSON representation of this object instead
145			* @since 0.1.0
146			* @todo Remove this in the next major release
			0 ignored issues – show Coding Style introduced 2016-11-07 17:13 UTC by Report Bug Copy Issue Report Comment refers to a TODO task This check looks `TODO` comments that have been left in the code. ``TODO``s show that something is left unfinished and should be attended to. Loading history...
147			* @return array
148			*/
149			final public function getJson ()
150			{
151			return $this->jsonSerialize();
152			}
153
154			// ================================================================================================================
155			// Helper functions
156			// ================================================================================================================
157
158			/**
159			* Assign an associative array from a JSON response and map them to instance variables
160			*
161			* @since 0.1.0
162			*/
163			final protected function assignResults ()
164			{
165			foreach ($this->jsonResponse as $key => $val)
166			{
167			if (property_exists(get_called_class(), $key))
168			{
169			$this->$key = $val;
170			}
171			}
172			}
173
174			/**
175			* Check if the current object has been marked as deleted from DaPulse. If so, throw an exception.
176			*
177			* @throws InvalidObjectException
178			*/
179			final protected function checkInvalid ()
180			{
181			if ($this->deletedObject)
182			{
183			throw new InvalidObjectException("This object no longer exists on DaPulse", 2);
184			}
185			}
186
187			/**
188			* Store the value in an array if the value is not null. This function is a shortcut of setting values in an array
189			* only if they are not null, if not leave them unset; used ideally for PUT requests.
190			*
191			* @param array $array The array that will store all of the POST parameters
192			* @param string $name The name of the field
193			* @param mixed $value The value to be stored in a given field
194			*/
195			final protected static function setIfNotNullOrEmpty (&$array, $name, $value)
196			{
197			if (!is_null($value) \|\| !empty($value))
198			{
199			$array[$name] = $value;
200			}
201			}
202
203			// ================================================================================================================
204			// Empty functions
205			// ================================================================================================================
206
207			/**
208			* Overload this function if any class variables need to be initialized to a default value
209			*/
210			protected function initializeValues ()
211			{
212			}
213
214			// ================================================================================================================
215			// Lazy loading functions
216			// ================================================================================================================
217
218			/**
219			* Inject data into the array that will be mapped into individual instance variables. This function must be called
220			* before lazyCastAll() is called and maps the associative array to objects.
221			*
222			* @param array $target An array of associative arrays with data to be converted into objects
223			* @param array $array An associative array containing data to be merged with the key being the name of the
224			* instance variable.
225			*
226			* @since 0.1.0
227			*
228			* @throw \InvalidArgumentException If either parameters are not arrays
229			*/
230			final protected static function lazyInject (&$target, $array)
231			{
232			if (!is_array($target) \|\| !is_array($array))
233			{
234			throw new \InvalidArgumentException("Both the target and array must be arrays");
235			}
236
237			// If the first element is an array, let's assume $target hasn't been lazily casted into objects
238			if (is_array($target[0]))
239			{
240			foreach ($target as &$element)
241			{
242			$element = array_merge($element, $array);
243			}
244			}
245			}
246
247			/**
248			* Convert the specified array into an array of object types if needed
249			*
250			* @param string $objectType The class name of the Objects the items should be
251			* @param array $array The array to check
252			*
253			* @since 0.2.0
254			*/
255			final protected static function lazyCastAll (&$array, $objectType)
256			{
257			if (self::lazyCastNeededOnArray($objectType, $array))
258			{
259			$array = self::castArrayToObjectArray($objectType, $array);
260			}
261			}
262
263			/**
264			* Convert the specified item into the specified object if needed
265			*
266			* @param mixed $target The item to check
267			* @param string $objectType The class name of the Objects the items should be
268			*
269			* @since 0.2.0
270			*/
271			final protected static function lazyCast (&$target, $objectType)
272			{
273			if (self::lazyCastNeeded($target, $objectType))
274			{
275			$object = ($objectType[0] == "\\") ? $objectType : self::OBJ_NAMESPACE . $objectType;
276			$target = new $object($target);
277			}
278			}
279
280			/**
281			* Check whether it is required for an array of JSON data to be converted into an array of the specified objects
282			*
283			* @param string $objectType The class name of the Objects the items should be
284			* @param array $array The array to check
285			*
286			* @since 0.2.0
287			*
288			* @return bool True if the array needs to converted into an array of objects
289			*/
290			final protected static function lazyCastNeededOnArray ($objectType, $array)
291			{
292			$firstItem = $array[0];
293
294			return self::lazyCastNeeded($firstItem, $objectType);
295			}
296
297			/**
298			* Check if an individual item needs to be lazily converted into an object
299			*
300			* @param mixed $target The item to check
301			* @param string $objectType The class name of the Objects the items should be
302			*
303			* @since 0.2.0
304			*
305			* @return bool
306			*/
307			final protected static function lazyCastNeeded ($target, $objectType)
308			{
309			$objectDefinition = ($objectType[0] === "\\") ? $objectType : self::OBJ_NAMESPACE . $objectType;
310
311			return !($target instanceof $objectDefinition);
312			}
313
314			/**
315			* Sends a GET request for a JSON array and casts the response into an array of objects
316			*
317			* @param string $url The API endpoint to call to get the JSON response from
318			* @param string $className The class name of the Object type to cast to
319			* @param array $params An associative array of URL parameters that will be passed to the specific call. For
320			* example, limiting the number of results or the pagination of results. Warning The
321			* API key does NOT need to be passed here
322			*
323			* @since 0.2.0
324			*
325			* @return array
326			*/
327			final protected static function fetchAndCastToObjectArray ($url, $className, $params = array())
328			{
329			$objects = self::sendGet($url, $params);
330
331			return self::castArrayToObjectArray($className, $objects);
332			}
333
334			/**
335			* Convert an array of associative arrays into a specific object
336			*
337			* @param string $className The class name of the Object type
338			* @param array $objects An associative array to be converted into an object
339			*
340			* @since 0.2.0
341			*
342			* @return array An array of the specified objects
343			*/
344			final protected static function castArrayToObjectArray ($className, $objects)
345			{
346			$class = self::OBJ_NAMESPACE . $className;
347			$array = array();
348
349			foreach ($objects as $post)
350			{
351			$array[] = new $class($post);
352			}
353
354			return $array;
355			}
356
357			// ================================================================================================================
358			// URL jobs functions
359			// ================================================================================================================
360
361			/**
362			* Send a GET request to fetch the data from the specified URL
363			*
364			* @param string $url The API endpoint to call
365			* @param array $params An associative array of URL parameters that will be passed to the specific call. For
366			* example, limiting the number of results or the pagination of results. Warning The API
367			* key does NOT need to be passed here
368			*
369			* @since 0.1.0
370			*
371			* @return mixed An associative array of the JSON response from DaPulse
372			*/
373			final protected static function sendGet ($url, $params = array())
374			{
375			$params["api_key"] = self::$apiKey;
376
377			$urlQuery = new UrlQuery($url, $params);
378
379			return $urlQuery->sendGet();
380			}
381
382			/**
383			* Send a POST request to a specified URL
384			*
385			* @param string $url
386			* @param array $postParams
387			* @param array $getParams
388			*
389			* @since 0.1.0
390			*
391			* @return mixed
392			*/
393			final protected static function sendPost ($url, $postParams, $getParams = array())
394			{
395			return self::sendRequest("POST", $url, $postParams, $getParams);
396			}
397
398			/**
399			* Send a PUT request to a specified URL
400			*
401			* @param string $url
402			* @param array $postParams
403			* @param array $getParams
404			*
405			* @since 0.1.0
406			*
407			* @return mixed
408			*/
409			final protected static function sendPut ($url, $postParams, $getParams = array())
410			{
411			return self::sendRequest("PUT", $url, $postParams, $getParams);
412			}
413
414			/**
415			* Send a DELETE request to a specified URL
416			*
417			* @param string $url
418			* @param array $getParams
419			*
420			* @since 0.1.0
421			*
422			* @return mixed
423			*/
424			final protected static function sendDelete ($url, $getParams = array())
425			{
426			return self::sendRequest("DELETE", $url, NULL, $getParams);
427			}
428
429			/**
430			* Send the appropriate URL request
431			*
432			* @param string $type
433			* @param string $url
434			* @param array $postParams
435			* @param array $getParams
436			*
437			* @since 0.1.0
438			*
439			* @return mixed
440			*/
441			private static function sendRequest ($type, $url, $postParams, $getParams)
442			{
443			$getParams["api_key"] = self::$apiKey;
444
445			$urlQuery = new UrlQuery($url, $getParams);
446
447			switch ($type)
448			{
449			case "POST":
450			return $urlQuery->sendPost($postParams);
451
452			case "PUT":
453			return $urlQuery->sendPut($postParams);
454
455			case "DELETE":
456			return $urlQuery->sendDelete();
457
458			default:
459			throw new \InvalidArgumentException();
460			}
461			}
462
463			// ================================================================================================================
464			// API key functions
465			// ================================================================================================================
466
467			/**
468			* Get the base URL to use in all of the API calls
469			*
470			* @param string\|null $apiPrefix If the API end point is different from the class's constant, this value will be
471			* used as the suffix for the API endpoint
472			*
473			* @since 0.1.0
474			*
475			* @return string The base URL to call
476			*/
477			final protected static function apiEndpoint ($apiPrefix = NULL)
478			{
479			$apiSection = isset($apiPrefix) ? $apiPrefix : static::API_PREFIX;
480
481			return sprintf("%s://%s/%s/%s", self::API_PROTOCOL, self::API_ENDPOINT, self::API_VERSION, $apiSection);
482			}
483
484			/**
485			* Set the API for all calls to the API
486			*
487			* @param string $apiKey The API key used to access the DaPulse API
488			*
489			* @since 0.1.0
490			*/
491			final public static function setApiKey ($apiKey)
492			{
493			self::$apiKey = $apiKey;
494			}
495			}

allejo / PhpPulse

Push — master ( fc3a8f...d318be )

ApiObject::jsonSerialize() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like