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

Completed

Push — master ( 3656be...0c0759 )

by Mike

created 2016-04-26 19:28 UTC

AbstractRequest::__destruct() A

↳ Parent: AbstractRequest

Complexity

Conditions	2
Paths	2

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	5
rs	9.4285
cc	2
eloc	3
nc	2
nop	0

<?php

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 => 0,
        CURLOPT_RETURNTRANSFER => 1,
        CURLOPT_FOLLOWLOCATION => 0,
        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;

    public function __construct($url = NULL){
        $this->start();
        if (!empty($url)){
            $this->setURL($url);
        }
        $this->setType();
        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){
                $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;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    /**
     * @inheritdoc
     */
    public function getCurlObject(){
        return $this->CurlRequest;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

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

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

        return $this;
    }

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

    /**
     * Set the Type on the Request
     */
    protected function setType(){
        $this->type = static::$_TYPE;
    }

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

    /**
     * @inheritdoc
     */
    public function reset(){
        if (is_object($this->CurlRequest)){
            $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			namespace SugarAPI\SDK\Request\Abstracts;
4
5			use SugarAPI\SDK\Request\Interfaces\RequestInterface;
6
7			abstract class AbstractRequest implements RequestInterface {
8
9			const STATUS_INIT = 'initialized';
10			const STATUS_SENT = 'sent';
11			const STATUS_CLOSED = 'closed';
12
13			/**
14			* The HTTP Request Type
15			* @var string
16			*/
17			protected static $_TYPE = '';
18
19			/**
20			* The Default Curl Options
21			* @var array
22			*/
23			protected static $_DEFAULT_OPTIONS = array(
24			CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_0,
25			CURLOPT_HEADER => TRUE,
26			CURLOPT_SSL_VERIFYPEER => 0,
27			CURLOPT_RETURNTRANSFER => 1,
28			CURLOPT_FOLLOWLOCATION => 0,
29			CURLOPT_USERAGENT => 'SugarAPI-SDK-PHP'
30			);
31
32			/**
33			* The default HTTP Headers to be added to Curl Request
34			* @var array
35			*/
36			protected static $_DEFAULT_HEADERS = array();
37
38			/**
39			* The Curl Resource used to actually send data to Sugar API
40			* @var - Curl Resource
41			*/
42			protected $CurlResponse;
43
44			/**
45			* The raw response from curl_exec
46			* @var - Curl Response
47			*/
48			protected $CurlRequest;
49
50			/**
51			* List of Headers for Request
52			* @var array
53			*/
54			protected $headers = array();
55
56			/**
57			* The body of the request or payload. JSON Encoded
58			* @var string
59			*/
60			protected $body = '';
61
62			/**
63			* The URL the Request is sent to
64			* @var string
65			*/
66			protected $url = '';
67
68			/**
69			* @var null
70			*/
71			protected $status = NULL;
72
73			/**
74			* The Request Type
75			* @var
76			*/
77			protected $type;
78
79			public function __construct($url = NULL){
80			$this->start();
81			if (!empty($url)){
82			$this->setURL($url);
83			}
84			$this->setType();
85			foreach (static::$_DEFAULT_OPTIONS as $option => $value){
86			$this->setOption($option, $value);
87			}
88			}
89
90			/**
91			* Always make sure to destroy Curl Resource
92			*/
93			public function __destruct() {
94			if ($this->status!==self::STATUS_CLOSED){
95			curl_close($this->CurlRequest);
96			}
97			}
98
99			/**
100			* @inheritdoc
101			*/
102			public function setURL($url){
103			$this->url = $url;
104			$this->setOption(CURLOPT_URL, $this->url);
105			return $this;
106			}
107
108			/**
109			* @inheritdoc
110			*/
111			public function getURL(){
112			return $this->url;
113			}
114
115			/**
116			* @inheritdoc
117			*/
118			public function addHeader($name, $value){
119			$token = $name.": ".$value;
120			$this->headers[] = $token;
121			return $this;
122			}
123
124			/**
125			* @inheritdoc
126			*/
127			public function setHeaders(array $array = array()){
128			if (count($array)>0){
129			foreach ($array as $key => $value){
130			$this->addHeader($key, $value);
131			}
132			}
133			$this->setOption(CURLOPT_HTTPHEADER, $this->headers);
134			return $this;
135			}
136
137			/**
138			* @inheritdoc
139			*/
140			public function getHeaders(){
141			return $this->headers;
142			}
143
144			/**
145			* @inheritdoc
146			*/
147			public function setBody($body){
148			$this->body = $body;
149			$this->setOption(CURLOPT_POSTFIELDS, $this->body);
150			return $this;
151			}
152
153			/**
154			* @inheritdoc
155			*/
156			public function getBody(){
157			return $this->body;
			0 ignored issues – show Bug Best Practice introduced 2016-04-10 22:09 UTC by Report Bug Copy Issue Report The return type of `return $this->body;` (`string`) is incompatible with the return type declared by the interface `SugarAPI\SDK\Request\Int...questInterface::getBody` of type `array`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
158			}
159
160			/**
161			* @inheritdoc
162			*/
163			public function getCurlObject(){
164			return $this->CurlRequest;
			0 ignored issues – show Bug Best Practice introduced 2016-04-08 19:12 UTC by Report Bug Copy Issue Report The return type of `return $this->CurlRequest;` (`resource`) is incompatible with the return type declared by the interface `SugarAPI\SDK\Request\Int...nterface::getCurlObject` of type `SugarAPI\SDK\Request\Interfaces\Curl`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
165			}
166
167			/**
168			* @inheritdoc
169			*/
170			public function setOption($option, $value){
171			curl_setopt($this->CurlRequest, $option, $value);
172			}
173
174			/**
175			* @inheritdoc
176			*/
177			public function send(){
178			$this->setHeaders();
179			$this->CurlResponse = curl_exec($this->CurlRequest);
180			$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...
181			return $this;
182			}
183
184			/**
185			* @inheritdoc
186			*/
187			public function getResponse(){
188			return $this->CurlResponse;
189			}
190
191			/**
192			* Set the Type on the Request
193			*/
194			protected function setType(){
195			$this->type = static::$_TYPE;
196			}
197
198			/**
199			* @inheritdoc
200			*/
201			public function getType(){
202			return $this->type;
203			}
204
205			/**
206			* @inheritdoc
207			*/
208			public function reset(){
209			if (is_object($this->CurlRequest)){
210			$this->close();
211			}
212			$this->start();
213			return $this;
214			}
215
216			/**
217			* @inheritdoc
218			*/
219			public function start(){
220			$this->CurlRequest = curl_init();
221			$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...
222			return $this;
223			}
224
225			/**
226			* @inheritdoc
227			*/
228			public function close(){
229			curl_close($this->CurlRequest);
230			unset($this->CurlRequest);
231			$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...
232			return $this;
233			}
234
235			/**
236			* @inheritdoc
237			*/
238			public function getCurlStatus(){
239			return $this->status;
240			}
241			}

MichaelJ2324 / sugarcrm-restv10-sdk

Push — master ( 3656be...0c0759 )

AbstractRequest::__destruct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like