Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.
array $_credentials = ''
Array of credentials (username and password) to log into backend server
boolean $_loggedIn = ''
Set to true, when session is logged into backend server
Zend_Soap_Client $_soapClient = ''
SOAP client used to connect to LiveDocx service
string $_wsdl = ''
WSDL of LiveDocx web service
__construct(
array|Zend_Config $options
=
null
)
:
void
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}
__destruct(
)
:
boolean
Clean up and log out of LiveDocx service
_initSoapClient(
string $endpoint
)
:
void
Init Soap client - connect to SOAP service
compareVersion(
string $version
)
:
int
Compare the current API version with another version
getFormat(
string $filename
)
:
string
Return the document format (extension) of a filename
getPassword(
)
:
string|null
Return current password
getSoapClient(
)
:
Zend_Soap_Client
Get SOAP client
getUsername(
)
:
string|null
Return current username
getVersion(
)
:
string
Return the current API version
getWsdl(
)
:
Zend_Service_LiveDocx
Return WSDL of LiveDocx web service
isLoggedIn(
)
:
boolean
Return true, if session is currently logged into the backend server
logIn(
)
:
boolean
Log in to LiveDocx service
logOut(
)
:
boolean
Log out of the LiveDocx service
setOptions(
$options
)
:
Zend_Service_LiveDocx
Set options One or more of username, password, soapClient
setPassword(
$password
)
:
Zend_Service_LiveDocx
Set password
setSoapClient(
Zend_Soap_Client $soapClient
)
:
Zend_Service_LiveDocx
Set SOAP client
setUsername(
$username
)
:
Zend_Service_LiveDocx
Set username
setWsdl(
$wsdl
)
:
Zend_Service_LiveDocx
Set WSDL of LiveDocx web service