salaros / vtwsclib-php

src/WSClient.php

Doc Comments +4 added lines, -3 removed lines

@@ -162,7 +162,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)
     {
@@ -625,8 +625,8 @@ 
      * Builds the query using the supplied parameters
      * @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
      */
     private function buildQuery($moduleName, array $params, array $select = [], $limit = 0)
@@ -648,6 +648,7 @@ 
     /**
      * Checks if if params holds valid entity data/search constraints, otherwise returns false
      * @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 function checkParams(array $params, $paramsPurpose)

Spacing +43 added lines, -43 removed lines

@@ -78,7 +78,7 @@ 
         if (!preg_match('/^https?:\/\//i', $url)) {
             $url = sprintf('http://%s', $url);
         }
-        if (strripos($url, '/') != (strlen($url)-1)) {
+        if (strripos($url, '/') != (strlen($url) - 1)) {
             $url .= '/';
         }
 
@@ -96,14 +96,14 @@ 
      */
     private function checkForError(array $jsonResult)
     {
-        if (isset($jsonResult['success']) && (bool)$jsonResult['success'] === true) {
+        if (isset($jsonResult[ 'success' ]) && (bool) $jsonResult[ 'success' ] === true) {
             $this->lastErrorMessage = null;
             return false;
         }
 
         $this->lastErrorMessage = new WSClientError(
-            $jsonResult['error']['message'],
-            $jsonResult['error']['code']
+            $jsonResult[ 'error' ][ 'message' ],
+            $jsonResult[ 'error' ][ 'code' ]
         );
 
         return true;
@@ -133,10 +133,10 @@ 
         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:
                     $this->lastErrorMessage = new WSClientError("Unknown request type {$method}");
@@ -155,7 +155,7 @@ 
 
         return (!is_array($jsonObj) || $this->checkForError($jsonObj))
             ? null
-            : $jsonObj['result'];
+            : $jsonObj[ 'result' ];
     }
 
     /**
@@ -172,13 +172,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;
     }
@@ -213,12 +213,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;
     }
@@ -250,8 +250,8 @@ 
         }
 
         $accessKey = array_key_exists('accesskey', $result)
-            ? $result['accesskey']
-            : $result[0];
+            ? $result[ 'accesskey' ]
+            : $result[ 0 ];
 
         return $this->login($username, $accessKey);
     }
@@ -293,11 +293,11 @@ 
         ];
 
         $result = $this->sendHttpRequest($getdata, 'GET');
-        $modules = $result['types'];
+        $modules = $result[ 'types' ];
 
         $result = array();
         foreach ($modules as $moduleName) {
-            $result[$moduleName] = ['name' => $moduleName];
+            $result[ $moduleName ] = [ 'name' => $moduleName ];
         }
         return $result;
     }
@@ -331,7 +331,7 @@ 
      */
     private function getTypedID($moduleName, $entityID)
     {
-        if (stripos((string)$entityID, 'x') !== false) {
+        if (stripos((string) $entityID, 'x') !== false) {
             return $entityID;
         }
 
@@ -346,7 +346,7 @@ 
             return false;
         }
 
-        return "{$type['idPrefix']}x{$entityID}";
+        return "{$type[ 'idPrefix' ]}x{$entityID}";
     }
 
     /**
@@ -400,7 +400,7 @@ 
         $this->checkLogin();
 
         // Make sure the query ends with ;
-        $query = (strripos($query, ';') != strlen($query)-1)
+        $query = (strripos($query, ';') != strlen($query) - 1)
             ? trim($query .= ';')
             : trim($query);
 
@@ -443,13 +443,13 @@ 
      * @return array   $select  The list of fields to select (defaults to SQL-like '*' - all the fields)
      * @return int  The matching record
      */
-    public function entityRetrieve($moduleName, array $params, array $select = [])
+    public function entityRetrieve($moduleName, array $params, array $select = [ ])
     {
         $records = $this->entitiesRetrieve($moduleName, $params, $select, 1);
-        if (false === $records || !isset($records[0])) {
+        if (false === $records || !isset($records[ 0 ])) {
             return false;
         }
-        return $records[0];
+        return $records[ 0 ];
     }
 
     /**
@@ -460,15 +460,15 @@ 
      */
     public function entityRetrieveTypeID($moduleName, array $params)
     {
-        $records = $this->entitiesRetrieve($moduleName, $params, ['id'], 1);
-        if (false === $records || !isset($records[0]['id']) || empty($records[0]['id'])) {
+        $records = $this->entitiesRetrieve($moduleName, $params, [ 'id' ], 1);
+        if (false === $records || !isset($records[ 0 ][ 'id' ]) || empty($records[ 0 ][ 'id' ])) {
             return false;
         }
 
-        $entityID = $records[0]['id'];
+        $entityID = $records[ 0 ][ 'id' ];
         $entityIDParts = explode('x', $entityID, 2);
         return (is_array($entityIDParts) && count($entityIDParts) === 2)
-            ? $entityIDParts[1]
+            ? $entityIDParts[ 1 ]
             : -1;
     }
 
@@ -483,7 +483,7 @@ 
         $entityID = $this->entityRetrieveTypeID($moduleName, $params);
         $entityIDParts = explode('x', $entityID, 2);
         return (is_array($entityIDParts) && count($entityIDParts) === 2)
-            ? $entityIDParts[1]
+            ? $entityIDParts[ 1 ]
             : -1;
     }
 
@@ -503,8 +503,8 @@ 
         $this->checkLogin();
 
         // 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;
         }
 
         $postdata = [
@@ -530,7 +530,7 @@ 
         }
 
         // Fail if no ID was supplied
-        if (!array_key_exists('id', $params) || empty($params['id'])) {
+        if (!array_key_exists('id', $params) || empty($params[ 'id' ])) {
             $this->lastErrorMessage = new WSClientError(
                 "The list of contraints must contain a valid ID"
             );
@@ -541,10 +541,10 @@ 
         $this->checkLogin();
 
         // Preprend so-called moduleid if needed
-        $params['id'] = $this->getTypedID($moduleName, $params['id']);
+        $params[ 'id' ] = $this->getTypedID($moduleName, $params[ 'id' ]);
 
         // Check if the entity exists + retrieve its data so it can be used below
-        $entityData = $this->entityRetrieve($moduleName, [ 'id' => $params['id'] ]);
+        $entityData = $this->entityRetrieve($moduleName, [ 'id' => $params[ 'id' ] ]);
         if ($entityData === false && !is_array($entityData)) {
             $this->lastErrorMessage = new WSClientError("Such entity doesn't exist, so it cannot be updated");
             return false;
@@ -598,7 +598,7 @@ 
      * @return int      $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 entitiesRetrieve($moduleName, array $params, array $select = [], $limit = 0)
+    public function entitiesRetrieve($moduleName, array $params, array $select = [ ], $limit = 0)
     {
         if (!$this->checkParams($params, 'be able to retrieve entity(ies)')) {
             return false;
@@ -641,7 +641,7 @@ 
         ];
 
         if (!empty($moduleName)) {
-            $requestData['elementType'] = $moduleName;
+            $requestData[ 'elementType' ] = $moduleName;
         }
 
         return $this->sendHttpRequest($requestData, true);
@@ -655,18 +655,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
      */
-    private function buildQuery($moduleName, array $params, array $select = [], $limit = 0)
+    private function buildQuery($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;
     }