Service/LiveDocx.php

Show: PublicProtectedPrivateinherited
Table of Contents
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
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

>VConstant  VERSION = '2.0'
LiveDocx service version
Since
LiveDocx 1.0  

Properties

>VPropertyprotectedarray $_credentials
Array of credentials (username and password) to log into backend server
Details
Type
array
Since
LiveDocx 1.2  
>VPropertyprotectedboolean $_loggedIn
Set to true, when session is logged into backend server
Details
Type
boolean
Since
LiveDocx 1.2  
>VPropertyprotected\Zend_Soap_Client $_soapClient
SOAP client used to connect to LiveDocx service
Details
Type
\Zend_Soap_Client
Since
LiveDocx 1.0  
>VPropertyprotectedstring $_wsdl
WSDL of LiveDocx web service
Details
Type
string
Since
LiveDocx 1.0  

Methods

methodpublic__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}
Parameters
NameTypeDescription
$optionsarray | \Zend_Config
Throws
ExceptionDescription
\Zend_Service_LiveDocx_Exception
Details
Since
LiveDocx 1.0  
methodpublic__destruct() : boolean

Clean up and log out of LiveDocx service

Returns
TypeDescription
boolean
Details
Since
LiveDocx 1.0  
methodprotected_initSoapClient(string $endpoint) : void

Init Soap client - connect to SOAP service

Parameters
NameTypeDescription
$endpointstring
Throws
ExceptionDescription
\Zend_Service_LiveDocx_Exception
Details
Since
LiveDocx 1.2  
methodpubliccompareVersion(string $version) : int

Compare the current API version with another version

Parameters
NameTypeDescription
$versionstring

(STRING NOT FLOAT)

Returns
TypeDescription
int-1 (version is less than API version), 0 (versions are equal), or 1 (version is greater than API version)
Details
Since
LiveDocx 1.0  
methodpublicgetFormat(string $filename) : string

Return the document format (extension) of a filename

Parameters
NameTypeDescription
$filenamestring
Returns
TypeDescription
string
Details
Since
LiveDocx 1.0  
methodpublicgetPassword() : string | null

Return current password

Returns
TypeDescription
string | null
Details
Since
LiveDocx 1.0  
methodpublicgetSoapClient() : \Zend_Soap_Client

Get SOAP client

Returns
TypeDescription
\Zend_Soap_Client
Details
Since
LiveDocx 1.2  
methodpublicgetUsername() : string | null

Return current username

Returns
TypeDescription
string | null
Details
Since
LiveDocx 1.0  
methodpublicgetVersion() : string

Return the current API version

Returns
TypeDescription
string
Details
Since
LiveDocx 1.0  
methodpublicgetWsdl() : \Zend_Service_LiveDocx

Return WSDL of LiveDocx web service

Returns
TypeDescription
\Zend_Service_LiveDocx
Details
Since
LiveDocx 1.0  
methodpublicisLoggedIn() : boolean

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

Returns
TypeDescription
boolean
Details
Since
LiveDocx 1.2  
methodpubliclogIn() : boolean

Log in to LiveDocx service

Returns
TypeDescription
boolean
Throws
ExceptionDescription
\Zend_Service_LiveDocx_Exception
Details
Since
LiveDocx 1.2  
methodpubliclogOut() : boolean

Log out of the LiveDocx service

Returns
TypeDescription
boolean
Throws
ExceptionDescription
\Zend_Service_LiveDocx_Exception
Details
Since
LiveDocx 1.2  
methodpublicsetOptions(array $options) : \Zend_Service_LiveDocx

Set options One or more of username, password, soapClient

Parameters
NameTypeDescription
$optionsarray
Returns
TypeDescription
\Zend_Service_LiveDocx
Details
Since
LiveDocx 1.2  
methodpublicsetPassword( $password) : \Zend_Service_LiveDocx

Set password

Parameters
NameTypeDescription
$password
Returns
TypeDescription
\Zend_Service_LiveDocx
Details
Since
LiveDocx 1.0  
methodpublicsetSoapClient(\Zend_Soap_Client $soapClient) : \Zend_Service_LiveDocx

Set SOAP client

Parameters
NameTypeDescription
$soapClient\Zend_Soap_Client
Returns
TypeDescription
\Zend_Service_LiveDocx
Details
Since
LiveDocx 1.2  
methodpublicsetUsername( $username) : \Zend_Service_LiveDocx

Set username

Parameters
NameTypeDescription
$username
Returns
TypeDescription
\Zend_Service_LiveDocx
Details
Since
LiveDocx 1.0  
methodpublicsetWsdl( $wsdl) : \Zend_Service_LiveDocx

Set WSDL of LiveDocx web service

Parameters
NameTypeDescription
$wsdl
Returns
TypeDescription
\Zend_Service_LiveDocx
Details
Since
LiveDocx 1.0  
Documentation was generated by phpDocumentor 2.2.0 .