SugarAPI\SDK\Request\Abstracts\AbstractRequest

Complexity

Total Complexity

31

Size/Duplication

Total Lines	273
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes	9
Bugs	4	Features	0

21 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	12	3
A	__destruct()	0	5	2
A	setURL()	0	5	1
A	getURL()	0	3	1
A	addHeader()	0	5	1
A	setHeaders()	0	13	4
A	getHeaders()	0	3	1
A	setBody()	0	5	1
A	getBody()	0	3	1
A	getCurlObject()	0	3	1
A	setOption()	0	5	1
A	getOptions()	0	3	1
A	send()	0	6	1
A	getCurlResponse()	0	3	1
A	setType()	0	5	1
A	configureType()	0	11	4
A	getType()	0	3	1
A	reset()	0	7	2
A	start()	0	5	1
A	close()	0	6	1
A	getCurlStatus()	0	3	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;

It seems like self::STATUS_SENT of type string is incompatible with the declared type null of property $status.

        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;

It seems like self::STATUS_INIT of type string is incompatible with the declared type null of property $status.

        return $this;
    }

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

It seems like self::STATUS_CLOSED of type string is incompatible with the declared type null of property $status.

        return $this;
    }

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