salaros / vtwsclib-php

src/Entities.php

Doc Comments +3 added lines, -2 removed lines

@@ -244,6 +244,7 @@ 
      * @access public
      * @static
      * @param  array    $params  Array holding entity data/search constraints
+     * @param string $paramsPurpose
      * @return boolean  Returns true if params holds valid entity data/search constraints, otherwise returns false
      */
     private static function checkParams(array $params, $paramsPurpose)
@@ -263,8 +264,8 @@ 
      * @static
      * @param  string   $moduleName  The name of the module / entity type
      * @param  array    $params  Data used to find matching entries
-     * @return array    $select  The list of fields to select (defaults to SQL-like '*' - all the fields)
-     * @return int      $limit  limit the list of entries to N records (acts like LIMIT in SQL)
+     * @return string    $select  The list of fields to select (defaults to SQL-like '*' - all the fields)
+     * @return string      $limit  limit the list of entries to N records (acts like LIMIT in SQL)
      * @return string   The query build out of the supplied parameters
      */
     public static function getQueryString($moduleName, array $params, array $select = [], $limit = 0)

Unused Use Statements -1 removed lines

@@ -32,7 +32,6 @@
 namespace Salaros\Vtiger\VTWSCLib;
 
 use Salaros\Vtiger\VTWSCLib\WSClient;
-use Salaros\Vtiger\VTWSCLib\EntityUtils;
 
 /**
 * Vtiger Web Services PHP Client Session class

Indentation +6 added lines, -6 removed lines

@@ -240,12 +240,12 @@
     }
 
         /**
-     * Checks if if params holds valid entity data/search constraints, otherwise returns false
-     * @access public
-     * @static
-     * @param  array    $params  Array holding entity data/search constraints
-     * @return boolean  Returns true if params holds valid entity data/search constraints, otherwise returns false
-     */
+         * Checks if if params holds valid entity data/search constraints, otherwise returns false
+         * @access public
+         * @static
+         * @param  array    $params  Array holding entity data/search constraints
+         * @return boolean  Returns true if params holds valid entity data/search constraints, otherwise returns false
+         */
     private static function checkParams(array $params, $paramsPurpose)
     {
         if (empty($params) || !is_array($params) || !is_assoc_array($params)) {

Spacing +18 added lines, -18 removed lines

@@ -60,7 +60,7 @@ 
      * @return array   $select  The list of fields to select (defaults to SQL-like '*' - all the fields)
      * @return boolean  Entity data
      */
-    public function findOneByID($moduleName, $entityID, array $select = [])
+    public function findOneByID($moduleName, $entityID, array $select = [ ])
     {
         return $this->findOne($moduleName, [ 'id' => $entityID ], $select);
     }
@@ -72,13 +72,13 @@ 
      * @return array   $select  The list of fields to select (defaults to SQL-like '*' - all the fields)
      * @return integer  The matching record
      */
-    public function findOne($moduleName, array $params, array $select = [])
+    public function findOne($moduleName, array $params, array $select = [ ])
     {
         $records = $this->findMany($moduleName, $params, $select, 1);
-        if (false === $records || !isset($records[0])) {
+        if (false === $records || !isset($records[ 0 ])) {
             return false;
         }
-        return $records[0];
+        return $records[ 0 ];
     }
 
     /**
@@ -89,11 +89,11 @@ 
      */
     public function getID($moduleName, array $params)
     {
-        $record = $this->findOne($moduleName, $params, ['id']);
-        if (false === $record || !isset($record['id']) || empty($record['id'])) {
+        $record = $this->findOne($moduleName, $params, [ 'id' ]);
+        if (false === $record || !isset($record[ 'id' ]) || empty($record[ 'id' ])) {
             return false;
         }
-        return $record['id'];
+        return $record[ 'id' ];
     }
 
     /**
@@ -107,7 +107,7 @@ 
         $entityID = $this->getID($moduleName, $params);
         $entityIDParts = explode('x', $entityID, 2);
         return (is_array($entityIDParts) && count($entityIDParts) === 2)
-            ? intval($entityIDParts[1])
+            ? intval($entityIDParts[ 1 ])
             : -1;
     }
 
@@ -124,8 +124,8 @@ 
         }
 
         // Assign record to logged in user if not specified
-        if (!isset($params['assigned_user_id'])) {
-            $params['assigned_user_id'] = $this->userID;
+        if (!isset($params[ 'assigned_user_id' ])) {
+            $params[ 'assigned_user_id' ] = $this->userID;
         }
 
         $requestData = [
@@ -198,7 +198,7 @@ 
      * @return integer      $limit  limit the list of entries to N records (acts like LIMIT in SQL)
      * @return bool|array  The array containing matching entries or false if nothing was found
      */
-    public function findMany($moduleName, array $params, array $select = [], $limit = 0)
+    public function findMany($moduleName, array $params, array $select = [ ], $limit = 0)
     {
         if (!self::checkParams($params, 'be able to retrieve entity(ies)')) {
             return false;
@@ -233,7 +233,7 @@ 
         ];
 
         if (!empty($moduleName)) {
-            $requestData['elementType'] = $moduleName;
+            $requestData[ 'elementType' ] = $moduleName;
         }
 
         return $this->wsClient->invokeOperation('sync', $requestData, true);
@@ -267,18 +267,18 @@ 
      * @return int      $limit  limit the list of entries to N records (acts like LIMIT in SQL)
      * @return string   The query build out of the supplied parameters
      */
-    public static function getQueryString($moduleName, array $params, array $select = [], $limit = 0)
+    public static function getQueryString($moduleName, array $params, array $select = [ ], $limit = 0)
     {
         $criteria = array();
-        $select=(empty($select)) ? '*' : implode(',', $select);
-        $query=sprintf("SELECT %s FROM $moduleName WHERE ", $select);
+        $select = (empty($select)) ? '*' : implode(',', $select);
+        $query = sprintf("SELECT %s FROM $moduleName WHERE ", $select);
         foreach ($params as $param => $value) {
-            $criteria[] = "{$param} LIKE '{$value}'";
+            $criteria[ ] = "{$param} LIKE '{$value}'";
         }
 
-        $query.=implode(" AND ", $criteria);
+        $query .= implode(" AND ", $criteria);
         if (intval($limit) > 0) {
-            $query.=sprintf(" LIMIT %s", intval($limit));
+            $query .= sprintf(" LIMIT %s", intval($limit));
         }
         return $query;
     }

src/Session.php

Doc Comments +2 added lines, -1 removed lines

@@ -172,7 +172,7 @@ 
      * Gets a challenge token from the server and stores for future requests
      * @access private
      * @param  string $username VTiger user name
-     * @return booleanReturns false in case of failure
+     * @return boolean false in case of failure
      */
     private function passChallenge($username)
     {
@@ -246,6 +246,7 @@ 
      * @access private
      * @static
      * @param  string  Base URL of vTiger CRM
+     * @param string $baseUrl
      * @return boolean Returns cleaned and fixed vTiger URL
      */
     private static function fixVtigerBaseUrl($baseUrl)

Spacing +24 added lines, -24 removed lines

@@ -100,7 +100,7 @@ 
         $postdata = [
             'operation' => 'login',
             'username'  => $username,
-            'accessKey' => md5($this->serviceToken . $accessKey)
+            'accessKey' => md5($this->serviceToken.$accessKey)
         ];
 
         $result = $this->sendHttpRequest($postdata);
@@ -113,12 +113,12 @@ 
         $this->accessKey = $accessKey;
 
         // Session data
-        $this->sessionName = $result['sessionName'];
-        $this->userID = $result['userId'];
+        $this->sessionName = $result[ 'sessionName' ];
+        $this->userID = $result[ 'userId' ];
 
         // Vtiger CRM and WebServices API version
-        $this->apiVersion = $result['version'];
-        $this->vtigerVersion = $result['vtigerVersion'];
+        $this->apiVersion = $result[ 'version' ];
+        $this->vtigerVersion = $result[ 'vtigerVersion' ];
 
         return true;
     }
@@ -150,8 +150,8 @@ 
         }
 
         $this->accessKey = array_key_exists('accesskey', $result)
-            ? $result['accesskey']
-            : $result[0];
+            ? $result[ 'accesskey' ]
+            : $result[ 0 ];
 
         return $this->login($username, $accessKey);
     }
@@ -182,13 +182,13 @@ 
         ];
         $result = $this->sendHttpRequest($getdata, 'GET');
         
-        if (!is_array($result) || !isset($result['token'])) {
+        if (!is_array($result) || !isset($result[ 'token' ])) {
             return false;
         }
 
-        $this->serviceServerTime = $result['serverTime'];
-        $this->serviceExpireTime = $result['expireTime'];
-        $this->serviceToken = $result['token'];
+        $this->serviceServerTime = $result[ 'serverTime' ];
+        $this->serviceExpireTime = $result[ 'expireTime' ];
+        $this->serviceToken = $result[ 'token' ];
 
         return true;
     }
@@ -202,30 +202,30 @@ 
      */
     public function sendHttpRequest(array $requestData, $method = 'POST')
     {
-        if (!isset($requestData['operation'])) {
+        if (!isset($requestData[ 'operation' ])) {
             throw new WSException('Request data must contain the name of the operation!');
         }
 
-        $requestData['sessionName'] = $this->sessionName;
+        $requestData[ 'sessionName' ] = $this->sessionName;
 
         // Perform re-login if required.
-        if ('getchallenge' !== $requestData['operation'] && time() > $this->serviceExpireTime) {
+        if ('getchallenge' !== $requestData[ 'operation' ] && time() > $this->serviceExpireTime) {
             $this->login($this->userName, $this->accessKey);
         }
         
         try {
             switch ($method) {
                 case 'GET':
-                    $response = $this->httpClient->get($this->serviceBaseURL, ['query' => $requestData]);
+                    $response = $this->httpClient->get($this->serviceBaseURL, [ 'query' => $requestData ]);
                     break;
                 case 'POST':
-                    $response = $this->httpClient->post($this->serviceBaseURL, ['form_params' => $requestData]);
+                    $response = $this->httpClient->post($this->serviceBaseURL, [ 'form_params' => $requestData ]);
                     break;
                 default:
                     throw new WSException("Unsupported request type {$method}");
             }
         } catch (RequestException $ex) {
-            $urlFailed = $this->httpClient->getConfig('base_uri') . $this->serviceBaseURL;
+            $urlFailed = $this->httpClient->getConfig('base_uri').$this->serviceBaseURL;
             throw new WSException(
                 sprintf('Failed to execute %s call on "%s" URL', $method, $urlFailed),
                 'FAILED_SENDING_REQUEST',
@@ -238,7 +238,7 @@ 
 
         return (!is_array($jsonObj) || self::checkForError($jsonObj))
             ? null
-            : $jsonObj['result'];
+            : $jsonObj[ 'result' ];
     }
 
     /**
@@ -253,7 +253,7 @@ 
         if (!preg_match('/^https?:\/\//i', $baseUrl)) {
             $baseUrl = sprintf('http://%s', $baseUrl);
         }
-        if (strripos($baseUrl, '/') !== strlen($baseUrl)-1) {
+        if (strripos($baseUrl, '/') !== strlen($baseUrl) - 1) {
             $baseUrl .= '/';
         }
         return $baseUrl;
@@ -268,15 +268,15 @@ 
      */
     private static function checkForError(array $jsonResult)
     {
-        if (isset($jsonResult['success']) && (bool)$jsonResult['success'] === true) {
+        if (isset($jsonResult[ 'success' ]) && (bool) $jsonResult[ 'success' ] === true) {
             return false;
         }
 
-        if (isset($jsonResult['error'])) {
-            $error = $jsonResult['error'];
+        if (isset($jsonResult[ 'error' ])) {
+            $error = $jsonResult[ 'error' ];
             throw new WSException(
-                $error['message'],
-                $error['code']
+                $error[ 'message' ],
+                $error[ 'code' ]
             );
         }
 

src/WSClient.php

Spacing +2 added lines, -2 removed lines

@@ -107,7 +107,7 @@ 
             );
         }
 
-        $params['operation'] = $operation;
+        $params[ 'operation' ] = $operation;
         return $this->session->sendHttpRequest($params, $method);
     }
 
@@ -126,7 +126,7 @@ 
     public function runQuery($query)
     {
         // Make sure the query ends with ;
-        $query = (strripos($query, ';') != strlen($query)-1)
+        $query = (strripos($query, ';') != strlen($query) - 1)
             ? trim($query .= ';')
             : trim($query);
 

src/Modules.php

Spacing +5 added lines, -5 removed lines

@@ -59,12 +59,12 @@ 
      */
     public function getAll()
     {
-        $result = $this->wsClient->invokeOperation('listtypes', [], 'GET');
-        $modules = $result['types'];
+        $result = $this->wsClient->invokeOperation('listtypes', [ ], 'GET');
+        $modules = $result[ 'types' ];
 
         $result = array();
         foreach ($modules as $moduleName) {
-            $result[$moduleName] = ['name' => $moduleName];
+            $result[ $moduleName ] = [ 'name' => $moduleName ];
         }
         return $result;
     }
@@ -89,7 +89,7 @@ 
      */
     public function getTypedID($moduleName, $entityID)
     {
-        if (stripos((string)$entityID, 'x') !== false) {
+        if (stripos((string) $entityID, 'x') !== false) {
             return $entityID;
         }
 
@@ -103,6 +103,6 @@ 
             throw new WSException($errorMessage);
         }
 
-        return "{$type['idPrefix']}x{$entityID}";
+        return "{$type[ 'idPrefix' ]}x{$entityID}";
     }
 }

src/WSException.php

Indentation +10 added lines, -10 removed lines

@@ -62,12 +62,12 @@ 
     }
     
     /**
-    * Retrieve an external iterator
-    *
-    * @link http://php.net/manual/en/iteratoraggregate.getiterator.php
-    * @return \Traversable
-    *  An instance of an object implementing \Traversable
-    */
+     * Retrieve an external iterator
+     *
+     * @link http://php.net/manual/en/iteratoraggregate.getiterator.php
+     * @return \Traversable
+     *  An instance of an object implementing \Traversable
+     */
     public function getIterator()
     {
         $properties = $this->getAllProperties();
@@ -77,10 +77,10 @@ 
     }
     
     /**
-    * Get all the properties of the object
-    *
-    * @return array
-    */
+     * Get all the properties of the object
+     *
+     * @return array
+     */
     private function getAllProperties()
     {
         $allProperties = get_object_vars($this);

Spacing +2 added lines, -2 removed lines

@@ -58,7 +58,7 @@ 
     // custom string representation of object
     public function __toString()
     {
-        return __CLASS__ . ": [{$this->code}]: {$this->message}\n";
+        return __CLASS__.": [{$this->code}]: {$this->message}\n";
     }
     
     /**
@@ -90,7 +90,7 @@ 
             $fullNameComponents = explode("\0", $fullName);
             $propertyName = array_pop($fullNameComponents);
             if ($propertyName && isset($value)) {
-                $properties[$propertyName] = $value;
+                $properties[ $propertyName ] = $value;
             }
         }