|
Zend Framework
1.12
|
Public Member Functions | |
| __construct ($options=null) | |
| Constructor. | |
| setOptions (array $options) | |
| Set options One or more of username, password, soapClient. | |
| __destruct () | |
| Clean up and log out of LiveDocx service. | |
| getSoapClient () | |
| Get SOAP client. | |
| setSoapClient (Zend_Soap_Client $soapClient) | |
| Set SOAP client. | |
| logIn () | |
| Log in to LiveDocx service. | |
| logOut () | |
| Log out of the LiveDocx service. | |
| isLoggedIn () | |
| Return true, if session is currently logged into the backend server. | |
| setUsername ($username) | |
| Set username. | |
| setPassword ($password) | |
| Set password. | |
| setWsdl ($wsdl) | |
| Set WSDL of LiveDocx web service. | |
| getUsername () | |
| Return current username. | |
| getPassword () | |
| Return current password. | |
| getWsdl () | |
| Return WSDL of LiveDocx web service. | |
| getFormat ($filename) | |
| Return the document format (extension) of a filename. | |
| getVersion () | |
| Return the current API version. | |
| compareVersion ($version) | |
| Compare the current API version with another version. | |
Public Attributes | |
| const | VERSION = '2.0' |
| LiveDocx service version. | |
Protected Member Functions | |
| _initSoapClient ($endpoint) | |
| Init Soap client - connect to SOAP service. | |
Protected Attributes | |
| $_soapClient | |
| $_wsdl | |
| $_credentials | |
| $_loggedIn | |
| __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}
| array | Zend_Config | $options |
| Zend_Service_LiveDocx_Exception |
| __destruct | ( | ) |
Clean up and log out of LiveDocx service.
|
protected |
Init Soap client - connect to SOAP service.
| string | $endpoint |
| Zend_Service_LiveDocx_Exception |
| compareVersion | ( | $version | ) |
Compare the current API version with another version.
| string | $version | (STRING NOT FLOAT) |
| getFormat | ( | $filename | ) |
Return the document format (extension) of a filename.
| string | $filename |
| getPassword | ( | ) |
Return current password.
| getSoapClient | ( | ) |
| getUsername | ( | ) |
Return current username.
| getVersion | ( | ) |
Return the current API version.
| getWsdl | ( | ) |
| isLoggedIn | ( | ) |
Return true, if session is currently logged into the backend server.
| logIn | ( | ) |
Log in to LiveDocx service.
| string | $username | |
| string | $password |
| Zend_Service_LiveDocx_Exception |
| logOut | ( | ) |
Log out of the LiveDocx service.
| Zend_Service_LiveDocx_Exception |
| setOptions | ( | array | $options | ) |
Set options One or more of username, password, soapClient.
| array | $options |
| setPassword | ( | $password | ) |
| setSoapClient | ( | Zend_Soap_Client | $soapClient | ) |
Set SOAP client.
| Zend_Soap_Client | $soapClient |
| setUsername | ( | $username | ) |
| setWsdl | ( | $wsdl | ) |
|
protected |
|
protected |
|
protected |
|
protected |
| const VERSION = '2.0' |
LiveDocx service version.
1.8.3