FreenetIS
 All Classes Namespaces Functions Variables Pages
Public Member Functions | Public Attributes | List of all members
Vtiger_WSClient Class Reference

Vtiger Webservice Client. More...

Public Member Functions

 __construct ($url)
 Constructor.
 __destruct ()
 Destructor.
 version ()
 Return the client library version.
 reinitalize ()
 Reinitialize the client.
 getWebServiceURL ($url)
 Get the URL for sending webservice request.
 getRecordId ($id)
 Get actual record id from the response id.
 hasError ($result)
 Check if result has any error.
 lastError ()
 Get last operation error.
 __doChallenge ($username)
 Perform the challenge private.
 __checkLogin ()
 Check and perform login if requried.
 __doLogout ()
 Do Logout Operation private.
 toJSON ($input)
 JSONify input data.
 toJSONString ($input)
 Convert input data to JSON String.
 doLogin ($username, $vtigerUserAccesskey)
 Do Login Operation.
 doQuery ($query)
 Do Query Operation.
 doQueryNotLimited ($query)
 Do Query Operation - returns more than 100 results.
 getResultColumns ($result)
 Get Result Column Names.
 doListTypes ()
 List types available Modules.
 doDescribe ($module)
 Describe Module Fields.
 doRetrieve ($record)
 Retrieve details of record.
 doCreate ($module, $valuemap)
 Do Create Operation.
 doCreateBulk ($module, $valuemaps)
 Do CreateBulk Operation.
 doUpdate ($valuemap)
 Do Update Operation.
 doUpdateBulk ($module, $valuemaps)
 Do UpdateBulk Operation.
 doDelete ($id)
 Do Delete Operation.
 doInvoke ($method, $params=null, $type= 'POST')
 Invoke custom operation.

Public Attributes

 $_servicebase = 'webservice.php'
 $_client = false
 $_serviceurl = false
 $_serviceuser = false
 $_servicekey = false
 $_servertime = false
 $_expiretime = false
 $_servicetoken = false
 $_sessionid = false
 $_userid = false
 $_lasterror = false

Detailed Description

Vtiger Webservice Client.

Member Function Documentation

Vtiger_WSClient::doInvoke (   $method,
  $params = null,
  $type = 'POST' 
)

Invoke custom operation.

Parameters
String$methodName of the webservice to invoke
Object$typenull or parameter values to method
String$paramsoptional (POST/GET)

The documentation for this class was generated from the following file: