Salaros\Vtiger\VTWSCLib\WSClient¶
-
class
WSClient¶ Vtiger Web Services PHP Client
Class WSClient
-
property
modules¶
-
property
entities¶
-
__construct($vtigerUrl, $username, $secret, $loginMode = self::USE_ACCESSKEY, $wsBaseURL = 'webservice.php')¶ Class constructor
Parameters: - $vtigerUrl (string) – The URL of the remote WebServices server
- $username –
- $secret –
- $loginMode –
- $wsBaseURL –
-
invokeOperation($operation, $params = null, $method = 'POST')¶ Invokes custom operation (defined in vtiger_ws_operation table)
Parameters: - $operation –
- $params –
- $method –
Returns: array Result object
-
runQuery($query)¶ VTiger provides a simple query language for fetching data. This language is quite similar to select queries in SQL. There are limitations, the queries work on a single Module, embedded queries are not supported, and does not support joins. But this is still a powerful way of getting data from Vtiger. Query always limits its output to 100 records, Client application can use limit operator to get different records.
Parameters: - $query –
Returns: array Query results
-
getCurrentUser()¶ Gets an array containing the basic information about current API user
Returns: array Basic information about current API user
-
getVtigerInfo()¶ Gets an array containing the basic information about the connected vTiger instance
Returns: array Basic information about the connected vTiger instance
-
property