AbstractRequest::setType() - Code Metrics - Inspection of "Fixed Unit Tests for Request" - MichaelJ2324/sugarcrm-restv10-sdk - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 50d8c4...2d01cb )

by Mike

created 2016-05-02 20:56 UTC

AbstractRequest::setType() A

↳ Parent: AbstractRequest

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	1

Importance

Changes	2
Bugs	1	Features	0

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

<?php
/**
 * ©[2016] SugarCRM Inc.  Licensed by SugarCRM under the Apache 2.0 license.
 */

namespace SugarAPI\SDK\Request\Abstracts;

use SugarAPI\SDK\Request\Interfaces\RequestInterface;

abstract class AbstractRequest implements RequestInterface {

    const STATUS_INIT = 'initialized';
    const STATUS_SENT = 'sent';
    const STATUS_CLOSED = 'closed';

    /**
     * The HTTP Request Type
     * @var string
     */
    protected static $_TYPE = '';

    /**
     * The Default Curl Options
     * @var array
     */
    protected static $_DEFAULT_OPTIONS = array(
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_0,
        CURLOPT_HEADER => TRUE,
        CURLOPT_SSL_VERIFYPEER => FALSE,
        CURLOPT_RETURNTRANSFER => TRUE,
        CURLOPT_FOLLOWLOCATION => FALSE,
        CURLOPT_USERAGENT => 'SugarAPI-SDK-PHP'
    );

    /**
     * The default HTTP Headers to be added to Curl Request
     * @var array
     */
    protected static $_DEFAULT_HEADERS = array();

    /**
     * The Curl Resource used to actually send data to Sugar API
     * @var - Curl Resource
     */
    protected $CurlResponse;

    /**
     * The raw response from curl_exec
     * @var - Curl Response
     */
    protected $CurlRequest;

    /**
     * List of Headers for Request
     * @var array
     */
    protected $headers = array();

    /**
     * The body of the request or payload. JSON Encoded
     * @var string
     */
    protected $body = '';

    /**
     * The URL the Request is sent to
     * @var string
     */
    protected $url = '';

    /**
     * @var null
     */
    protected $status = NULL;

    /**
     * The Request Type
     * @var
     */
    protected $type;

    /**
     * The options configured on the Curl Resource object
     * @var array
     */
    protected $options = array();

    public function __construct($url = NULL){
        $this->start();
        if (!empty($url)){
            $this->setURL($url);
        }
        $this->setType(static::$_TYPE);
        $this->setHeaders(static::$_DEFAULT_HEADERS);
        foreach (static::$_DEFAULT_OPTIONS as $option => $value){
            $this->setOption($option, $value);
        }

    }

    /**
     * Always make sure to destroy Curl Resource
     */
    public function __destruct() {
        if ($this->status!==self::STATUS_CLOSED){
            curl_close($this->CurlRequest);
        }
    }

    /**
     * @inheritdoc
     */
    public function setURL($url){
        $this->url = $url;
        $this->setOption(CURLOPT_URL, $this->url);
        return $this;
    }

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

    /**
     * @inheritdoc
     */
    public function addHeader($name, $value){
        $token = $name.": ".$value;
        $this->headers[] = $token;
        return $this;
    }

    /**
     * @inheritdoc
     */
    public function setHeaders(array $array = array()){
        if (count($array)>0){
            foreach ($array as $key => $value){
                if (is_numeric($key)){
                    $this->headers[] = $value;
                }else {
                    $this->addHeader($key, $value);
                }
            }
        }
        $this->setOption(CURLOPT_HTTPHEADER, $this->headers);
        return $this;
    }

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

    /**
     * @inheritdoc
     */
    public function setBody($body){
        $this->body = $body;
        $this->setOption(CURLOPT_POSTFIELDS, $this->body);
        return $this;
    }

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

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

    /**
     * @inheritdoc
     */
    public function setOption($option, $value){
        curl_setopt($this->CurlRequest, $option, $value);
        $this->options[$option] = $value;
        return $this;
    }

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

    /**
     * @inheritdoc
     */
    public function send(){
        $this->setHeaders();
        $this->CurlResponse = curl_exec($this->CurlRequest);
        $this->status = self::STATUS_SENT;

        return $this;
    }

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

    /**
     * @inheritdoc
     */
    public function setType($type){
        $this->type = strtoupper($type);
        $this->configureType();
        return $this;
    }

    /**
     * Configure the Curl Options based on Request Type
     */
    protected function configureType(){
        switch ($this->type) {
               case 'POST':
                    $this->setOption(CURLOPT_POST, TRUE);
                    break;
               case 'DELETE':
               case 'PUT':
                    $this->setOption(CURLOPT_CUSTOMREQUEST, $this->type);
                    break;
        }
    }

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

    /**
     * @inheritdoc
     */
    public function reset(){
        if (gettype($this->CurlRequest)=='resource'){
            $this->close();
        }
        $this->start();
        return $this;
    }

    /**
     * @inheritdoc
     */
    public function start(){
        $this->CurlRequest = curl_init();
        $this->status = self::STATUS_INIT;

        return $this;
    }

    /**
     * @inheritdoc
     */
    public function close(){
        curl_close($this->CurlRequest);
        unset($this->CurlRequest);
        $this->status = self::STATUS_CLOSED;

        return $this;
    }

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

1		<?php
2		/**
3		* ©[2016] SugarCRM Inc. Licensed by SugarCRM under the Apache 2.0 license.
4		*/
5
6		namespace SugarAPI\SDK\Request\Abstracts;
7
8		use SugarAPI\SDK\Request\Interfaces\RequestInterface;
9
10		abstract class AbstractRequest implements RequestInterface {
11
12		const STATUS_INIT = 'initialized';
13		const STATUS_SENT = 'sent';
14		const STATUS_CLOSED = 'closed';
15
16		/**
17		* The HTTP Request Type
18		* @var string
19		*/
20		protected static $_TYPE = '';
21
22		/**
23		* The Default Curl Options
24		* @var array
25		*/
26		protected static $_DEFAULT_OPTIONS = array(
27		CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_0,
28		CURLOPT_HEADER => TRUE,
29		CURLOPT_SSL_VERIFYPEER => FALSE,
30		CURLOPT_RETURNTRANSFER => TRUE,
31		CURLOPT_FOLLOWLOCATION => FALSE,
32		CURLOPT_USERAGENT => 'SugarAPI-SDK-PHP'
33		);
34
35		/**
36		* The default HTTP Headers to be added to Curl Request
37		* @var array
38		*/
39		protected static $_DEFAULT_HEADERS = array();
40
41		/**
42		* The Curl Resource used to actually send data to Sugar API
43		* @var - Curl Resource
44		*/
45		protected $CurlResponse;
46
47		/**
48		* The raw response from curl_exec
49		* @var - Curl Response
50		*/
51		protected $CurlRequest;
52
53		/**
54		* List of Headers for Request
55		* @var array
56		*/
57		protected $headers = array();
58
59		/**
60		* The body of the request or payload. JSON Encoded
61		* @var string
62		*/
63		protected $body = '';
64
65		/**
66		* The URL the Request is sent to
67		* @var string
68		*/
69		protected $url = '';
70
71		/**
72		* @var null
73		*/
74		protected $status = NULL;
75
76		/**
77		* The Request Type
78		* @var
79		*/
80		protected $type;
81
82		/**
83		* The options configured on the Curl Resource object
84		* @var array
85		*/
86		protected $options = array();
87
88	1	public function __construct($url = NULL){
89	1	$this->start();
90	1	if (!empty($url)){
91	1	$this->setURL($url);
92	1	}
93	1	$this->setType(static::$_TYPE);
94	1	$this->setHeaders(static::$_DEFAULT_HEADERS);
95	1	foreach (static::$_DEFAULT_OPTIONS as $option => $value){
96	1	$this->setOption($option, $value);
97	1	}
98
99	1	}
100
101		/**
102		* Always make sure to destroy Curl Resource
103		*/
104	1	public function __destruct() {
105	1	if ($this->status!==self::STATUS_CLOSED){
106	1	curl_close($this->CurlRequest);
107	1	}
108	1	}
109
110		/**
111		* @inheritdoc
112		*/
113	1	public function setURL($url){
114	1	$this->url = $url;
115	1	$this->setOption(CURLOPT_URL, $this->url);
116	1	return $this;
117		}
118
119		/**
120		* @inheritdoc
121		*/
122	1	public function getURL(){
123	1	return $this->url;
124		}
125
126		/**
127		* @inheritdoc
128		*/
129	1	public function addHeader($name, $value){
130	1	$token = $name.": ".$value;
131	1	$this->headers[] = $token;
132	1	return $this;
133		}
134
135		/**
136		* @inheritdoc
137		*/
138	1	public function setHeaders(array $array = array()){
139	1	if (count($array)>0){
140	1	foreach ($array as $key => $value){
141	1	if (is_numeric($key)){
142	1	$this->headers[] = $value;
143	1	}else {
144	1	$this->addHeader($key, $value);
145		}
146	1	}
147	1	}
148	1	$this->setOption(CURLOPT_HTTPHEADER, $this->headers);
149	1	return $this;
150		}
151
152		/**
153		* @inheritdoc
154		*/
155	1	public function getHeaders(){
156	1	return $this->headers;
157		}
158
159		/**
160		* @inheritdoc
161		*/
162	1	public function setBody($body){
163	1	$this->body = $body;
164	1	$this->setOption(CURLOPT_POSTFIELDS, $this->body);
165	1	return $this;
166		}
167
168		/**
169		* @inheritdoc
170		*/
171	1	public function getBody(){
172	1	return $this->body;
173		}
174
175		/**
176		* @inheritdoc
177		*/
178	2	public function getCurlObject(){
179	2	return $this->CurlRequest;
180		}
181
182		/**
183		* @inheritdoc
184		*/
185	1	public function setOption($option, $value){
186	1	curl_setopt($this->CurlRequest, $option, $value);
187	1	$this->options[$option] = $value;
188	1	return $this;
189		}
190
191		/**
192		* @inheritdoc
193		*/
194	1	public function getOptions() {
195	1	return $this->options;
196		}
197
198		/**
199		* @inheritdoc
200		*/
201	1	public function send(){
202	1	$this->setHeaders();
203	1	$this->CurlResponse = curl_exec($this->CurlRequest);
204	1	$this->status = self::STATUS_SENT;
		0 ignored issues – show Documentation Bug introduced 2016-04-10 00:55 UTC by Report Bug Copy Issue Report It seems like `self::STATUS_SENT` of type `string` is incompatible with the declared type `null` of property `$status`. 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...
205	1	return $this;
206		}
207
208		/**
209		* @inheritdoc
210		*/
211	1	public function getCurlResponse(){
212	1	return $this->CurlResponse;
213		}
214
215		/**
216		* @inheritdoc
217		*/
218	1	public function setType($type){
219	1	$this->type = strtoupper($type);
220	1	$this->configureType();
221	1	return $this;
222		}
223
224		/**
225		* Configure the Curl Options based on Request Type
226		*/
227	1	protected function configureType(){
228	1	switch ($this->type) {
229	1	case 'POST':
230	1	$this->setOption(CURLOPT_POST, TRUE);
231	1	break;
232	1	case 'DELETE':
233	1	case 'PUT':
234	1	$this->setOption(CURLOPT_CUSTOMREQUEST, $this->type);
235	1	break;
236	1	}
237	1	}
238
239		/**
240		* @inheritdoc
241		*/
242	1	public function getType(){
243	1	return $this->type;
244		}
245
246		/**
247		* @inheritdoc
248		*/
249	1	public function reset(){
250	1	if (gettype($this->CurlRequest)=='resource'){
251	1	$this->close();
252	1	}
253	1	$this->start();
254	1	return $this;
255		}
256
257		/**
258		* @inheritdoc
259		*/
260	2	public function start(){
261	2	$this->CurlRequest = curl_init();
262	2	$this->status = self::STATUS_INIT;
		0 ignored issues – show Documentation Bug introduced 2016-04-10 00:55 UTC by Report Bug Copy Issue Report It seems like `self::STATUS_INIT` of type `string` is incompatible with the declared type `null` of property `$status`. 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...
263	2	return $this;
264		}
265
266		/**
267		* @inheritdoc
268		*/
269	1	public function close(){
270	1	curl_close($this->CurlRequest);
271	1	unset($this->CurlRequest);
272	1	$this->status = self::STATUS_CLOSED;
		0 ignored issues – show Documentation Bug introduced 2016-04-10 00:55 UTC by Report Bug Copy Issue Report It seems like `self::STATUS_CLOSED` of type `string` is incompatible with the declared type `null` of property `$status`. 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...
273	1	return $this;
274		}
275
276		/**
277		* @inheritdoc
278		*/
279	2	public function getCurlStatus(){
280	2	return $this->status;
281		}
282		}

MichaelJ2324 / sugarcrm-restv10-sdk

Push — master ( 50d8c4...2d01cb )

AbstractRequest::setType() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like