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 |
__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 |
---|
array
\Zend_Config
\Zend_Service_LiveDocx_Exception |
---|
__destruct() : boolean
since | LiveDocx 1.0 |
---|
boolean
compareVersion(string $version) : integer
since | LiveDocx 1.0 |
---|
string
(STRING NOT FLOAT)
integer
-1 (version is less than API version), 0 (versions are equal), or 1 (version is greater than API version)getFormat(string $filename) : string
since | LiveDocx 1.0 |
---|
string
string
getPassword() : string | null
since | LiveDocx 1.0 |
---|
string
null
getSoapClient() : \Zend_Soap_Client
since | LiveDocx 1.2 |
---|
\Zend_Soap_Client
getUsername() : string | null
since | LiveDocx 1.0 |
---|
string
null
getVersion() : string
since | LiveDocx 1.0 |
---|
string
getWsdl() : string
since | LiveDocx 1.0 |
---|
string
isLoggedIn() : boolean
since | LiveDocx 1.2 |
---|
boolean
logIn() : boolean
since | LiveDocx 1.2 |
---|
\Zend_Service_LiveDocx_Exception |
---|
boolean
logOut() : boolean
since | LiveDocx 1.2 |
---|
\Zend_Service_LiveDocx_Exception |
---|
boolean
setOptions(array $options) : \Zend_Service_LiveDocx
since | LiveDocx 1.2 |
---|
array
\Zend_Service_LiveDocx
setPassword(string $password) : \Zend_Service_LiveDocx
since | LiveDocx 1.0 |
---|
string
\Zend_Service_LiveDocx
setSoapClient(\Zend_Soap_Client $soapClient) : \Zend_Service_LiveDocx
since | LiveDocx 1.2 |
---|
\Zend_Soap_Client
\Zend_Service_LiveDocx
setUsername(string $username) : \Zend_Service_LiveDocx
since | LiveDocx 1.0 |
---|
string
\Zend_Service_LiveDocx
setWsdl(string $wsdl) : \Zend_Service_LiveDocx
since | LiveDocx 1.0 |
---|
string
\Zend_Service_LiveDocx
_initSoapClient(string $endpoint) : void
since | LiveDocx 1.2 |
---|
string
\Zend_Service_LiveDocx_Exception |
---|
$_credentials : array
since | LiveDocx 1.2 |
---|
$_loggedIn : boolean
since | LiveDocx 1.2 |
---|
$_soapClient : \Zend_Soap_Client
since | LiveDocx 1.0 |
---|
$_wsdl : string
since | LiveDocx 1.0 |
---|
VERSION = '2.0'
since | LiveDocx 1.0 |
---|