Stripe::setAppInfo() - Code Metrics - ARCANEDEV/Stripe - Measure and Improve Code Quality continuously with Scrutinizer

Stripe::setAppInfo() A
last analyzed 2017-11-29 19:32 UTC

↳ Parent: Stripe

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

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

<?php namespace Arcanedev\Stripe;

use Arcanedev\Stripe\Contracts\Stripe as StripeContract;
use Arcanedev\Stripe\Exceptions\ApiException;
use Arcanedev\Stripe\Exceptions\ApiKeyNotSetException;
use Psr\Log\LoggerInterface;

/**
 * Class     Stripe
 *
 * @package  Arcanedev\Stripe
 * @author   ARCANEDEV <[email protected]>
 */
abstract class Stripe implements StripeContract
{
    /* -----------------------------------------------------------------
     |  Constants
     | -----------------------------------------------------------------
     */

    /**
     * Library Version.
     *
     * @var string
     */
    const VERSION = '5.2.0';

    /* -----------------------------------------------------------------
     |  Properties
     | -----------------------------------------------------------------
     */

    /**
     * The Stripe API key to be used for requests.
     *
     * @var string
     */
    private static $apiKey;

    /**
     * The Stripe client_id to be used for Connect requests.
     *
     * @var string
     */
    public static $clientId;

    /**
     * The base URL for the Stripe API.
     *
     * @var string
     */
    public static $apiBaseUrl    = 'https://api.stripe.com';

    /**
     * The base URL for the OAuth API.
     *
     * @var string
     */
    public static $connectBase = 'https://connect.stripe.com';

    /**
     * The base URL for the Stripe API uploads endpoint.
     *
     * @var string
     */
    public static $uploadBaseUrl = 'https://uploads.stripe.com';

    /**
     * The version of the Stripe API to use for requests.
     *
     * @var string|null
     */
    public static $apiVersion    = null;

    /**
     * The account ID for connected accounts requests.
     *
     * @var string|null
     */
    public static $accountId     = null;

    /**
     * Verify SSL Certs.
     *
     * @var bool
     */
    public static $verifySslCerts = true;

    /**
     * The application's information (name, version, URL).
     *
     * @var array
     */
    public static $appInfo = [];

    /**
     * The logger instance.
     *
     * @var \Psr\Log\LoggerInterface
     */
    public static $logger = null;

    /* -----------------------------------------------------------------
     |  Getters & Setters
     | -----------------------------------------------------------------
     */

    /**
     * Get the API key used for requests.
     *
     * @return string
     */
    public static function getApiKey()
    {
        return self::$apiKey;
    }

    /**
     * Sets the API key to be used for requests.
     *
     * @param  string  $apiKey
     */
    public static function setApiKey($apiKey)
    {
        self::checkApiKey($apiKey);

        self::$apiKey = $apiKey;
    }

    /**
     * Get API Base URL.
     *
     * @return string
     */
    public static function getApiBaseUrl()
    {
        return self::$apiBaseUrl;
    }

    /**
     * Set API Base URL.
     *
     * @param  string  $apiBaseUrl
     */
    public static function setApiBaseUrl($apiBaseUrl)
    {
        self::checkApiBaseUrl($apiBaseUrl);

        self::$apiBaseUrl = $apiBaseUrl;
    }

    /**
     * The client_id used for Connect requests.
     *
     * @return string
     */
    public static function getClientId()
    {
        return self::$clientId;
    }

    /**
     * Sets the client_id to be used for Connect requests.
     *
     * @param  string  $clientId
     */
    public static function setClientId($clientId)
    {
        self::$clientId = $clientId;
    }

    /**
     * Get Upload Base URL.
     *
     * @return string
     */
    public static function getUploadBaseUrl()
    {
        return self::$uploadBaseUrl;
    }

    /**
     * Set Upload Base URL.
     *
     * @param  string  $uploadBaseUrl
     */
    public static function setUploadBaseUrl($uploadBaseUrl)
    {
        self::checkUploadBaseUrl($uploadBaseUrl);

        self::$uploadBaseUrl = $uploadBaseUrl;
    }

    /**
     * The API version used for requests. null if we're using the latest version.
     *
     * @return string
     */
    public static function getApiVersion()
    {
        return self::$apiVersion;
    }

    /**
     * The API version used for requests. null if we're using the latest version.
     *
     * @return string
     */
    public static function version()
    {
        return self::getApiVersion();
    }

    /**
     * Sets the API version to use for requests.
     *
     * @param  string  $apiVersion
     */
    public static function setApiVersion($apiVersion)
    {
        self::checkApiVersion($apiVersion);

        self::$apiVersion = $apiVersion;
    }

    /**
     * Get the Stripe account ID for connected accounts requests.
     *
     * @return string|null
     */
    public static function getAccountId()
    {
        return self::$accountId;
    }

    /**
     * Set the Stripe account ID to set for connected accounts requests.
     *
     * @param  string  $accountId
     */
    public static function setAccountId($accountId)
    {
        self::$accountId = $accountId;
    }

    /**
     * Get Verify SSL Certs.
     *
     * @return bool
     */
    public static function getVerifySslCerts()
    {
        return self::$verifySslCerts;
    }

    /**
     * Sets Verify SSL Certs.
     *
     * @param  bool  $verify
     */
    public static function setVerifySslCerts($verify)
    {
        self::$verifySslCerts = validate_bool($verify);
    }

    /**
     * Get the Application's information.
     *
     * @return array
     */
    public static function getAppInfo()
    {
        return self::$appInfo;
    }

    /**
     * Set the Application's information.
     *
     * @param  string  $name     The application's name
     * @param  string  $version  The application's version
     * @param  string  $url      The application's URL
     */
    public static function setAppInfo($name, $version = null, $url = null)
    {
        self::$appInfo = compact('name', 'version', 'url');
    }

    /**
     * Get the logger instance.
     *
     * @return \Psr\Log\LoggerInterface
     */
    public static function getLogger()
    {
        if (is_null(self::$logger))
            return new Utilities\DefaultLogger;

        return self::$logger;
    }

    /**
     * Set the logger instance.
     *
     * @param  \Psr\Log\LoggerInterface  $logger
     */
    public static function setLogger(LoggerInterface $logger)
    {
        self::$logger = $logger;
    }

    /* -----------------------------------------------------------------
     |  Main Methods
     | -----------------------------------------------------------------
     */

    /**
     * Init Stripe.
     *
     * @param  string  $apiKey
     */
    public static function init($apiKey)
    {
        self::setApiKey($apiKey);
    }

    /* -----------------------------------------------------------------
     |  Check Methods
     | -----------------------------------------------------------------
     */

    /**
     * Check API Key.
     *
     * @param  string  $apiKey
     *
     * @throws \Arcanedev\Stripe\Exceptions\ApiException
     * @throws \Arcanedev\Stripe\Exceptions\ApiKeyNotSetException
     */
    private static function checkApiKey(&$apiKey)
    {
        if ( ! is_string($apiKey))
            throw new ApiException('The API KEY must be a string value.', 500);

        $apiKey = trim($apiKey);

        if (empty($apiKey))
            throw new ApiKeyNotSetException('You must specify your api key to use stripe.');
    }

    /**
     * Check API Base URL.
     *
     * @param  string  $apiBaseUrl
     *
     * @throws \Arcanedev\Stripe\Exceptions\ApiException
     */
    private static function checkApiBaseUrl($apiBaseUrl)
    {
        if ( ! is_string($apiBaseUrl))
            throw new ApiException(
                'The API base URL be string value. '.gettype($apiBaseUrl).' is given.', 500
            );

        if ( ! validate_url($apiBaseUrl))
            throw new ApiException('The API base URL is not a valid URL.', 500);
    }

    /**
     * Check Upload Base URL.
     *
     * @param  string  $uploadBaseUrl
     *
     * @throws \Arcanedev\Stripe\Exceptions\ApiException
     */
    private static function checkUploadBaseUrl($uploadBaseUrl)
    {
        if ( ! is_string($uploadBaseUrl)) {
            throw new ApiException(
                'The Upload base URL be string value. '.gettype($uploadBaseUrl).' is given.', 500
            );
        }

        if ( ! validate_url($uploadBaseUrl))
            throw new ApiException('The Upload base URL is not a valid URL.', 500);
    }

    /**
     * Check API Version.
     *
     * @param  string|null  $apiVersion
     *
     * @throws \Arcanedev\Stripe\Exceptions\ApiException
     */
    private static function checkApiVersion(&$apiVersion)
    {
        if (
            ! is_null($apiVersion) &&
            ! is_string($apiVersion)
        )
            throw new ApiException(
                'The API version must be a null or string value. '.gettype($apiVersion).' is given.', 500
            );

        if (is_null($apiVersion)) return;

        $apiVersion = trim($apiVersion);

        if ( ! validate_version($apiVersion))
            throw new ApiException('The API version must valid a semantic version [x.x.x].', 500);
    }

    /**
     * Check if API version exists.
     *
     * @return bool
     */
    public static function hasApiVersion()
    {
        return ! empty(self::$apiVersion);
    }

    /**
     * Check if the Stripe has account ID for connected accounts requests.
     *
     * @return bool
     */
    public static function hasAccountId()
    {
        return ! empty(self::$accountId);
    }
}


1		<?php namespace Arcanedev\Stripe;
2
3		use Arcanedev\Stripe\Contracts\Stripe as StripeContract;
4		use Arcanedev\Stripe\Exceptions\ApiException;
5		use Arcanedev\Stripe\Exceptions\ApiKeyNotSetException;
6		use Psr\Log\LoggerInterface;
7
8		/**
9		* Class Stripe
10		*
11		* @package Arcanedev\Stripe
12		* @author ARCANEDEV <[email protected]>
13		*/
14		abstract class Stripe implements StripeContract
15		{
16		/* -----------------------------------------------------------------
17		\| Constants
18		\| -----------------------------------------------------------------
19		*/
20
21		/**
22		* Library Version.
23		*
24		* @var string
25		*/
26		const VERSION = '5.2.0';
27
28		/* -----------------------------------------------------------------
29		\| Properties
30		\| -----------------------------------------------------------------
31		*/
32
33		/**
34		* The Stripe API key to be used for requests.
35		*
36		* @var string
37		*/
38		private static $apiKey;
39
40		/**
41		* The Stripe client_id to be used for Connect requests.
42		*
43		* @var string
44		*/
45		public static $clientId;
46
47		/**
48		* The base URL for the Stripe API.
49		*
50		* @var string
51		*/
52		public static $apiBaseUrl = 'https://api.stripe.com';
53
54		/**
55		* The base URL for the OAuth API.
56		*
57		* @var string
58		*/
59		public static $connectBase = 'https://connect.stripe.com';
60
61		/**
62		* The base URL for the Stripe API uploads endpoint.
63		*
64		* @var string
65		*/
66		public static $uploadBaseUrl = 'https://uploads.stripe.com';
67
68		/**
69		* The version of the Stripe API to use for requests.
70		*
71		* @var string\|null
72		*/
73		public static $apiVersion = null;
74
75		/**
76		* The account ID for connected accounts requests.
77		*
78		* @var string\|null
79		*/
80		public static $accountId = null;
81
82		/**
83		* Verify SSL Certs.
84		*
85		* @var bool
86		*/
87		public static $verifySslCerts = true;
88
89		/**
90		* The application's information (name, version, URL).
91		*
92		* @var array
93		*/
94		public static $appInfo = [];
95
96		/**
97		* The logger instance.
98		*
99		* @var \Psr\Log\LoggerInterface
100		*/
101		public static $logger = null;
102
103		/* -----------------------------------------------------------------
104		\| Getters & Setters
105		\| -----------------------------------------------------------------
106		*/
107
108		/**
109		* Get the API key used for requests.
110		*
111		* @return string
112		*/
113	414	public static function getApiKey()
114		{
115	414	return self::$apiKey;
116		}
117
118		/**
119		* Sets the API key to be used for requests.
120		*
121		* @param string $apiKey
122		*/
123	690	public static function setApiKey($apiKey)
124		{
125	690	self::checkApiKey($apiKey);
126
127	690	self::$apiKey = $apiKey;
128	690	}
129
130		/**
131		* Get API Base URL.
132		*
133		* @return string
134		*/
135	408	public static function getApiBaseUrl()
136		{
137	408	return self::$apiBaseUrl;
138		}
139
140		/**
141		* Set API Base URL.
142		*
143		* @param string $apiBaseUrl
144		*/
145	6	public static function setApiBaseUrl($apiBaseUrl)
146		{
147	6	self::checkApiBaseUrl($apiBaseUrl);
148
149	2	self::$apiBaseUrl = $apiBaseUrl;
150	2	}
151
152		/**
153		* The client_id used for Connect requests.
154		*
155		* @return string
156		*/
157	6	public static function getClientId()
158		{
159	6	return self::$clientId;
160		}
161
162		/**
163		* Sets the client_id to be used for Connect requests.
164		*
165		* @param string $clientId
166		*/
167	12	public static function setClientId($clientId)
168		{
169	12	self::$clientId = $clientId;
170	12	}
171
172		/**
173		* Get Upload Base URL.
174		*
175		* @return string
176		*/
177	8	public static function getUploadBaseUrl()
178		{
179	8	return self::$uploadBaseUrl;
180		}
181
182		/**
183		* Set Upload Base URL.
184		*
185		* @param string $uploadBaseUrl
186		*/
187	6	public static function setUploadBaseUrl($uploadBaseUrl)
188		{
189	6	self::checkUploadBaseUrl($uploadBaseUrl);
190
191	2	self::$uploadBaseUrl = $uploadBaseUrl;
192	2	}
193
194		/**
195		* The API version used for requests. null if we're using the latest version.
196		*
197		* @return string
198		*/
199	324	public static function getApiVersion()
200		{
201	324	return self::$apiVersion;
202		}
203
204		/**
205		* The API version used for requests. null if we're using the latest version.
206		*
207		* @return string
208		*/
209	2	public static function version()
210		{
211	2	return self::getApiVersion();
212		}
213
214		/**
215		* Sets the API version to use for requests.
216		*
217		* @param string $apiVersion
218		*/
219	690	public static function setApiVersion($apiVersion)
220		{
221	690	self::checkApiVersion($apiVersion);
222
223	690	self::$apiVersion = $apiVersion;
224	690	}
225
226		/**
227		* Get the Stripe account ID for connected accounts requests.
228		*
229		* @return string\|null
230		*/
231	2	public static function getAccountId()
232		{
233	2	return self::$accountId;
234		}
235
236		/**
237		* Set the Stripe account ID to set for connected accounts requests.
238		*
239		* @param string $accountId
240		*/
241	2	public static function setAccountId($accountId)
242		{
243	2	self::$accountId = $accountId;
244	2	}
245
246		/**
247		* Get Verify SSL Certs.
248		*
249		* @return bool
250		*/
251	2	public static function getVerifySslCerts()
252		{
253	2	return self::$verifySslCerts;
254		}
255
256		/**
257		* Sets Verify SSL Certs.
258		*
259		* @param bool $verify
260		*/
261	18	public static function setVerifySslCerts($verify)
262		{
263	18	self::$verifySslCerts = validate_bool($verify);
264	18	}
265
266		/**
267		* Get the Application's information.
268		*
269		* @return array
270		*/
271	314	public static function getAppInfo()
272		{
273	314	return self::$appInfo;
274		}
275
276		/**
277		* Set the Application's information.
278		*
279		* @param string $name The application's name
280		* @param string $version The application's version
281		* @param string $url The application's URL
282		*/
283	4	public static function setAppInfo($name, $version = null, $url = null)
284		{
285	4	self::$appInfo = compact('name', 'version', 'url');
286	4	}
287
288		/**
289		* Get the logger instance.
290		*
291		* @return \Psr\Log\LoggerInterface
292		*/
293		public static function getLogger()
294		{
295		if (is_null(self::$logger))
296		return new Utilities\DefaultLogger;
297
298		return self::$logger;
299		}
300
301		/**
302		* Set the logger instance.
303		*
304		* @param \Psr\Log\LoggerInterface $logger
305		*/
306		public static function setLogger(LoggerInterface $logger)
307		{
308		self::$logger = $logger;
309		}
310
311		/* -----------------------------------------------------------------
312		\| Main Methods
313		\| -----------------------------------------------------------------
314		*/
315
316		/**
317		* Init Stripe.
318		*
319		* @param string $apiKey
320		*/
321	2	public static function init($apiKey)
322		{
323	2	self::setApiKey($apiKey);
324	2	}
325
326		/* -----------------------------------------------------------------
327		\| Check Methods
328		\| -----------------------------------------------------------------
329		*/
330
331		/**
332		* Check API Key.
333		*
334		* @param string $apiKey
335		*
336		* @throws \Arcanedev\Stripe\Exceptions\ApiException
337		* @throws \Arcanedev\Stripe\Exceptions\ApiKeyNotSetException
338		*/
339	690	private static function checkApiKey(&$apiKey)
340		{
341	690	if ( ! is_string($apiKey))
342	2	throw new ApiException('The API KEY must be a string value.', 500);
343
344	690	$apiKey = trim($apiKey);
345
346	690	if (empty($apiKey))
347	2	throw new ApiKeyNotSetException('You must specify your api key to use stripe.');
348	690	}
349
350		/**
351		* Check API Base URL.
352		*
353		* @param string $apiBaseUrl
354		*
355		* @throws \Arcanedev\Stripe\Exceptions\ApiException
356		*/
357	6	private static function checkApiBaseUrl($apiBaseUrl)
358		{
359	6	if ( ! is_string($apiBaseUrl))
360	2	throw new ApiException(
361	2	'The API base URL be string value. '.gettype($apiBaseUrl).' is given.', 500
362		);
363
364	4	if ( ! validate_url($apiBaseUrl))
365	2	throw new ApiException('The API base URL is not a valid URL.', 500);
366	2	}
367
368		/**
369		* Check Upload Base URL.
370		*
371		* @param string $uploadBaseUrl
372		*
373		* @throws \Arcanedev\Stripe\Exceptions\ApiException
374		*/
375	6	private static function checkUploadBaseUrl($uploadBaseUrl)
376		{
377	6	if ( ! is_string($uploadBaseUrl)) {
378	2	throw new ApiException(
379	2	'The Upload base URL be string value. '.gettype($uploadBaseUrl).' is given.', 500
380		);
381		}
382
383	4	if ( ! validate_url($uploadBaseUrl))
384	2	throw new ApiException('The Upload base URL is not a valid URL.', 500);
385	2	}
386
387		/**
388		* Check API Version.
389		*
390		* @param string\|null $apiVersion
391		*
392		* @throws \Arcanedev\Stripe\Exceptions\ApiException
393		*/
394	690	private static function checkApiVersion(&$apiVersion)
395		{
396		if (
397	690	! is_null($apiVersion) &&
398	690	! is_string($apiVersion)
399		)
400	2	throw new ApiException(
401	2	'The API version must be a null or string value. '.gettype($apiVersion).' is given.', 500
402		);
403
404	690	if (is_null($apiVersion)) return;
405
406	690	$apiVersion = trim($apiVersion);
407
408	690	if ( ! validate_version($apiVersion))
409	2	throw new ApiException('The API version must valid a semantic version [x.x.x].', 500);
410	690	}
411
412		/**
413		* Check if API version exists.
414		*
415		* @return bool
416		*/
417	314	public static function hasApiVersion()
418		{
419	314	return ! empty(self::$apiVersion);
420		}
421
422		/**
423		* Check if the Stripe has account ID for connected accounts requests.
424		*
425		* @return bool
426		*/
427	314	public static function hasAccountId()
428		{
429	314	return ! empty(self::$accountId);
430		}
431		}
432

ARCANEDEV / Stripe

Stripe::setAppInfo() A last analyzed 2017-11-29 19:32 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Stripe::setAppInfo() A
last analyzed 2017-11-29 19:32 UTC