MichaelJ2324 / sugarcrm-restv10-sdk

src/Request/Abstracts/AbstractRequest.php

Doc Comments +1 added lines

@@ -133,6 +133,7 @@
 
     /**
      * @inheritdoc
+     * @param string $body
      */
     public function setBody($body) {
         $this->body = $body;

Spacing +1 added lines, -1 removed lines

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

Braces +1 added lines, -1 removed lines

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

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 {
 
     /**
      * @inheritdoc
@@ -32,7 +32,7 @@ 
      * JSON Encode Body
      * @inheritdoc
      */
-    public function setBody($body) {
+    public function setBody($body){
         return parent::setBody(json_encode($body));
     }
 }
\ No newline at end of file

Braces +2 added lines, -2 removed lines

@@ -4,7 +4,7 @@ 
 
 use SugarAPI\SDK\Request\Abstracts\AbstractRequest;
 
-class POST extends AbstractRequest{
+class POST extends AbstractRequest {
 
     /**
      * @inheritdoc
@@ -32,7 +32,7 @@ 
      * JSON Encode Body
      * @inheritdoc
      */
-    public function setBody($body) {
+    public function setBody($body){
         return parent::setBody(json_encode($body));
     }
 }
\ No newline at end of file

src/Response/Abstracts/AbstractResponse.php

Spacing +8 added lines, -8 removed lines

@@ -4,7 +4,7 @@ 
 
 use SugarAPI\SDK\Response\Interfaces\ResponseInterface;
 
-abstract class AbstractResponse implements ResponseInterface{
+abstract class AbstractResponse implements ResponseInterface {
 
     /**
      * Full Curl Response
@@ -36,9 +36,9 @@ 
      */
     protected $error;
 
-    public function __construct($curlResponse,$curlRequest){
+    public function __construct($curlResponse, $curlRequest){
         $this->CurlResponse = $curlResponse;
-        if ($this->checkErrors($curlRequest)) {
+        if ($this->checkErrors($curlRequest)){
             $this->extractResponse($curlRequest);
         }
         $this->setStatus($curlRequest);
@@ -49,7 +49,7 @@ 
      * @param $curlRequest - Curl resource
      */
     protected function setStatus($curlRequest){
-        $this->status = curl_getinfo($curlRequest,CURLINFO_HTTP_CODE);
+        $this->status = curl_getinfo($curlRequest, CURLINFO_HTTP_CODE);
     }
 
     /**
@@ -57,7 +57,7 @@ 
      * @param $curlRequest
      */
     protected function extractResponse($curlRequest){
-        $header_size = curl_getinfo($curlRequest,CURLINFO_HEADER_SIZE);
+        $header_size = curl_getinfo($curlRequest, CURLINFO_HEADER_SIZE);
         $this->headers = substr($this->CurlResponse, 0, $header_size);
         $this->body = substr($this->CurlResponse, $header_size);
     }
@@ -68,7 +68,7 @@ 
      * @return bool
      */
     protected function checkErrors($curlRequest){
-        if (curl_errno($curlRequest) !== CURLE_OK) {
+        if (curl_errno($curlRequest)!==CURLE_OK){
             $this->error = curl_error($curlRequest);
             return false;
         }
@@ -85,14 +85,14 @@ 
     /**
      * @inheritdoc
      */
-    public function getBody() {
+    public function getBody(){
         return $this->body;
     }
 
     /**
      * @inheritdoc
      */
-    public function getHeaders() {
+    public function getHeaders(){
         return $this->headers;
     }
 

Braces +5 added lines, -5 removed lines

@@ -4,7 +4,7 @@ 
 
 use SugarAPI\SDK\Response\Interfaces\ResponseInterface;
 
-abstract class AbstractResponse implements ResponseInterface{
+abstract class AbstractResponse implements ResponseInterface {
 
     /**
      * Full Curl Response
@@ -38,7 +38,7 @@ 
 
     public function __construct($curlResponse,$curlRequest){
         $this->CurlResponse = $curlResponse;
-        if ($this->checkErrors($curlRequest)) {
+        if ($this->checkErrors($curlRequest)){
             $this->extractResponse($curlRequest);
         }
         $this->setStatus($curlRequest);
@@ -68,7 +68,7 @@ 
      * @return bool
      */
     protected function checkErrors($curlRequest){
-        if (curl_errno($curlRequest) !== CURLE_OK) {
+        if (curl_errno($curlRequest) !== CURLE_OK){
             $this->error = curl_error($curlRequest);
             return false;
         }
@@ -85,14 +85,14 @@ 
     /**
      * @inheritdoc
      */
-    public function getBody() {
+    public function getBody(){
         return $this->body;
     }
 
     /**
      * @inheritdoc
      */
-    public function getHeaders() {
+    public function getHeaders(){
         return $this->headers;
     }
 

Upper-Lower-Casing +2 added lines, -2 removed lines

@@ -70,9 +70,9 @@
     protected function checkErrors($curlRequest){
         if (curl_errno($curlRequest) !== CURLE_OK) {
             $this->error = curl_error($curlRequest);
-            return false;
+            return FALSE;
         }
-        return true;
+        return TRUE;
     }
 
     /**

src/Response/File.php

Spacing +9 added lines, -9 removed lines

@@ -18,10 +18,10 @@ 
      */
     protected $destinationPath;
 
-    public function __construct($curlResponse, $curlRequest,$destination = null) {
+    public function __construct($curlResponse, $curlRequest, $destination = null){
         parent::__construct($curlResponse, $curlRequest);
         $this->extractFileName();
-        if (!empty($destination)) {
+        if (!empty($destination)){
             $this->setupDestination($destination);
             $this->writeFile();
         }
@@ -35,7 +35,7 @@ 
         if (empty($destination)){
             $destination = sys_get_temp_dir().'/SugarAPI';
             if (!file_exists($destination)){
-                mkdir($destination,0777);
+                mkdir($destination, 0777);
             }
         }
         $this->destinationPath = $destination;
@@ -45,10 +45,10 @@ 
      * Extract the filename from the Headers, and store it in filename property
      */
     protected function extractFileName(){
-        foreach (explode("\r\n",$this->headers) as $header)
+        foreach (explode("\r\n", $this->headers) as $header)
         {
-            if (strpos($header,'filename')!==FALSE){
-                $this->fileName = substr($header,(strpos($header,"\"")+1),-1);
+            if (strpos($header, 'filename')!==FALSE){
+                $this->fileName = substr($header, (strpos($header, "\"")+1), -1);
             }
         }
     }
@@ -65,8 +65,8 @@ 
      * Write the downloaded file
      */
     protected function writeFile(){
-        $fileHandle = fopen($this->file(),'w+');
-        fwrite($fileHandle,$this->body);
+        $fileHandle = fopen($this->file(), 'w+');
+        fwrite($fileHandle, $this->body);
         fclose($fileHandle);
     }
 
@@ -75,7 +75,7 @@ 
      * @return string
      */
     public function file(){
-        return rtrim($this->destinationPath,DIRECTORY_SEPARATOR).DIRECTORY_SEPARATOR.$this->fileName;
+        return rtrim($this->destinationPath, DIRECTORY_SEPARATOR).DIRECTORY_SEPARATOR.$this->fileName;
     }
 
 }
\ No newline at end of file

Braces +3 added lines, -4 removed lines

@@ -18,10 +18,10 @@ 
      */
     protected $destinationPath;
 
-    public function __construct($curlResponse, $curlRequest,$destination = null) {
+    public function __construct($curlResponse, $curlRequest,$destination = null){
         parent::__construct($curlResponse, $curlRequest);
         $this->extractFileName();
-        if (!empty($destination)) {
+        if (!empty($destination)){
             $this->setupDestination($destination);
             $this->writeFile();
         }
@@ -45,8 +45,7 @@ 
      * Extract the filename from the Headers, and store it in filename property
      */
     protected function extractFileName(){
-        foreach (explode("\r\n",$this->headers) as $header)
-        {
+        foreach (explode("\r\n",$this->headers) as $header){
             if (strpos($header,'filename')!==FALSE){
                 $this->fileName = substr($header,(strpos($header,"\"")+1),-1);
             }

Upper-Lower-Casing +2 added lines, -2 removed lines

@@ -18,7 +18,7 @@ 
      */
     protected $destinationPath;
 
-    public function __construct($curlResponse, $curlRequest,$destination = null) {
+    public function __construct($curlResponse, $curlRequest,$destination = NULL) {
         parent::__construct($curlResponse, $curlRequest);
         $this->extractFileName();
         if (!empty($destination)) {
@@ -31,7 +31,7 @@ 
      * Configure the Destination path to store the File response
      * @param null $destination
      */
-    protected function setupDestination($destination = null){
+    protected function setupDestination($destination = NULL){
         if (empty($destination)){
             $destination = sys_get_temp_dir().'/SugarAPI';
             if (!file_exists($destination)){

src/Client/Abstracts/AbstractClient.php

Doc Comments +3 added lines, -1 removed lines

@@ -72,6 +72,7 @@ 
 
     /**
      * @inheritdoc
+     * @param string $server
      */
     public function setServer($server) {
         $this->server = $server;
@@ -150,7 +151,7 @@ 
     /**
      * @param $funcName
      * @param $className
-     * @return bool
+     * @return AbstractClient
      * @throws EntryPointException
      */
     public function registerEntryPoint($funcName, $className){
@@ -246,6 +247,7 @@ 
 
     /**
      * @inheritdoc
+     * @param \stdClass $token
      */
     public static function storeToken($token, $client_id) {
         static::$_STORED_TOKENS[$client_id] = $token;

Spacing +17 added lines, -17 removed lines

@@ -60,8 +60,8 @@ 
      */
     protected $entryPoints = array();
 
-    public function __construct($server = '',array $credentials = array()){
-        if (!empty($server)) {
+    public function __construct($server = '', array $credentials = array()){
+        if (!empty($server)){
             $this->setServer($server);
         }
         if (!empty($credentials)){
@@ -73,7 +73,7 @@ 
     /**
      * @inheritdoc
      */
-    public function setServer($server) {
+    public function setServer($server){
         $this->server = $server;
         $this->apiURL = Helpers::configureAPIURL($this->server);
         return $this;
@@ -82,7 +82,7 @@ 
     /**
      * @inheritdoc
      */
-    public function getAPIUrl() {
+    public function getAPIUrl(){
         return $this->apiURL;
     }
 
@@ -125,7 +125,7 @@ 
     /**
      * @inheritdoc
      */
-    public function getServer() {
+    public function getServer(){
         return $this->server;
     }
 
@@ -133,7 +133,7 @@ 
      * @inheritdoc
      */
     public function authenticated(){
-        return time() < $this->expiration;
+        return time()<$this->expiration;
     }
 
     /**
@@ -155,10 +155,10 @@ 
      */
     public function registerEntryPoint($funcName, $className){
         $implements = class_implements($className);
-        if (is_array($implements) && in_array('SugarAPI\SDK\EntryPoint\Interfaces\EPInterface',$implements)){
+        if (is_array($implements) && in_array('SugarAPI\SDK\EntryPoint\Interfaces\EPInterface', $implements)){
             $this->entryPoints[$funcName] = $className;
         }else{
-            throw new EntryPointException($className,'Class must extend SugarAPI\SDK\EntryPoint\Interfaces\EPInterface');
+            throw new EntryPointException($className, 'Class must extend SugarAPI\SDK\EntryPoint\Interfaces\EPInterface');
         }
         return $this;
     }
@@ -176,13 +176,13 @@ 
             $EntryPoint = new $Class($this->apiURL, $params);
 
             if ($EntryPoint->authRequired()){
-                if (isset($this->token) && $this->authenticated()) {
+                if (isset($this->token) && $this->authenticated()){
                     $EntryPoint->setAuth($this->getToken()->access_token);
                 }
             }
             return $EntryPoint;
         }else{
-            throw new EntryPointException($name,'Unregistered EntryPoint');
+            throw new EntryPointException($name, 'Unregistered EntryPoint');
         }
     }
 
@@ -190,13 +190,13 @@ 
      * @inheritdoc
      * @throws AuthenticationException - When Login request fails
      */
-    public function login() {
+    public function login(){
         $EP = new OAuth2Token($this->apiURL);
         $response = $EP->execute($this->credentials)->getResponse();
         if ($response->getStatus()=='200'){
             $this->setToken($response->getBody(false));
-            static::storeToken($this->token,$this->credentials['client_id']);
-        } else {
+            static::storeToken($this->token, $this->credentials['client_id']);
+        }else{
             $error = $response->getBody();
             throw new AuthenticationException("Login Response [".$error['error']."] ".$error['error_message']);
         }
@@ -217,7 +217,7 @@ 
         $response = $EP->execute($refreshOptions)->getResponse();
         if ($response->getStatus()=='200'){
             $this->setToken($response->getBody(false));
-            static::storeToken($this->token,$this->credentials['client_id']);
+            static::storeToken($this->token, $this->credentials['client_id']);
         }else{
             $error = $response->getBody();
             throw new AuthenticationException("Refresh Response [".$error['error']."] ".$error['error_message']);
@@ -247,7 +247,7 @@ 
     /**
      * @inheritdoc
      */
-    public static function storeToken($token, $client_id) {
+    public static function storeToken($token, $client_id){
         static::$_STORED_TOKENS[$client_id] = $token;
         return true;
     }
@@ -255,14 +255,14 @@ 
     /**
      * @inheritdoc
      */
-    public static function getStoredToken($client_id) {
+    public static function getStoredToken($client_id){
         return static::$_STORED_TOKENS[$client_id];
     }
 
     /**
      * @inheritdoc
      */
-    public static function removeStoredToken($client_id) {
+    public static function removeStoredToken($client_id){
         unset(static::$_STORED_TOKENS[$client_id]);
         return true;
     }

Braces +14 added lines, -14 removed lines

@@ -61,7 +61,7 @@ 
     protected $entryPoints = array();
 
     public function __construct($server = '',array $credentials = array()){
-        if (!empty($server)) {
+        if (!empty($server)){
             $this->setServer($server);
         }
         if (!empty($credentials)){
@@ -73,7 +73,7 @@ 
     /**
      * @inheritdoc
      */
-    public function setServer($server) {
+    public function setServer($server){
         $this->server = $server;
         $this->apiURL = Helpers::configureAPIURL($this->server);
         return $this;
@@ -82,7 +82,7 @@ 
     /**
      * @inheritdoc
      */
-    public function getAPIUrl() {
+    public function getAPIUrl(){
         return $this->apiURL;
     }
 
@@ -125,7 +125,7 @@ 
     /**
      * @inheritdoc
      */
-    public function getServer() {
+    public function getServer(){
         return $this->server;
     }
 
@@ -157,7 +157,7 @@ 
         $implements = class_implements($className);
         if (is_array($implements) && in_array('SugarAPI\SDK\EntryPoint\Interfaces\EPInterface',$implements)){
             $this->entryPoints[$funcName] = $className;
-        }else{
+        } else{
             throw new EntryPointException($className,'Class must extend SugarAPI\SDK\EntryPoint\Interfaces\EPInterface');
         }
         return $this;
@@ -176,12 +176,12 @@ 
             $EntryPoint = new $Class($this->apiURL, $params);
 
             if ($EntryPoint->authRequired()){
-                if (isset($this->token) && $this->authenticated()) {
+                if (isset($this->token) && $this->authenticated()){
                     $EntryPoint->setAuth($this->getToken()->access_token);
                 }
             }
             return $EntryPoint;
-        }else{
+        } else{
             throw new EntryPointException($name,'Unregistered EntryPoint');
         }
     }
@@ -190,13 +190,13 @@ 
      * @inheritdoc
      * @throws AuthenticationException - When Login request fails
      */
-    public function login() {
+    public function login(){
         $EP = new OAuth2Token($this->apiURL);
         $response = $EP->execute($this->credentials)->getResponse();
         if ($response->getStatus()=='200'){
             $this->setToken($response->getBody(false));
             static::storeToken($this->token,$this->credentials['client_id']);
-        } else {
+        } else{
             $error = $response->getBody();
             throw new AuthenticationException("Login Response [".$error['error']."] ".$error['error_message']);
         }
@@ -218,7 +218,7 @@ 
         if ($response->getStatus()=='200'){
             $this->setToken($response->getBody(false));
             static::storeToken($this->token,$this->credentials['client_id']);
-        }else{
+        } else{
             $error = $response->getBody();
             throw new AuthenticationException("Refresh Response [".$error['error']."] ".$error['error_message']);
         }
@@ -236,7 +236,7 @@ 
             if ($response->getStatus()=='200'){
                 unset($this->token);
                 static::removeStoredToken($this->credentials['client_id']);
-            }else{
+            } else{
                 $error = $response->getBody();
                 throw new AuthenticationException("Logout Response [".$error['error']."] ".$error['message']);
             }
@@ -247,7 +247,7 @@ 
     /**
      * @inheritdoc
      */
-    public static function storeToken($token, $client_id) {
+    public static function storeToken($token, $client_id){
         static::$_STORED_TOKENS[$client_id] = $token;
         return true;
     }
@@ -255,14 +255,14 @@ 
     /**
      * @inheritdoc
      */
-    public static function getStoredToken($client_id) {
+    public static function getStoredToken($client_id){
         return static::$_STORED_TOKENS[$client_id];
     }
 
     /**
      * @inheritdoc
      */
-    public static function removeStoredToken($client_id) {
+    public static function removeStoredToken($client_id){
         unset(static::$_STORED_TOKENS[$client_id]);
         return true;
     }

Upper-Lower-Casing +4 added lines, -4 removed lines

@@ -194,7 +194,7 @@ 
         $EP = new OAuth2Token($this->apiURL);
         $response = $EP->execute($this->credentials)->getResponse();
         if ($response->getStatus()=='200'){
-            $this->setToken($response->getBody(false));
+            $this->setToken($response->getBody(FALSE));
             static::storeToken($this->token,$this->credentials['client_id']);
         } else {
             $error = $response->getBody();
@@ -216,7 +216,7 @@ 
         $EP = new RefreshToken($this->apiURL);
         $response = $EP->execute($refreshOptions)->getResponse();
         if ($response->getStatus()=='200'){
-            $this->setToken($response->getBody(false));
+            $this->setToken($response->getBody(FALSE));
             static::storeToken($this->token,$this->credentials['client_id']);
         }else{
             $error = $response->getBody();
@@ -249,7 +249,7 @@ 
      */
     public static function storeToken($token, $client_id) {
         static::$_STORED_TOKENS[$client_id] = $token;
-        return true;
+        return TRUE;
     }
 
     /**
@@ -264,7 +264,7 @@ 
      */
     public static function removeStoredToken($client_id) {
         unset(static::$_STORED_TOKENS[$client_id]);
-        return true;
+        return TRUE;
     }
 
 }
\ No newline at end of file

src/Response/JSON.php

Spacing +2 added lines, -2 removed lines

@@ -17,8 +17,8 @@
     /**
      * @inheritdoc
      */
-    public function getBody($asArray = true) {
-        return json_decode($this->body,$asArray);
+    public function getBody($asArray = true){
+        return json_decode($this->body, $asArray);
     }
 
 }
\ No newline at end of file

Braces +1 added lines, -1 removed lines

@@ -17,7 +17,7 @@
     /**
      * @inheritdoc
      */
-    public function getBody($asArray = true) {
+    public function getBody($asArray = true){
         return json_decode($this->body,$asArray);
     }
 

Upper-Lower-Casing +1 added lines, -1 removed lines

@@ -17,7 +17,7 @@
     /**
      * @inheritdoc
      */
-    public function getBody($asArray = true) {
+    public function getBody($asArray = TRUE) {
         return json_decode($this->body,$asArray);
     }
 

src/Exception/SDKException.php

Spacing +1 added lines, -1 removed lines

@@ -4,7 +4,7 @@
 
 class EntryPointException extends SDKException {
 
-    public function __construct($message) {
+    public function __construct($message){
         parent::__construct($message);
     }
 

Braces +1 added lines, -1 removed lines

@@ -4,7 +4,7 @@
 
 class EntryPointException extends SDKException {
 
-    public function __construct($message) {
+    public function __construct($message){
         parent::__construct($message);
     }
 

src/Exception/Authentication/AuthenticationException.php

Spacing +2 added lines, -2 removed lines

@@ -8,8 +8,8 @@
 
     protected $message = 'Authentication Exception [%s] occurred in SDK Client. Message: %s';
 
-    public function __construct($message) {
-        parent::__construct(sprintf($this->message,get_called_class(),$message));
+    public function __construct($message){
+        parent::__construct(sprintf($this->message, get_called_class(), $message));
     }
 
 }
\ No newline at end of file

Braces +1 added lines, -1 removed lines

@@ -4,7 +4,7 @@
 
 class EntryPointException extends SDKException {
 
-    public function __construct($message) {
+    public function __construct($message){
         parent::__construct($message);
     }
 

src/Exception/EntryPoint/EntryPointException.php

Spacing +2 added lines, -2 removed lines

@@ -8,8 +8,8 @@
 
     protected $message = 'EntryPoint Exception [%s] occurred on EntryPoint %s: %s';
 
-    public function __construct($EntryPoint,$data) {
-        parent::__construct(sprintf($this->message,get_called_class(),$EntryPoint,$data));
+    public function __construct($EntryPoint, $data){
+        parent::__construct(sprintf($this->message, get_called_class(), $EntryPoint, $data));
     }
 
 }
\ No newline at end of file

Braces +1 added lines, -1 removed lines

@@ -8,7 +8,7 @@
 
     protected $message = 'EntryPoint Exception [%s] occurred on EntryPoint %s: %s';
 
-    public function __construct($EntryPoint,$data) {
+    public function __construct($EntryPoint,$data){
         parent::__construct(sprintf($this->message,get_called_class(),$EntryPoint,$data));
     }