Inheritance diagram for Zend_Service_LiveDocx:

Public Member Functions
	__construct ($options=null)
	setOptions (array $options)
	__destruct ()
	getSoapClient ()
	setSoapClient (Zend_Soap_Client $soapClient)
	logIn ()
	logOut ()
	isLoggedIn ()
	setUsername ($username)
	setPassword ($password)
	setWsdl ($wsdl)
	getUsername ()
	getPassword ()
	getWsdl ()
	getFormat ($filename)
	getVersion ()
	compareVersion ($version)
Data Fields
const	VERSION = '1.2'
Protected Member Functions
	_initSoapClient ($endpoint)
Protected Attributes
	$_soapClient
	$_wsdl
	$_credentials
	$_loggedIn

Detailed Description

Definition at line 31 of file LiveDocx.php.

Constructor & Destructor Documentation

__construct ( $ options = null )

Constructor

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}

Parameters:

array | Zend_Config $options

Returns:: void

Exceptions:

Zend_Service_LiveDocx_Exception

Since:: LiveDocx 1.0

Reimplemented in Zend_Service_LiveDocx_MailMerge.

Definition at line 132 of file LiveDocx.php.

Here is the call graph for this function:

__destruct ( )

Clean up and log out of LiveDocx service

Returns:: boolean

Since:: LiveDocx 1.0

Definition at line 172 of file LiveDocx.php.

Here is the call graph for this function:

Member Function Documentation

_initSoapClient ( $ endpoint ) [protected]

Init Soap client - connect to SOAP service

Parameters:

string $endpoint

Exceptions:

Zend_Service_LiveDocx_Exception

Returns:: void

Since:: LiveDocx 1.2

Definition at line 185 of file LiveDocx.php.

Here is the caller graph for this function:

compareVersion ( $ version )

Compare the current API version with another version

Parameters:

string $version (STRING NOT FLOAT)

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

Since:: LiveDocx 1.0

Definition at line 411 of file LiveDocx.php.

Here is the call graph for this function:

getFormat ( $ filename )

Return the document format (extension) of a filename

Parameters:

string $filename

Returns:: string

Since:: LiveDocx 1.0

Definition at line 388 of file LiveDocx.php.

getPassword ( )

Return current password

Returns:: string|null

Since:: LiveDocx 1.0

Definition at line 361 of file LiveDocx.php.

Here is the caller graph for this function:

getSoapClient ( )

Get SOAP client

Returns:: Zend_Soap_Client

Since:: LiveDocx 1.2

Definition at line 203 of file LiveDocx.php.

Here is the caller graph for this function:

getUsername ( )

Return current username

Returns:: string|null

Since:: LiveDocx 1.0

Definition at line 346 of file LiveDocx.php.

Here is the caller graph for this function:

getVersion ( )

Return the current API version

Returns:: string

Since:: LiveDocx 1.0

Definition at line 399 of file LiveDocx.php.

Here is the caller graph for this function:

getWsdl ( )

Return WSDL of LiveDocx web service

Returns:: Zend_Service_LiveDocx

Since:: LiveDocx 1.0

Definition at line 376 of file LiveDocx.php.

isLoggedIn ( )

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

Returns:: boolean

Since:: LiveDocx 1.2

Definition at line 299 of file LiveDocx.php.

Here is the caller graph for this function:

logIn ( )

Log in to LiveDocx service

Parameters:

string	$username
string	$password

Exceptions:

Zend_Service_LiveDocx_Exception

Returns:: boolean

Since:: LiveDocx 1.2

Definition at line 231 of file LiveDocx.php.

Here is the call graph for this function:

Here is the caller graph for this function:

logOut ( )

Log out of the LiveDocx service

Exceptions:

Zend_Service_LiveDocx_Exception

Returns:: boolean

Since:: LiveDocx 1.2

Definition at line 276 of file LiveDocx.php.

Here is the call graph for this function:

Here is the caller graph for this function:

setOptions ( array $ options )

Set options One or more of username, password, soapClient

Parameters:

$options

Returns:: Zend_Service_LiveDocx

Since:: LiveDocx 1.2

Definition at line 154 of file LiveDocx.php.

Here is the caller graph for this function:

setPassword ( $ password )

Set password

Returns:: Zend_Service_LiveDocx

Since:: LiveDocx 1.0

Definition at line 322 of file LiveDocx.php.

setSoapClient ( Zend_Soap_Client $ soapClient )

Set SOAP client

Parameters:

Zend_Soap_Client $soapClient

Returns:: Zend_Service_LiveDocx

Since:: LiveDocx 1.2

Definition at line 215 of file LiveDocx.php.

setUsername ( $ username )

Set username

Returns:: Zend_Service_LiveDocx

Since:: LiveDocx 1.0

Definition at line 310 of file LiveDocx.php.

setWsdl ( $ wsdl )

Set WSDL of LiveDocx web service

Returns:: Zend_Service_LiveDocx

Since:: LiveDocx 1.0

Definition at line 334 of file LiveDocx.php.

Field Documentation

$_credentials [protected]

Definition at line 58 of file LiveDocx.php.

$_loggedIn [protected]

Definition at line 65 of file LiveDocx.php.

$_soapClient [protected]

Definition at line 44 of file LiveDocx.php.

$_wsdl [protected]

Definition at line 51 of file LiveDocx.php.

const VERSION = '1.2'

LiveDocx service version

Since:: LiveDocx 1.0

Definition at line 37 of file LiveDocx.php.

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

C:/xampp/htdocs/moodle/lib/zend/Zend/Service/LiveDocx.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation