MichaelJ2324 / sugarcrm-restv10-sdk

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

examples/Login.php

Spacing +2 added lines, -2 removed lines

@@ -1,7 +1,7 @@
 <?php
 
-require_once __DIR__ . '/../vendor/autoload.php';
+require_once __DIR__.'/../vendor/autoload.php';
 
-$SugarAPI = new \SugarAPI\SDK\SugarAPI('instances.this/Ent/7621/',array('username' => 'admin','password'=>'asdf'));
+$SugarAPI = new \SugarAPI\SDK\SugarAPI('instances.this/Ent/7621/', array('username' => 'admin', 'password'=>'asdf'));
 $SugarAPI->login();
 print_r($SugarAPI->getToken());
\ No newline at end of file

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;

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

@@ -22,7 +22,7 @@ 
      */
     protected static $_DEFAULT_OPTIONS = array(
         CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_0,
-        CURLOPT_HEADER => true,
+        CURLOPT_HEADER => TRUE,
         CURLOPT_SSL_VERIFYPEER => 0,
         CURLOPT_RETURNTRANSFER => 1,
         CURLOPT_FOLLOWLOCATION => 0
@@ -67,7 +67,7 @@ 
     /**
      * @var null
      */
-    protected $status = null;
+    protected $status = NULL;
 
     /**
      * The Request Type
@@ -75,7 +75,7 @@ 
      */
     protected $type;
 
-    public function __construct($url = null){
+    public function __construct($url = NULL){
         $this->start();
         if (!empty($url)){
             $this->setURL($url);

Spacing +18 added lines, -18 removed lines

@@ -4,7 +4,7 @@ 
 
 use SugarAPI\SDK\Request\Interfaces\RequestInterface;
 
-abstract class AbstractRequest implements RequestInterface{
+abstract class AbstractRequest implements RequestInterface {
 
     const STATUS_INIT = 'initialized';
     const STATUS_SENT = 'sent';
@@ -81,31 +81,31 @@ 
             $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);
         }
     }
 
     /**
      * @inheritdoc
      */
-    public function setURL($url) {
+    public function setURL($url){
         $this->url = $url;
-        $this->setOption(CURLOPT_URL,$this->url);
+        $this->setOption(CURLOPT_URL, $this->url);
         return $this;
     }
 
     /**
      * @inheritdoc
      */
-    public function getURL() {
+    public function getURL(){
         return $this->url;
     }
 
     /**
      * @inheritdoc
      */
-    public function addHeader($name, $value) {
+    public function addHeader($name, $value){
         $token = $name.": ".$value;
         $this->headers[] = $token;
         return $this;
@@ -114,9 +114,9 @@ 
     /**
      * @inheritdoc
      */
-    public function setHeaders(array $array = array()) {
-        if (count($array)>0) {
-            foreach ($array as $key => $value) {
+    public function setHeaders(array $array = array()){
+        if (count($array)>0){
+            foreach ($array as $key => $value){
                 $this->addHeader($key, $value);
             }
         }
@@ -127,14 +127,14 @@ 
     /**
      * @inheritdoc
      */
-    public function getHeaders() {
+    public function getHeaders(){
         return $this->headers;
     }
 
     /**
      * @inheritdoc
      */
-    public function setBody($body) {
+    public function setBody($body){
         $this->body = $body;
         $this->setOption(CURLOPT_POSTFIELDS, $this->body);
         return $this;
@@ -143,28 +143,28 @@ 
     /**
      * @inheritdoc
      */
-    public function getBody() {
+    public function getBody(){
         return $this->body;
     }
 
     /**
      * @inheritdoc
      */
-    public function getCurlObject() {
+    public function getCurlObject(){
         return $this->CurlRequest;
     }
 
     /**
      * @inheritdoc
      */
-    public function setOption($option, $value) {
+    public function setOption($option, $value){
         curl_setopt($this->CurlRequest, $option, $value);
     }
 
     /**
      * @inheritdoc
      */
-    public function send() {
+    public function send(){
         $this->setHeaders();
         $this->CurlResponse = curl_exec($this->CurlRequest);
         $this->status = self::STATUS_SENT;
@@ -199,7 +199,7 @@ 
     /**
      * @inheritdoc
      */
-    public function start() {
+    public function start(){
         $this->CurlRequest = curl_init();
         $this->status = self::STATUS_INIT;
         return $this;
@@ -218,7 +218,7 @@ 
     /**
      * @inheritdoc
      */
-    public function getCurlStatus() {
+    public function getCurlStatus(){
         return $this->status;
     }
 }
\ No newline at end of file

Braces +15 added lines, -15 removed lines

@@ -4,7 +4,7 @@ 
 
 use SugarAPI\SDK\Request\Interfaces\RequestInterface;
 
-abstract class AbstractRequest implements RequestInterface{
+abstract class AbstractRequest implements RequestInterface {
 
     const STATUS_INIT = 'initialized';
     const STATUS_SENT = 'sent';
@@ -89,7 +89,7 @@ 
     /**
      * @inheritdoc
      */
-    public function setURL($url) {
+    public function setURL($url){
         $this->url = $url;
         $this->setOption(CURLOPT_URL,$this->url);
         return $this;
@@ -98,14 +98,14 @@ 
     /**
      * @inheritdoc
      */
-    public function getURL() {
+    public function getURL(){
         return $this->url;
     }
 
     /**
      * @inheritdoc
      */
-    public function addHeader($name, $value) {
+    public function addHeader($name, $value){
         $token = $name.": ".$value;
         $this->headers[] = $token;
         return $this;
@@ -114,9 +114,9 @@ 
     /**
      * @inheritdoc
      */
-    public function setHeaders(array $array = array()) {
-        if (count($array)>0) {
-            foreach ($array as $key => $value) {
+    public function setHeaders(array $array = array()){
+        if (count($array)>0){
+            foreach ($array as $key => $value){
                 $this->addHeader($key, $value);
             }
         }
@@ -127,14 +127,14 @@ 
     /**
      * @inheritdoc
      */
-    public function getHeaders() {
+    public function getHeaders(){
         return $this->headers;
     }
 
     /**
      * @inheritdoc
      */
-    public function setBody($body) {
+    public function setBody($body){
         $this->body = $body;
         $this->setOption(CURLOPT_POSTFIELDS, $this->body);
         return $this;
@@ -143,28 +143,28 @@ 
     /**
      * @inheritdoc
      */
-    public function getBody() {
+    public function getBody(){
         return $this->body;
     }
 
     /**
      * @inheritdoc
      */
-    public function getCurlObject() {
+    public function getCurlObject(){
         return $this->CurlRequest;
     }
 
     /**
      * @inheritdoc
      */
-    public function setOption($option, $value) {
+    public function setOption($option, $value){
         curl_setopt($this->CurlRequest, $option, $value);
     }
 
     /**
      * @inheritdoc
      */
-    public function send() {
+    public function send(){
         $this->setHeaders();
         $this->CurlResponse = curl_exec($this->CurlRequest);
         $this->status = self::STATUS_SENT;
@@ -199,7 +199,7 @@ 
     /**
      * @inheritdoc
      */
-    public function start() {
+    public function start(){
         $this->CurlRequest = curl_init();
         $this->status = self::STATUS_INIT;
         return $this;
@@ -218,7 +218,7 @@ 
     /**
      * @inheritdoc
      */
-    public function getCurlStatus() {
+    public function getCurlStatus(){
         return $this->status;
     }
 }
\ No newline at end of file

src/SugarAPI.php

Doc Comments +3 added lines

@@ -68,6 +68,9 @@
         }
     }
 
+    /**
+     * @param string $className
+     */
     public function registerEntryPoint($funcName,$className){
         if (isset($this->entryPoints[$funcName])){
             throw new SDKException('SDK method already defined. Method '.$funcName.' references Class '.$className);

Unused Use Statements -2 removed lines

@@ -2,8 +2,6 @@
 
 namespace SugarAPI\SDK;
 
-use SugarAPI\SDK\Exception\InitializationFailure;
-use SugarAPI\SDK\Exception\InvalidEntryPoint;
 use SugarAPI\SDK\Exception\AuthenticationException;
 use SugarAPI\SDK\Exception\SDKException;
 

Spacing +17 added lines, -17 removed lines

@@ -28,7 +28,7 @@ 
 
     private $entryPoints = array();
 
-    public function __construct($instance='',array $authOptions = array()){
+    public function __construct($instance = '', array $authOptions = array()){
         $this->loadDefaults();
         if (!empty($instance)){
             $this->setInstance($instance);
@@ -40,8 +40,8 @@ 
     }
 
     protected function loadDefaults(){
-        include __DIR__ .DIRECTORY_SEPARATOR.'defaults.php';
-        if (isset($defaults)) {
+        include __DIR__.DIRECTORY_SEPARATOR.'defaults.php';
+        if (isset($defaults)){
             static::$_DEFAULTS = $defaults;
             if (isset($defaults['instance'])){
                 $this->setInstance($defaults['instance']);
@@ -53,7 +53,7 @@ 
     }
 
     public function setAuthOptions(array $options){
-        foreach($this->authOptions as $key => $value){
+        foreach ($this->authOptions as $key => $value){
             if (isset($options[$key])){
                 $this->authOptions[$key] = $options[$key];
             }
@@ -61,27 +61,27 @@ 
     }
 
     protected function registerSDKEntryPoints(){
-        require __DIR__ .DIRECTORY_SEPARATOR.'EntryPoint' .DIRECTORY_SEPARATOR.'registry.php';
-        foreach($entryPoints as $funcName => $className){
+        require __DIR__.DIRECTORY_SEPARATOR.'EntryPoint'.DIRECTORY_SEPARATOR.'registry.php';
+        foreach ($entryPoints as $funcName => $className){
             $className = "SugarAPI\\SDK\\EntryPoint\\".$className;
-            $this->registerEntryPoint($funcName,$className);
+            $this->registerEntryPoint($funcName, $className);
         }
     }
 
-    public function registerEntryPoint($funcName,$className){
+    public function registerEntryPoint($funcName, $className){
         if (isset($this->entryPoints[$funcName])){
             throw new SDKException('SDK method already defined. Method '.$funcName.' references Class '.$className);
         }
         $this->entryPoints[$funcName] = $className;
     }
 
-    public function __call($name,$params){
-        if (array_key_exists($name,$this->entryPoints)){
+    public function __call($name, $params){
+        if (array_key_exists($name, $this->entryPoints)){
             $Class = $this->entryPoints[$name];
-            $EntryPoint = new $Class($this->url,$params);
+            $EntryPoint = new $Class($this->url, $params);
 
             if ($EntryPoint->authRequired()){
-                if (isset($this->authToken)) {
+                if (isset($this->authToken)){
                     $EntryPoint->configureAuth($this->authToken->access_token);
                 }else{
                     throw new AuthenticationException('no_auth');
@@ -105,17 +105,17 @@ 
         }
     }
     public function setInstance($instance){
-        if (strpos("https",$instance)!==FALSE){
+        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(){
         return $this->url;

Braces +5 added lines, -5 removed lines

@@ -41,7 +41,7 @@ 
 
     protected function loadDefaults(){
         include __DIR__ .DIRECTORY_SEPARATOR.'defaults.php';
-        if (isset($defaults)) {
+        if (isset($defaults)){
             static::$_DEFAULTS = $defaults;
             if (isset($defaults['instance'])){
                 $this->setInstance($defaults['instance']);
@@ -81,14 +81,14 @@ 
             $EntryPoint = new $Class($this->url,$params);
 
             if ($EntryPoint->authRequired()){
-                if (isset($this->authToken)) {
+                if (isset($this->authToken)){
                     $EntryPoint->configureAuth($this->authToken->access_token);
-                }else{
+                } else{
                     throw new AuthenticationException('no_auth');
                 }
             }
             return $EntryPoint;
-        }else{
+        } else{
             throw new SDKException('Method '.$name.', is not a registered method of the SugarAPI SDK');
         }
     }
@@ -100,7 +100,7 @@ 
         $response = $EP->data($this->authOptions)->execute()->getResponse();
         if ($response->getStatus()=='200'){
             $this->authToken = $response->getBody();
-        }else{
+        } else{
             throw new AuthenticationException($response->getBody());
         }
     }

src/EntryPoint/GET/RecordFileField.php

Spacing +1 added lines, -1 removed lines

@@ -4,7 +4,7 @@
 
 use SugarAPI\SDK\EntryPoint\Abstracts\GET\FileEntryPoint as GETFileEntryPoint;
 
-class RecordFileField extends GETFileEntryPoint{
+class RecordFileField extends GETFileEntryPoint {
 
     protected $_URL = '$module/$record/file/$field';
 

Braces +1 added lines, -1 removed lines

@@ -4,7 +4,7 @@
 
 use SugarAPI\SDK\EntryPoint\Abstracts\GET\FileEntryPoint as GETFileEntryPoint;
 
-class RecordFileField extends GETFileEntryPoint{
+class RecordFileField extends GETFileEntryPoint {
 
     /**
      * @inheritdoc

src/EntryPoint/POST/CreateRecord.php

Spacing +1 added lines, -1 removed lines

@@ -4,7 +4,7 @@
 
 use SugarAPI\SDK\EntryPoint\Abstracts\POST\JSONEntryPoint as POSTEntryPoint;
 
-class CreateRecord extends POSTEntryPoint{
+class CreateRecord extends POSTEntryPoint {
 
     protected $_URL = '$module';
 

Braces +1 added lines, -1 removed lines

@@ -4,7 +4,7 @@
 
 use SugarAPI\SDK\EntryPoint\Abstracts\POST\JSONEntryPoint as POSTEntryPoint;
 
-class CreateRecord extends POSTEntryPoint{
+class CreateRecord extends POSTEntryPoint {
 
     protected $_URL = '$module';
 

examples/FavoriteRecord.php

Braces +1 added lines, -1 removed lines

@@ -12,7 +12,7 @@
 
     print_r($response);
 
-}catch(\SugarAPI\SDK\Exception\AuthenticationException $ex){
+} catch(\SugarAPI\SDK\Exception\AuthenticationException $ex){
     print $ex->getMessage();
 }
 

Spacing +4 added lines, -4 removed lines

@@ -1,18 +1,18 @@
 <?php
 
-require_once __DIR__ . '/../vendor/autoload.php';
+require_once __DIR__.'/../vendor/autoload.php';
 
 $record_id = 'a887c75b-b89a-852e-8e67-56f1ccdee355';
 
 try{
-    $SugarAPI = new \SugarAPI\SDK\SugarAPI('localhost/ent77',array('username' => 'admin','password'=>'admin123'));
+    $SugarAPI = new \SugarAPI\SDK\SugarAPI('localhost/ent77', array('username' => 'admin', 'password'=>'admin123'));
     $SugarAPI->login();
-    $EP = $SugarAPI->favorite('Accounts',$record_id);
+    $EP = $SugarAPI->favorite('Accounts', $record_id);
     $response = $EP->execute()->getResponse()->getBody();
 
     print_r($response);
 
-}catch(\SugarAPI\SDK\Exception\AuthenticationException $ex){
+}catch (\SugarAPI\SDK\Exception\AuthenticationException $ex){
     print $ex->getMessage();
 }
 

examples/UploadFile.php

Braces +3 added lines, -3 removed lines

@@ -21,18 +21,18 @@
         if ($response->getStatus()=='200'){
             $record = $response->getBody();
             print_r($response);
-        }else{
+        } else{
             print_r($upload->getRequest());
             echo "Failed to Update Note with File<br>";
             echo "Response: ".$response->getStatus()."<br>";
             print_r($response->getBody());
         }
-    }else{
+    } else{
         echo "Failed to create Note<br>";
         echo "Response: ".$response->getStatus()."<br>";
         print_r($response->getBody());
     }
 
-}catch(\SugarAPI\SDK\Exception\SDKException $ex){
+} catch(\SugarAPI\SDK\Exception\SDKException $ex){
     print $ex->getMessage();
 }
\ No newline at end of file

Spacing +4 added lines, -4 removed lines

@@ -1,16 +1,16 @@ 
 <?php
 
-require_once __DIR__ . '/../vendor/autoload.php';
+require_once __DIR__.'/../vendor/autoload.php';
 
 try{
-    $SugarAPI = new \SugarAPI\SDK\SugarAPI('instances.this/Ent/7700/',array('username' => 'admin','password'=>'asdf'));
+    $SugarAPI = new \SugarAPI\SDK\SugarAPI('instances.this/Ent/7700/', array('username' => 'admin', 'password'=>'asdf'));
     $SugarAPI->login();
     $EP = $SugarAPI->createRecord('Notes')->data(array('name' => 'Test Note'))->execute();
     $response = $EP->getResponse();
     if ($response->getStatus()=='200'){
         $record = $response->getBody();
 
-        $upload = $SugarAPI->attachFile('Notes',$record->id,'filename')->data(__DIR__.'/testfile.txt;filename=testfile.txt')->execute();
+        $upload = $SugarAPI->attachFile('Notes', $record->id, 'filename')->data(__DIR__.'/testfile.txt;filename=testfile.txt')->execute();
         $response = $upload->getResponse();
         if ($response->getStatus()=='200'){
             $record = $response->getBody();
@@ -27,6 +27,6 @@ 
         print_r($response->getBody());
     }
 
-}catch(\SugarAPI\SDK\Exception\SDKException $ex){
+}catch (\SugarAPI\SDK\Exception\SDKException $ex){
     print $ex->getMessage();
 }
\ No newline at end of file

examples/CRUD.php

Braces +6 added lines, -6 removed lines

@@ -39,31 +39,31 @@
                     $response = $deleteRecord->getResponse()->getBody();
                     echo "Deleted Record <br>";
                     print_r($response);
-                }else{
+                } else{
                     echo "Failed to Delete record<br>";
                     echo "Response: ".$response->getStatus()."<br>";
                     print_r($response->getBody());
                 }
-            }else{
+            } else{
                 print_r($updateRecord->getRequest());
                 echo "Failed to Update record<br>";
                 echo "Response: ".$response->getStatus()."<br>";
                 print_r($response->getBody());
             }
-        }else{
+        } else{
             echo "Failed to retrieve record<br>";
             echo "Response: ".$response->getStatus()."<br>";
             print_r($response->getBody());
         }
-    }else{
+    } else{
         echo "Response: ".$response->getStatus();
         print_r($response->getBody());
     }
-}catch(\SugarAPI\SDK\Exception\AuthenticationException $ex){
+} catch(\SugarAPI\SDK\Exception\AuthenticationException $ex){
     echo "Auth Options:<pre>";
     print_r($SugarAPI->getAuthOptions());
     echo "</pre> Error Message: ";
     print $ex->getMessage();
-}catch(\SugarAPI\SDK\Exception\SDKException $ex){
+} catch(\SugarAPI\SDK\Exception\SDKException $ex){
     echo $ex->__toString();
 }

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

@@ -11,7 +11,7 @@
     if ($response->getStatus()=='200'){
         $recordList = $response->getBody();
         $max=count($recordList->records);
-        echo "Found $max records from Filter Records request. <br>";
+        echo "found $max records from Filter Records request. <br>";
         $number = rand(0,$max);
         $randomRecord = $recordList->records[$number];
         echo "Choose random record #$number, with ID: ".$randomRecord->id." <br>";

Spacing +9 added lines, -9 removed lines

@@ -1,22 +1,22 @@ 
 <?php
 
 
-require_once __DIR__ . '/../vendor/autoload.php';
+require_once __DIR__.'/../vendor/autoload.php';
 
 try{
-    $SugarAPI = new \SugarAPI\SDK\SugarAPI('instances.this/Pro/7700/',array('username' => 'admin','password'=>'asdf'));
+    $SugarAPI = new \SugarAPI\SDK\SugarAPI('instances.this/Pro/7700/', array('username' => 'admin', 'password'=>'asdf'));
     $SugarAPI->login();
     $EP = $SugarAPI->filterRecords('Accounts');
     $response = $EP->execute()->getResponse();
     if ($response->getStatus()=='200'){
         $recordList = $response->getBody();
-        $max=count($recordList->records);
+        $max = count($recordList->records);
         echo "Found $max records from Filter Records request. <br>";
-        $number = rand(0,$max);
+        $number = rand(0, $max);
         $randomRecord = $recordList->records[$number];
         echo "Choose random record #$number, with ID: ".$randomRecord->id." <br>";
 
-        $getRecord = $SugarAPI->getRecord('Accounts',$randomRecord->id)->data(array(
+        $getRecord = $SugarAPI->getRecord('Accounts', $randomRecord->id)->data(array(
             'fields' => 'name'
         ))->execute();
         $response = $getRecord->getResponse();
@@ -24,14 +24,14 @@ 
             echo "Retrieved Record <br>";
             $randomRecord = $getRecord->getResponse()->getBody();
             $randomRecord->name = 'Updated Record Name';
-            $updateRecord = $SugarAPI->updateRecord('Accounts',$randomRecord->id)->data($randomRecord)->execute();
+            $updateRecord = $SugarAPI->updateRecord('Accounts', $randomRecord->id)->data($randomRecord)->execute();
             $response = $updateRecord->getResponse();
             if ($response->getStatus()=='200'){
                 $randomRecord = $updateRecord->getResponse()->getBody();
                 echo "Updated Record <br>";
                 print_r($randomRecord);
 
-                $deleteRecord = $SugarAPI->deleteRecord('Accounts',$randomRecord->id)->execute();
+                $deleteRecord = $SugarAPI->deleteRecord('Accounts', $randomRecord->id)->execute();
                 $response = $deleteRecord->getResponse();
                 if ($response->getStatus()=='200'){
                     $response = $deleteRecord->getResponse()->getBody();
@@ -57,11 +57,11 @@ 
         echo "Response: ".$response->getStatus();
         print_r($response->getBody());
     }
-}catch(\SugarAPI\SDK\Exception\AuthenticationException $ex){
+}catch (\SugarAPI\SDK\Exception\AuthenticationException $ex){
     echo "Auth Options:<pre>";
     print_r($SugarAPI->getAuthOptions());
     echo "</pre> Error Message: ";
     print $ex->getMessage();
-}catch(\SugarAPI\SDK\Exception\SDKException $ex){
+}catch (\SugarAPI\SDK\Exception\SDKException $ex){
     echo $ex->__toString();
 }