MichaelJ2324 / sugarcrm-restv10-sdk

src/Request/Abstracts/AbstractRequest.php

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;

Doc Comments +1 added lines

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

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/EntryPoint/Abstracts/AbstractEntryPoint.php

Braces +5 added lines, -5 removed lines

@@ -189,10 +189,10 @@ 
         if ($urlVarCount!==$optionCount){
             if (empty($this->Module)){
                 throw new EntryPointExecutionFailure('missing_module');
-            }else{
+            } else{
                 throw new EntryPointExecutionFailure('missing_options');
             }
-        }else{
+        } else{
             return true;
         }
     }
@@ -203,18 +203,18 @@ 
     protected function validateData(){
         if (empty($this->_REQUIRED_DATA)||count($this->_REQUIRED_DATA)==0){
             return true;
-        }else{
+        } else{
             $errors = array();
             foreach($this->_REQUIRED_DATA as $property){
                 if (isset($this->Data[$property]) || $this->Data[$property]!==null){
                     continue;
-                }else{
+                } else{
                     $errors[] = $property;
                 }
             }
             if (count($errors)>0){
                 throw new EntryPointExecutionFailure('missing_data');
-            }else{
+            } else{
                 return true;
             }
         }

Spacing +36 added lines, -36 removed lines

@@ -22,13 +22,13 @@ 
     protected $Request;
     protected $Response;
 
-    public function __construct($url,$options = array()){
+    public function __construct($url, $options = array()) {
         $this->url = $url;
         $this->Module = $this->_MODULE;
 
         if (!empty($options)) {
             if (empty($this->Module)) {
-                if (strpos($this->_URL, '$module') !== FALSE) {
+                if (strpos($this->_URL, '$module')!==FALSE) {
                     $this->module($options[0]);
                     array_shift($options);
                 }
@@ -41,7 +41,7 @@ 
     /**
      * @inheritdoc
      */
-    public function module($module){
+    public function module($module) {
         $this->Module = $module;
         return $this;
     }
@@ -49,7 +49,7 @@ 
     /**
      * @inheritdoc
      */
-    public function options(array $options){
+    public function options(array $options) {
         $this->Options = $options;
         return $this;
     }
@@ -57,7 +57,7 @@ 
     /**
      * @inheritdoc
      */
-    public function data(array $data){
+    public function data(array $data) {
         $this->Data = $data;
         $this->Request->setBody($this->Data);
         return $this;
@@ -66,7 +66,7 @@ 
     /**
      * @inheritdoc
      */
-    public function execute(){
+    public function execute() {
         if ($this->verifyURL() && $this->validateData()) {
             $this->configureURL();
             $this->Request->setURL($this->url);
@@ -96,28 +96,28 @@ 
     /**
      *
      */
-    public function getData(){
+    public function getData() {
         return $this->Data;
     }
 
     /**
      * @inheritdoc
      */
-    public function getURL(){
+    public function getURL() {
         return $this->url;
     }
 
     /**
      * @inheritdoc
      */
-    public function getResponse(){
+    public function getResponse() {
         return $this->Response;
     }
 
     /**
      * @inheritdoc
      */
-    public function getRequest(){
+    public function getRequest() {
         return $this->Request;
     }
 
@@ -126,32 +126,32 @@ 
      * - Replaces $module with $this->Module
      * - Replcaes all other variables starting with $, with options in the order they were given
      */
-    protected function configureURL(){
+    protected function configureURL() {
         $url = $this->_URL;
-        if (strpos($this->_URL,"$")!==FALSE) {
-            if (count($this->Options) > 0 || !empty($this->Module)) {
+        if (strpos($this->_URL, "$")!==FALSE) {
+            if (count($this->Options)>0 || !empty($this->Module)) {
                 $urlParts = explode("/", $this->_URL);
                 $o = 0;
                 foreach ($urlParts as $key => $part) {
-                    if (strpos($part, '$module') !== FALSE) {
+                    if (strpos($part, '$module')!==FALSE) {
                         if (isset($this->Module)) {
                             $urlParts[$key] = $this->Module;
                             continue;
-                        } else {
+                        }else {
                             if (isset($this->Options[$o])) {
                                 $this->Module = $this->Options[$o];
                                 array_shift($this->Options);
                             }
                         }
                     }
-                    if (strpos($part, "$") !== FALSE) {
+                    if (strpos($part, "$")!==FALSE) {
                         if (isset($this->Options[$o])) {
                             $urlParts[$key] = $this->Options[$o];
                             $o++;
                         }
                     }
                 }
-                $url = implode($urlParts,"/");
+                $url = implode($urlParts, "/");
             }
         }
         $this->url = $this->url.$url;
@@ -160,15 +160,15 @@ 
     /**
      * Setup the Request Object property, setup on initial Construct of EntryPoint
      */
-    protected function setupRequest(){
+    protected function setupRequest() {
         $this->Request = new POST();
     }
 
     /**
      * Setup the Response Object Property, not called until after Request Execution
      */
-    protected function setupResponse(){
-        $this->Response = new JSONResponse($this->Request->getResponse(),$this->Request->getCurlObject());
+    protected function setupResponse() {
+        $this->Response = new JSONResponse($this->Request->getResponse(), $this->Request->getCurlObject());
     }
 
     /**
@@ -176,20 +176,20 @@ 
      * @return bool
      * @throws EntryPointExecutionFailure
      */
-    protected function verifyURL(){
-        $urlVarCount = substr_count($this->_URL,"$");
+    protected function verifyURL() {
+        $urlVarCount = substr_count($this->_URL, "$");
         $optionCount = 0;
-        if (!empty($this->Module)){
+        if (!empty($this->Module)) {
             $optionCount++;
         }
         $optionCount += count($this->Options);
-        if ($urlVarCount!==$optionCount){
-            if (empty($this->Module) && strpos($this->_URL,'$module')){
+        if ($urlVarCount!==$optionCount) {
+            if (empty($this->Module) && strpos($this->_URL, '$module')) {
                 throw new EntryPointException('Module is required for EntryPoint '.get_called_class());
-            }else{
+            }else {
                 throw new EntryPointException('EntryPoint URL ('.$this->_URL.') requires more parameters than passed.');
             }
-        }else{
+        }else {
             return true;
         }
     }
@@ -197,21 +197,21 @@ 
     /**
      * @return bool
      */
-    protected function validateData(){
-        if (empty($this->_REQUIRED_DATA)||count($this->_REQUIRED_DATA)==0){
+    protected function validateData() {
+        if (empty($this->_REQUIRED_DATA) || count($this->_REQUIRED_DATA)==0) {
             return true;
-        }else{
+        }else {
             $errors = array();
-            foreach($this->_REQUIRED_DATA as $property){
-                if (isset($this->Data[$property]) || $this->Data[$property]!==null){
+            foreach ($this->_REQUIRED_DATA as $property) {
+                if (isset($this->Data[$property]) || $this->Data[$property]!==null) {
                     continue;
-                }else{
+                }else {
                     $errors[] = $property;
                 }
             }
-            if (count($errors)>0){
-                throw new EntryPointException('EntryPoint requires specific properties in Request data. Missing the following '.implode($errors,","));
-            }else{
+            if (count($errors)>0) {
+                throw new EntryPointException('EntryPoint requires specific properties in Request data. Missing the following '.implode($errors, ","));
+            }else {
                 return true;
             }
         }

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/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 +35 added lines, -35 removed lines

@@ -28,102 +28,102 @@
 
     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->setAuthOptions($authOptions);
         }
         $this->registerSDKEntryPoints();
     }
 
-    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->setAuthOptions($defaults['auth']);
             }
         }
     }
 
-    public function setAuthOptions(array $options){
-        foreach($this->authOptions as $key => $value){
-            if (isset($options[$key])){
+    public function setAuthOptions(array $options) {
+        foreach ($this->authOptions as $key => $value) {
+            if (isset($options[$key])) {
                 $this->authOptions[$key] = $options[$key];
             }
         }
     }
 
-    protected function registerSDKEntryPoints(){
-        require __DIR__ .DIRECTORY_SEPARATOR.'EntryPoint' .DIRECTORY_SEPARATOR.'registry.php';
-        foreach($entryPoints as $funcName => $className){
+    protected function registerSDKEntryPoints() {
+        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){
-        if (isset($this->entryPoints[$funcName])){
+    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 ($EntryPoint->authRequired()) {
                 if (isset($this->authToken)) {
                     $EntryPoint->getRequest()->addHeader('OAuth-Token', $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');
         }
     }
-    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 AuthenticationException("Username or Password was not provided.");
         }
         $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 AuthenticationException($response->getBody());
         }
     }
-    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;
     }
-    public function getAuthOptions(){
+    public function getAuthOptions() {
         return $this->authOptions;
     }
 }
\ No newline at end of file

Braces +3 added lines, -3 removed lines

@@ -83,12 +83,12 @@ 
             if ($EntryPoint->authRequired()){
                 if (isset($this->authToken)) {
                     $EntryPoint->getRequest()->addHeader('OAuth-Token', $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';