category Zend
package Zend_Service
subpackage LiveDocx
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License
since LiveDocx 1.0

 Methods

Constructor

__construct(array|\Zend_Config $options = null

Optionally, pass an array of options (or Zend_Config object).

If an option with the key 'soapClient' is provided, that value will be used to set the internal SOAP client used to connect to the LiveDocx service.

Use 'soapClient' in the case that you have a dedicated or (locally installed) licensed LiveDocx server. For example:

{code} $phpLiveDocx = new Zend_Service_LiveDocx_MailMerge( array ( 'username' => 'myUsername', 'password' => 'myPassword', 'soapClient' => new Zend_Soap_Client('https://api.example.com/path/mailmerge.asmx?WSDL') ) ); {code}

Replace the URI of the WSDL in the constructor of Zend_Soap_Client with that of your dedicated or licensed LiveDocx server.

If you are using the public LiveDocx server, simply pass 'username' and 'password'. For example:

{code} $phpLiveDocx = new Zend_Service_LiveDocx_MailMerge( array ( 'username' => 'myUsername', 'password' => 'myPassword' ) ); {code}

If you prefer to not pass the username and password through the constructor, you can also call the following methods:

{code} $phpLiveDocx = new Zend_Service_LiveDocx_MailMerge();

$phpLiveDocx->setUsername('myUsername') ->setPassword('myPassword'); {/code}

Or, if you want to specify your own SoapClient:

{code} $phpLiveDocx = new Zend_Service_LiveDocx_MailMerge();

$phpLiveDocx->setUsername('myUsername') ->setPassword('myPassword');

$phpLiveDocx->setSoapClient( new Zend_Soap_Client('https://api.example.com/path/mailmerge.asmx?WSDL') ); {/code}

since LiveDocx 1.0

Parameters

$options

array\Zend_Config

Exceptions

\Zend_Service_LiveDocx_Exception

Clean up and log out of LiveDocx service

__destruct() : boolean
since LiveDocx 1.0

Returns

boolean

Compare the current API version with another version

compareVersion(string $version) : integer
since LiveDocx 1.0

Parameters

$version

string

(STRING NOT FLOAT)

Returns

integer-1 (version is less than API version), 0 (versions are equal), or 1 (version is greater than API version)

Return the document format (extension) of a filename

getFormat(string $filename) : string
since LiveDocx 1.0

Parameters

$filename

string

Returns

string

Return current password

getPassword() : string | null
since LiveDocx 1.0

Returns

stringnull

Get SOAP client

getSoapClient() : \Zend_Soap_Client
since LiveDocx 1.2

Returns

\Zend_Soap_Client

Return current username

getUsername() : string | null
since LiveDocx 1.0

Returns

stringnull

Return the current API version

getVersion() : string
since LiveDocx 1.0

Returns

string

Return WSDL of LiveDocx web service

getWsdl() : string
since LiveDocx 1.0

Returns

string

Return true, if session is currently logged into the backend server

isLoggedIn() : boolean
since LiveDocx 1.2

Returns

boolean

Log out of the LiveDocx service

logOut() : boolean
since LiveDocx 1.2

Exceptions

\Zend_Service_LiveDocx_Exception

Returns

boolean

Set options One or more of username, password, soapClient

setOptions(array $options) : \Zend_Service_LiveDocx
since LiveDocx 1.2

Parameters

$options

array

Returns

\Zend_Service_LiveDocx

Set password

setPassword(string $password) : \Zend_Service_LiveDocx
since LiveDocx 1.0

Parameters

$password

string

Returns

\Zend_Service_LiveDocx

Set SOAP client

setSoapClient(\Zend_Soap_Client $soapClient) : \Zend_Service_LiveDocx
since LiveDocx 1.2

Parameters

$soapClient

\Zend_Soap_Client

Returns

\Zend_Service_LiveDocx

Set username

setUsername(string $username) : \Zend_Service_LiveDocx
since LiveDocx 1.0

Parameters

$username

string

Returns

\Zend_Service_LiveDocx

Set WSDL of LiveDocx web service

setWsdl(string $wsdl) : \Zend_Service_LiveDocx
since LiveDocx 1.0

Parameters

$wsdl

string

Returns

\Zend_Service_LiveDocx

Init Soap client - connect to SOAP service

_initSoapClient(string $endpoint) : void
since LiveDocx 1.2

Parameters

$endpoint

string

Exceptions

\Zend_Service_LiveDocx_Exception

 Properties

 

Array of credentials (username and password) to log into backend server

$_credentials : array

Default

since LiveDocx 1.2
 

Set to true, when session is logged into backend server

$_loggedIn : boolean

Default

since LiveDocx 1.2
 

SOAP client used to connect to LiveDocx service

$_soapClient : \Zend_Soap_Client

Default

since LiveDocx 1.0
 

WSDL of LiveDocx web service

$_wsdl : string

Default

since LiveDocx 1.0

 Constants

 

LiveDocx service version

VERSION = '2.0' 
since LiveDocx 1.0