MichaelJ2324 / sugarcrm-restv10-sdk

src/Exception/Abstracts/AbstractException.php

Doc Comments +6 added lines

@@ -7,11 +7,17 @@
     protected $defaultMessage = 'Unknown SugarAPI SDK Exception Occurred.';
     protected $failureCodes = array();
 
+    /**
+     * @param string $code
+     */
     public function __construct($code) {
         $message = $this->convertCode($code);
         parent::__construct($message);
     }
 
+    /**
+     * @return string|null
+     */
     protected function convertCode($code,$string=''){
         if (array_key_exists($code,$this->failureCodes)){
             return $this->failureCodes[$code];

Spacing +5 added lines, -5 removed lines

@@ -2,7 +2,7 @@ 
 
 namespace SugarAPI\SDK\Exception\Abstracts;
 
-abstract class AbstractException extends \Exception{
+abstract class AbstractException extends \Exception {
 
     protected $defaultMessage = 'Unknown SugarAPI SDK Exception Occurred.';
     protected $failureCodes = array();
@@ -12,15 +12,15 @@ 
         parent::__construct($message);
     }
 
-    protected function convertCode($code,$string=''){
-        if (array_key_exists($code,$this->failureCodes)){
+    protected function convertCode($code, $string = '') {
+        if (array_key_exists($code, $this->failureCodes)) {
             return $this->failureCodes[$code];
-        }else{
+        }else {
             return $this->defaultMessage;
         }
     }
 
-    public function __toString(){
+    public function __toString() {
         return "SugarAPI SDK Exception [".$this->code." - ".$this->message."] occurred on ".$this->line." in ".$this->file;
     }
 

Braces +1 added lines, -1 removed lines

@@ -15,7 +15,7 @@
     protected function convertCode($code,$string=''){
         if (array_key_exists($code,$this->failureCodes)){
             return $this->failureCodes[$code];
-        }else{
+        } else{
             return $this->defaultMessage;
         }
     }

src/Request/Abstracts/AbstractRequest.php

Indentation +1 added lines, -1 removed lines

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

Spacing +11 added lines, -11 removed lines

@@ -4,7 +4,7 @@ 
 
 use SugarAPI\SDK\Request\Interfaces\RequestInterface;
 
-abstract class AbstractRequest implements RequestInterface{
+abstract class AbstractRequest implements RequestInterface {
 
     /**
      * The HTTP Request Type
@@ -67,14 +67,14 @@ 
      */
     protected $type;
 
-    public function __construct($url = null){
+    public function __construct($url = null) {
         $this->start();
-        if (!empty($url)){
+        if (!empty($url)) {
             $this->setURL($url);
         }
         $this->setType();
-        foreach(static::$_DEFAULT_OPTIONS as $option => $value){
-            $this->setOption($option,$value);
+        foreach (static::$_DEFAULT_OPTIONS as $option => $value) {
+            $this->setOption($option, $value);
         }
     }
 
@@ -83,7 +83,7 @@ 
      */
     public function setURL($url) {
         $this->url = $url;
-        $this->setOption(CURLOPT_URL,$this->url);
+        $this->setOption(CURLOPT_URL, $this->url);
         return $this;
     }
 
@@ -165,22 +165,22 @@ 
     /**
      * @inheritdoc
      */
-    public function getResponse(){
+    public function getResponse() {
        return $this->CurlResponse;
     }
 
     /**
      * Set the Type on the Request
      */
-    protected function setType(){
+    protected function setType() {
         $this->type = static::$_TYPE;
     }
 
     /**
      * @inheritdoc
      */
-    public function reset(){
-        if (is_object($this->CurlRequest)){
+    public function reset() {
+        if (is_object($this->CurlRequest)) {
             $this->close();
         }
         $this->start();
@@ -198,7 +198,7 @@ 
     /**
      * @inheritdoc
      */
-    public function close(){
+    public function close() {
         curl_close($this->CurlRequest);
         unset($this->CurlRequest);
         return $this;

src/Request/POST.php

Spacing +2 added lines, -2 removed lines

@@ -4,7 +4,7 @@ 
 
 use SugarAPI\SDK\Request\Abstracts\AbstractRequest;
 
-class POST extends AbstractRequest{
+class POST extends AbstractRequest {
 
     protected static $_TYPE = 'POST';
 
@@ -13,7 +13,7 @@ 
      *
      * Set the Curl POST Option to True
      */
-    protected function setType(){
+    protected function setType() {
         parent::setType();
         $this->setOption(CURLOPT_POST, 1);
     }

src/Request/DELETE.php

Spacing +2 added lines, -2 removed lines

@@ -4,7 +4,7 @@ 
 
 use SugarAPI\SDK\Request\Abstracts\AbstractRequest;
 
-class DELETE extends AbstractRequest{
+class DELETE extends AbstractRequest {
 
     protected static $_TYPE = 'DELETE';
 
@@ -13,7 +13,7 @@ 
      *
      * Set the Curl Custom Request Option to DELETE
      */
-    protected function setType(){
+    protected function setType() {
         parent::setType();
         $this->setOption(CURLOPT_CUSTOMREQUEST, "DELETE");
     }

src/Request/PUT.php

Spacing +2 added lines, -2 removed lines

@@ -4,7 +4,7 @@ 
 
 use SugarAPI\SDK\Request\Abstracts\AbstractRequest;
 
-class PUT extends AbstractRequest{
+class PUT extends AbstractRequest {
 
     protected static $_TYPE = 'PUT';
 
@@ -13,7 +13,7 @@ 
      *
      * Set the Curl Custom Request Option to PUT
      */
-    protected function setType(){
+    protected function setType() {
         parent::setType();
         $this->setOption(CURLOPT_CUSTOMREQUEST, "PUT");
     }

src/Request/Interfaces/RequestInterface.php

Spacing +2 added lines, -2 removed lines

@@ -23,7 +23,7 @@ 
      * @param $value - Header Value
      * @return SugarAPI\SDK\Request Object
      */
-    public function addHeader($name,$value);
+    public function addHeader($name, $value);
 
     /**
      * Sets the Headers on the Curl Request object, called during Sending. Appends to Request Headers property
@@ -50,7 +50,7 @@ 
      * @param $value - Curl Option Value
      * @return SugarAPI\SDK\Request Object
      */
-    public function setOption($option,$value);
+    public function setOption($option, $value);
 
     /**
      * Set the URL on the Request Object

src/Request/GET.php

Spacing +3 added lines, -3 removed lines

@@ -4,7 +4,7 @@ 
 
 use SugarAPI\SDK\Request\Abstracts\AbstractRequest;
 
-class GET extends AbstractRequest{
+class GET extends AbstractRequest {
 
     protected static $_TYPE = 'GET';
 
@@ -13,7 +13,7 @@ 
      *
      * Convert Body to Query String
      */
-    public function setBody($body){
+    public function setBody($body) {
         $this->body = http_build_query($body);
     }
 
@@ -22,7 +22,7 @@ 
      *
      * Configure the URL with Body since Payload is sent via Query String
      */
-    public function send(){
+    public function send() {
         $this->setURL($this->url."?".$this->body);
         return parent::send();
     }

src/SugarAPI.php

Spacing +32 added lines, -32 removed lines

@@ -28,93 +28,93 @@
 
     private $entryPoints = array();
 
-    public function __construct($instance='',array $authOptions = array()){
+    public function __construct($instance = '', array $authOptions = array()) {
         $this->loadDefaults();
-        if (!empty($instance)){
+        if (!empty($instance)) {
             $this->setInstance($instance);
         }
-        if (!empty($authOptions)){
+        if (!empty($authOptions)) {
             $this->configureAuth($authOptions);
         }
         $this->registerEntryPoints();
     }
 
-    protected function loadDefaults(){
-        include __DIR__ .DIRECTORY_SEPARATOR.'defaults.php';
+    protected function loadDefaults() {
+        include __DIR__.DIRECTORY_SEPARATOR.'defaults.php';
         if (isset($defaults)) {
             static::$_DEFAULTS = $defaults;
-            if (isset($defaults['instance'])){
+            if (isset($defaults['instance'])) {
                 $this->setInstance($defaults['instance']);
             }
-            if (isset($defaults['auth']) && is_array($defaults['auth'])){
+            if (isset($defaults['auth']) && is_array($defaults['auth'])) {
                 $this->configureAuth($defaults['auth']);
             }
         }
     }
 
-    public function configureAuth(array $options){
-        foreach($this->authOptions as $key => $value){
-            if (isset($options[$key])){
+    public function configureAuth(array $options) {
+        foreach ($this->authOptions as $key => $value) {
+            if (isset($options[$key])) {
                 $this->authOptions[$key] = $options[$key];
             }
         }
     }
 
-    protected function registerEntryPoints(){
-        require __DIR__ .DIRECTORY_SEPARATOR.'EntryPoint' .DIRECTORY_SEPARATOR.'registry.php';
-        if (isset($entryPoints)){
+    protected function registerEntryPoints() {
+        require __DIR__.DIRECTORY_SEPARATOR.'EntryPoint'.DIRECTORY_SEPARATOR.'registry.php';
+        if (isset($entryPoints)) {
             $this->entryPoints = $entryPoints;
-        }else{
+        }else {
             throw new InitializationFailure('no_ep_registry');
         }
     }
 
-    public function __call($name,$params){
-        if (array_key_exists($name,$this->entryPoints)){
+    public function __call($name, $params) {
+        if (array_key_exists($name, $this->entryPoints)) {
             $className = "SugarAPI\\SDK\\EntryPoint\\".$this->entryPoints[$name];
-            $EntryPoint = new $className($this->url,$params);
+            $EntryPoint = new $className($this->url, $params);
 
-            if ($EntryPoint->authRequired()){
+            if ($EntryPoint->authRequired()) {
                 if (isset($this->authToken)) {
                     $EntryPoint->getRequest()->addHeader('OAuth-Token', $this->authToken->access_token);
-                }else{
+                }else {
                     throw new AuthenticationError('no_auth');
                 }
             }
             return $EntryPoint;
-        }else{
+        }else {
             throw new InvalidEntryPoint('invalid_ep');
         }
     }
-    public function login(){
-        if (empty($this->authOptions['username']) || empty($this->authOptions['password'])){
+    public function login() {
+        if (empty($this->authOptions['username']) || empty($this->authOptions['password'])) {
             throw new AuthenticationError('missing_user_pass');
         }
         $EP = $this->accessToken();
         $response = $EP->data($this->authOptions)->execute()->getResponse();
-        if ($response->getStatus()=='200'){
+        if ($response->getStatus()=='200') {
             $this->authToken = $response->getBody();
-        }else{
+        }else {
             throw new AuthenticationError('failed_auth');
         }
     }
-    public function setInstance($instance){
-        if (strpos("https",$instance)!==FALSE){
+    public function setInstance($instance) {
+        if (strpos("https", $instance)!==FALSE) {
             $this->secure = TRUE;
         }
-        if (strpos("http",$instance)===FALSE){
+        if (strpos("http", $instance)===FALSE) {
             $instance = "http://".$instance;
         }
-        if (strpos("rest/v10",$instance)!==FALSE){
-            $instance = str_replace("rest/v10","",$instance);
+        if (strpos("rest/v10", $instance)!==FALSE) {
+            $instance = str_replace("rest/v10", "", $instance);
         }
         $this->instance = $instance;
-        $this->url = rtrim($this->instance,"/").self::API_URL;
+        $this->url = rtrim($this->instance, "/").self::API_URL;
     }
-    public function getURL(){
+    public function getURL() {
         return $this->url;
     }
-    public function getToken(){
+    public function getToken() {
         return $this->authToken;
     }
 }
\ No newline at end of file

Braces +4 added lines, -4 removed lines

@@ -64,7 +64,7 @@ 
         require __DIR__ .DIRECTORY_SEPARATOR.'EntryPoint' .DIRECTORY_SEPARATOR.'registry.php';
         if (isset($entryPoints)){
             $this->entryPoints = $entryPoints;
-        }else{
+        } else{
             throw new InitializationFailure('no_ep_registry');
         }
     }
@@ -77,12 +77,12 @@ 
             if ($EntryPoint->authRequired()){
                 if (isset($this->authToken)) {
                     $EntryPoint->getRequest()->addHeader('OAuth-Token', $this->authToken->access_token);
-                }else{
+                } else{
                     throw new AuthenticationError('no_auth');
                 }
             }
             return $EntryPoint;
-        }else{
+        } else{
             throw new InvalidEntryPoint('invalid_ep');
         }
     }
@@ -94,7 +94,7 @@ 
         $response = $EP->data($this->authOptions)->execute()->getResponse();
         if ($response->getStatus()=='200'){
             $this->authToken = $response->getBody();
-        }else{
+        } else{
             throw new AuthenticationError('failed_auth');
         }
     }

src/Response/Abstracts/AbstractResponse.php

Spacing +9 added lines, -9 removed lines

@@ -4,26 +4,26 @@ 
 
 use SugarAPI\SDK\Response\Interfaces\ResponseInterface;
 
-abstract class AbstractResponse implements ResponseInterface{
+abstract class AbstractResponse implements ResponseInterface {
 
     protected $headers;
     protected $body;
     protected $status;
 
-    public function __construct($curlResponse,$curlRequest){
-        $header_size = curl_getinfo($curlRequest,CURLINFO_HEADER_SIZE);
+    public function __construct($curlResponse, $curlRequest) {
+        $header_size = curl_getinfo($curlRequest, CURLINFO_HEADER_SIZE);
         $this->headers = substr($curlResponse, 0, $header_size);
         $this->body = json_decode(substr($curlResponse, $header_size));
-        $this->status = curl_getinfo($curlRequest,CURLINFO_HTTP_CODE);
+        $this->status = curl_getinfo($curlRequest, CURLINFO_HTTP_CODE);
     }
 
     /**
      * @inheritdoc
      */
-    public function json($pretty = false){
-        if ($pretty){
-            return json_encode($this->body,JSON_PRETTY_PRINT);
-        }else{
+    public function json($pretty = false) {
+        if ($pretty) {
+            return json_encode($this->body, JSON_PRETTY_PRINT);
+        }else {
             return json_encode($this->body);
         }
     }
@@ -31,7 +31,7 @@ 
     /**
      * @inheritdoc
      */
-    public function getStatus(){
+    public function getStatus() {
         return $this->status;
     }
 

Braces +1 added lines, -1 removed lines

@@ -15,7 +15,7 @@
     protected function convertCode($code,$string=''){
         if (array_key_exists($code,$this->failureCodes)){
             return $this->failureCodes[$code];
-        }else{
+        } else{
             return $this->defaultMessage;
         }
     }