Bpack247::setTimeOut() - Code Metrics - Antidot-be/bpost-api-library - Measure and Improve Code Quality continuously with Scrutinizer

Bpack247::setTimeOut() A
last analyzed 2016-08-25 18:47 UTC

↳ Parent: Bpack247

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php
namespace Bpost\BpostApiClient;

use Bpost\BpostApiClient\Bpack247\Customer;
use Bpost\BpostApiClient\Exception\BpostApiResponseException\BpostApiBusinessException;
use Bpost\BpostApiClient\Exception\BpostApiResponseException\BpostApiSystemException;
use Bpost\BpostApiClient\Exception\BpostApiResponseException\BpostCurlException;
use Bpost\BpostApiClient\Exception\BpostApiResponseException\BpostInvalidResponseException;

/**
 * bPost Bpack24/7 class
 *
 * @author    Tijs Verkoyen <[email protected]>
 * @version   3.0.0
 * @copyright Copyright (c), Tijs Verkoyen. All rights reserved.
 * @license   BSD License
 */
class Bpack247
{
    // URL for the api
    const API_URL = 'http://www.bpack247.be/BpostRegistrationWebserviceREST/servicecontroller.svc';

    // current version
    const VERSION = '3.0.0';

    /**
     * The account id
     *
     * @var string
     */
    private $accountId;

    /**
     * A cURL instance
     *
     * @var resource
     */
    private $curl;

    /**
     * The passPhrase
     *
     * @var string
     */
    private $passPhrase;

    /**
     * The port to use.
     *
     * @var int
     */
    private $port;


    /**
     * The timeout
     *
     * @var int
     */
    private $timeOut = 30;

    /**
     * The user agent
     *
     * @var string
     */
    private $userAgent;

    /**
     * Make the call
     *
     * @param  string $url    The URL to call.
     * @param  string $body   The data to pass.

     * @param  string $method The HTTP-method to use.
     * @return \SimpleXMLElement
     * @throws BpostApiBusinessException
     * @throws BpostApiSystemException
     * @throws BpostCurlException
     * @throws BpostInvalidResponseException
     */
    private function doCall($url, $body = null, $method = 'GET')
    {
        // build Authorization header
        $headers[] = 'Authorization: Basic ' . $this->getAuthorizationHeader();
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

        // set options
        $options[CURLOPT_URL] = self::API_URL . $url;
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        $options[CURLOPT_USERAGENT] = $this->getUserAgent();
        $options[CURLOPT_RETURNTRANSFER] = true;
        $options[CURLOPT_TIMEOUT] = (int) $this->getTimeOut();
        $options[CURLOPT_HTTP_VERSION] = CURL_HTTP_VERSION_1_1;
        $options[CURLOPT_HTTPHEADER] = $headers;

        if ($method == 'POST') {

            $options[CURLOPT_POST] = true;
            $options[CURLOPT_POSTFIELDS] = $body;
        }

        // init
        $this->curl = curl_init();

        // set options
        curl_setopt_array($this->curl, $options);

        // execute
        $response = curl_exec($this->curl);
        $headers = curl_getinfo($this->curl);

        // fetch errors
        $errorNumber = curl_errno($this->curl);
        $errorMessage = curl_error($this->curl);

        // error?
        if ($errorNumber != '') {
            throw new BpostCurlException($errorMessage, $errorNumber);
        }

        // valid HTTP-code
        if (!in_array($headers['http_code'], array(0, 200))) {
            $xml = @simplexml_load_string($response);

            if (
                $xml !== false
                && ($xml->getName() == 'businessException' || $xml->getName() == 'systemException')
            ) {
                $message = (string) $xml->message;
                $code = isset($xml->code) ? (int) $xml->code : null;
                switch ($xml->getName()) {
                    case 'businessException':
                        throw new BpostApiBusinessException($message, $code);
                    case 'systemException':
                        throw new BpostApiSystemException($message, $code);
                }
            }

            throw new BpostInvalidResponseException('', $headers['http_code']);
        }

        // convert into XML
        $xml = simplexml_load_string($response);

        // validate
        if ($xml->getName() == 'businessException') {
            $message = (string) $xml->message;
            $code = (string) $xml->code;
            throw new BpostApiBusinessException($message, $code);
        }

        // return the response
        return $xml;
    }

    /**
     * Generate the secret string for the Authorization header
     *
     * @return string
     */
    private function getAuthorizationHeader()
    {
        return base64_encode($this->accountId . ':' . $this->passPhrase);
    }

    /**
     * Set the timeout
     * After this time the request will stop. You should handle any errors triggered by this.
     *
     * @param int $seconds The timeout in seconds.
     */
    public function setTimeOut($seconds)
    {
        $this->timeOut = (int) $seconds;
    }

    /**
     * Get the timeout that will be used
     *
     * @return int
     */
    public function getTimeOut()
    {
        return (int) $this->timeOut;
    }

    /**
     * Get the useragent that will be used.
     * Our version will be prepended to yours.
     * It will look like: "PHP Bpost/<version> <your-user-agent>"
     *
     * @return string
     */
    public function getUserAgent()
    {
        return (string) 'PHP Bpost Bpack247/' . self::VERSION . ' ' . $this->userAgent;
    }

    /**
     * Set the user-agent for you application
     * It will be appended to ours, the result will look like: "PHP Bpost/<version> <your-user-agent>"
     *
     * @param string $userAgent Your user-agent, it should look like <app-name>/<app-version>.
     */
    public function setUserAgent($userAgent)
    {
        $this->userAgent = (string) $userAgent;
    }

    /**
     * Create Bpost instance
     *
     * @param string $accountId
     * @param string $passPhrase
     */
    public function __construct($accountId, $passPhrase)
    {
        $this->accountId = (string) $accountId;
        $this->passPhrase = (string) $passPhrase;
    }

    // webservice methods
    /**
     * @param Customer $customer
     *
     * @return \SimpleXMLElement
     * @throws BpostApiBusinessException
     * @throws BpostApiSystemException
     * @throws BpostCurlException
     * @throws BpostInvalidResponseException
     */
    public function createMember(Customer $customer)
    {
        $url = '/customer';

        $document = new \DOMDocument('1.0', 'utf-8');
        $document->preserveWhiteSpace = false;
        $document->formatOutput = true;

        $document->appendChild(
            $customer->toXML(
                $document
            )
        );

        return $this->doCall(
            $url,
            $document->saveXML(),
            'POST'
        );
    }

    /**
     * Retrieve member information
     *
     * @param  string $id
     *
     * @return Customer
     * @throws BpostApiBusinessException
     * @throws BpostApiSystemException
     * @throws BpostCurlException
     * @throws BpostInvalidResponseException
     * @throws Exception\XmlException\BpostXmlNoUserIdFoundException
     */
    public function getMember($id)
    {
        $xml = $this->doCall(
            '/customer/' . $id
        );

        return Customer::createFromXML($xml);
    }
}


1		<?php
2		namespace Bpost\BpostApiClient;
3
4		use Bpost\BpostApiClient\Bpack247\Customer;
5		use Bpost\BpostApiClient\Exception\BpostApiResponseException\BpostApiBusinessException;
6		use Bpost\BpostApiClient\Exception\BpostApiResponseException\BpostApiSystemException;
7		use Bpost\BpostApiClient\Exception\BpostApiResponseException\BpostCurlException;
8		use Bpost\BpostApiClient\Exception\BpostApiResponseException\BpostInvalidResponseException;
9
10		/**
11		* bPost Bpack24/7 class
12		*
13		* @author Tijs Verkoyen <[email protected]>
14		* @version 3.0.0
15		* @copyright Copyright (c), Tijs Verkoyen. All rights reserved.
16		* @license BSD License
17		*/
18		class Bpack247
19		{
20		// URL for the api
21		const API_URL = 'http://www.bpack247.be/BpostRegistrationWebserviceREST/servicecontroller.svc';
22
23		// current version
24		const VERSION = '3.0.0';
25
26		/**
27		* The account id
28		*
29		* @var string
30		*/
31		private $accountId;
32
33		/**
34		* A cURL instance
35		*
36		* @var resource
37		*/
38		private $curl;
39
40		/**
41		* The passPhrase
42		*
43		* @var string
44		*/
45		private $passPhrase;
46
47		/**
48		* The port to use.
49		*
50		* @var int
51		*/
52		private $port;
		0 ignored issues – show Unused Code introduced 2016-03-24 10:55 UTC by Report Bug Copy Issue Report The property `$port` 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...
53
54		/**
55		* The timeout
56		*
57		* @var int
58		*/
59		private $timeOut = 30;
60
61		/**
62		* The user agent
63		*
64		* @var string
65		*/
66		private $userAgent;
67
68		/**
69		* Make the call
70		*
71		* @param string $url The URL to call.
72		* @param string $body The data to pass.
		0 ignored issues – show Documentation introduced 2016-03-24 12:08 UTC by Report Bug Copy Issue Report Should the type for parameter `$body` not be `string\|null`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
73		* @param string $method The HTTP-method to use.
74		* @return \SimpleXMLElement
75		* @throws BpostApiBusinessException
76		* @throws BpostApiSystemException
77		* @throws BpostCurlException
78		* @throws BpostInvalidResponseException
79		*/
80		private function doCall($url, $body = null, $method = 'GET')
81		{
82		// build Authorization header
83		$headers[] = 'Authorization: Basic ' . $this->getAuthorizationHeader();
		0 ignored issues – show Coding Style Comprehensibility introduced 2016-03-24 10:55 UTC by Report Bug Copy Issue Report `$headers` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$headers = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
84
85		// set options
86		$options[CURLOPT_URL] = self::API_URL . $url;
		0 ignored issues – show Coding Style Comprehensibility introduced 2016-03-24 10:55 UTC by Report Bug Copy Issue Report `$options` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$options = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
87		$options[CURLOPT_USERAGENT] = $this->getUserAgent();
88		$options[CURLOPT_RETURNTRANSFER] = true;
89		$options[CURLOPT_TIMEOUT] = (int) $this->getTimeOut();
90		$options[CURLOPT_HTTP_VERSION] = CURL_HTTP_VERSION_1_1;
91		$options[CURLOPT_HTTPHEADER] = $headers;
92
93	View Code Duplication	if ($method == 'POST') {
		0 ignored issues – show Duplication introduced 2016-03-24 10:55 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
94		$options[CURLOPT_POST] = true;
95		$options[CURLOPT_POSTFIELDS] = $body;
96		}
97
98		// init
99		$this->curl = curl_init();
100
101		// set options
102		curl_setopt_array($this->curl, $options);
103
104		// execute
105		$response = curl_exec($this->curl);
106		$headers = curl_getinfo($this->curl);
107
108		// fetch errors
109		$errorNumber = curl_errno($this->curl);
110		$errorMessage = curl_error($this->curl);
111
112		// error?
113		if ($errorNumber != '') {
114		throw new BpostCurlException($errorMessage, $errorNumber);
115		}
116
117		// valid HTTP-code
118		if (!in_array($headers['http_code'], array(0, 200))) {
119		$xml = @simplexml_load_string($response);
120
121		if (
122		$xml !== false
123		&& ($xml->getName() == 'businessException' \|\| $xml->getName() == 'systemException')
124		) {
125		$message = (string) $xml->message;
126		$code = isset($xml->code) ? (int) $xml->code : null;
127		switch ($xml->getName()) {
128		case 'businessException':
129		throw new BpostApiBusinessException($message, $code);
130		case 'systemException':
131		throw new BpostApiSystemException($message, $code);
132		}
133		}
134
135		throw new BpostInvalidResponseException('', $headers['http_code']);
136		}
137
138		// convert into XML
139		$xml = simplexml_load_string($response);
140
141		// validate
142		if ($xml->getName() == 'businessException') {
143		$message = (string) $xml->message;
144		$code = (string) $xml->code;
145		throw new BpostApiBusinessException($message, $code);
146		}
147
148		// return the response
149		return $xml;
150		}
151
152		/**
153		* Generate the secret string for the Authorization header
154		*
155		* @return string
156		*/
157		private function getAuthorizationHeader()
158		{
159		return base64_encode($this->accountId . ':' . $this->passPhrase);
160		}
161
162		/**
163		* Set the timeout
164		* After this time the request will stop. You should handle any errors triggered by this.
165		*
166		* @param int $seconds The timeout in seconds.
167		*/
168		public function setTimeOut($seconds)
169		{
170		$this->timeOut = (int) $seconds;
171		}
172
173		/**
174		* Get the timeout that will be used
175		*
176		* @return int
177		*/
178		public function getTimeOut()
179		{
180		return (int) $this->timeOut;
181		}
182
183		/**
184		* Get the useragent that will be used.
185		* Our version will be prepended to yours.
186		* It will look like: "PHP Bpost/<version> <your-user-agent>"
187		*
188		* @return string
189		*/
190		public function getUserAgent()
191		{
192		return (string) 'PHP Bpost Bpack247/' . self::VERSION . ' ' . $this->userAgent;
193		}
194
195		/**
196		* Set the user-agent for you application
197		* It will be appended to ours, the result will look like: "PHP Bpost/<version> <your-user-agent>"
198		*
199		* @param string $userAgent Your user-agent, it should look like <app-name>/<app-version>.
200		*/
201		public function setUserAgent($userAgent)
202		{
203		$this->userAgent = (string) $userAgent;
204		}
205
206		/**
207		* Create Bpost instance
208		*
209		* @param string $accountId
210		* @param string $passPhrase
211		*/
212		public function __construct($accountId, $passPhrase)
213		{
214		$this->accountId = (string) $accountId;
215		$this->passPhrase = (string) $passPhrase;
216		}
217
218		// webservice methods
219		/**
220		* @param Customer $customer
221		*
222		* @return \SimpleXMLElement
223		* @throws BpostApiBusinessException
224		* @throws BpostApiSystemException
225		* @throws BpostCurlException
226		* @throws BpostInvalidResponseException
227		*/
228		public function createMember(Customer $customer)
229		{
230		$url = '/customer';
231
232		$document = new \DOMDocument('1.0', 'utf-8');
233		$document->preserveWhiteSpace = false;
234		$document->formatOutput = true;
235
236		$document->appendChild(
237		$customer->toXML(
238		$document
239		)
240		);
241
242		return $this->doCall(
243		$url,
244		$document->saveXML(),
245		'POST'
246		);
247		}
248
249		/**
250		* Retrieve member information
251		*
252		* @param string $id
253		*
254		* @return Customer
255		* @throws BpostApiBusinessException
256		* @throws BpostApiSystemException
257		* @throws BpostCurlException
258		* @throws BpostInvalidResponseException
259		* @throws Exception\XmlException\BpostXmlNoUserIdFoundException
260		*/
261		public function getMember($id)
262		{
263		$xml = $this->doCall(
264		'/customer/' . $id
265		);
266
267		return Customer::createFromXML($xml);
268		}
269		}
270

Antidot-be / bpost-api-library

Bpack247::setTimeOut() A last analyzed 2016-08-25 18:47 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Bpack247::setTimeOut() A
last analyzed 2016-08-25 18:47 UTC