Service/LiveDocx.php
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.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Service
- Subpackage
- LiveDocx
- Version
- $Id$
\Zend_Service_LiveDocx
Package: Zend_Service\LiveDocx



Throws
Details
















- Children
- \Zend_Service_LiveDocx_MailMerge
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Since
- LiveDocx 1.0
Constants
Properties

array $_credentialsArray of credentials (username and password) to log into backend server
Details
- Type
- array
- Since
- LiveDocx 1.2

boolean $_loggedInSet to true, when session is logged into backend server
Details
- Type
- boolean
- Since
- LiveDocx 1.2

\Zend_Soap_Client $_soapClientSOAP client used to connect to LiveDocx service
Details
- Type
- \Zend_Soap_Client
- Since
- LiveDocx 1.0
Methods

__construct(array | \Zend_Config $options = null) : voidConstructor
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| Name | Type | Description |
|---|---|---|
| $options | array | \Zend_Config |
| Exception | Description |
|---|---|
| \Zend_Service_LiveDocx_Exception |
- Since
- LiveDocx 1.0

__destruct() : booleanClean up and log out of LiveDocx service
Returns
Details
| Type | Description |
|---|---|
| boolean |
- Since
- LiveDocx 1.0

_initSoapClient(string $endpoint) : voidInit Soap client - connect to SOAP service
Parameters
Throws
Details
| Name | Type | Description |
|---|---|---|
| $endpoint | string |
| Exception | Description |
|---|---|
| \Zend_Service_LiveDocx_Exception |
- Since
- LiveDocx 1.2

compareVersion(string $version) : intCompare the current API version with another version
Parameters
Returns
Details
| Name | Type | Description |
|---|---|---|
| $version | string | (STRING NOT FLOAT) |
| Type | Description |
|---|---|
| int | -1 (version is less than API version), 0 (versions are equal), or 1 (version is greater than API version) |
- Since
- LiveDocx 1.0

getFormat(string $filename) : stringReturn the document format (extension) of a filename
Parameters
Returns
Details
| Name | Type | Description |
|---|---|---|
| $filename | string |
| Type | Description |
|---|---|
| string |
- Since
- LiveDocx 1.0

getPassword() : string | nullReturn current password
Returns
Details
| Type | Description |
|---|---|
| string | null |
- Since
- LiveDocx 1.0

getSoapClient() : \Zend_Soap_ClientGet SOAP client
Returns
Details
| Type | Description |
|---|---|
| \Zend_Soap_Client |
- Since
- LiveDocx 1.2

getUsername() : string | nullReturn current username
Returns
Details
| Type | Description |
|---|---|
| string | null |
- Since
- LiveDocx 1.0

getVersion() : stringReturn the current API version
Returns
Details
| Type | Description |
|---|---|
| string |
- Since
- LiveDocx 1.0

getWsdl() : \Zend_Service_LiveDocxReturn WSDL of LiveDocx web service
Returns
Details
| Type | Description |
|---|---|
| \Zend_Service_LiveDocx |
- Since
- LiveDocx 1.0

isLoggedIn() : booleanReturn true, if session is currently logged into the backend server
Returns
Details
| Type | Description |
|---|---|
| boolean |
- Since
- LiveDocx 1.2

logIn() : booleanLog in to LiveDocx service
Returns
Throws
Details
| Type | Description |
|---|---|
| boolean |
| Exception | Description |
|---|---|
| \Zend_Service_LiveDocx_Exception |
- Since
- LiveDocx 1.2

logOut() : booleanLog out of the LiveDocx service
Returns
Throws
Details
| Type | Description |
|---|---|
| boolean |
| Exception | Description |
|---|---|
| \Zend_Service_LiveDocx_Exception |
- Since
- LiveDocx 1.2

setOptions(array $options) : \Zend_Service_LiveDocxSet options One or more of username, password, soapClient
Parameters
Returns
Details
| Name | Type | Description |
|---|---|---|
| $options | array |
| Type | Description |
|---|---|
| \Zend_Service_LiveDocx |
- Since
- LiveDocx 1.2

setPassword( $password) : \Zend_Service_LiveDocxSet password
Parameters
Returns
Details
| Name | Type | Description |
|---|---|---|
| $password |
| Type | Description |
|---|---|
| \Zend_Service_LiveDocx |
- Since
- LiveDocx 1.0

setSoapClient(\Zend_Soap_Client $soapClient) : \Zend_Service_LiveDocxSet SOAP client
Parameters
Returns
Details
| Name | Type | Description |
|---|---|---|
| $soapClient | \Zend_Soap_Client |
| Type | Description |
|---|---|
| \Zend_Service_LiveDocx |
- Since
- LiveDocx 1.2

setUsername( $username) : \Zend_Service_LiveDocxSet username
Parameters
Returns
Details
| Name | Type | Description |
|---|---|---|
| $username |
| Type | Description |
|---|---|
| \Zend_Service_LiveDocx |
- Since
- LiveDocx 1.0

setWsdl( $wsdl) : \Zend_Service_LiveDocxSet WSDL of LiveDocx web service
Parameters
Returns
Details
| Name | Type | Description |
|---|---|---|
| $wsdl |
| Type | Description |
|---|---|
| \Zend_Service_LiveDocx |
- Since
- LiveDocx 1.0