API Documentation

Service/LiveDocx.php

Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Service
subpackage
LiveDocx
version
$Id$
Classes
Zend_Service_LiveDocx

Description

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.

Zend_Service_LiveDocx

category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Service
since
LiveDocx 1.0
subpackage
LiveDocx
Constants
VERSION
Properties
$_soapClient
$_wsdl
$_credentials
$_loggedIn
Methods
__construct
setOptions
__destruct
_initSoapClient
getSoapClient
setSoapClient
logIn
logOut
isLoggedIn
setUsername
setPassword
setWsdl
getUsername
getPassword
getWsdl
getFormat
getVersion
compareVersion

Description

Constants

VERSION

 VERSION = '1.2'

LiveDocx service version

Details

value
1.2
since
LiveDocx 1.0

Properties

$_credentials

array $_credentials = ''

Array of credentials (username and password) to log into backend server

Details

$_credentials
array
visibility
protected
default
final
false
static
false
since
LiveDocx 1.2

$_loggedIn

boolean $_loggedIn = ''

Set to true, when session is logged into backend server

Details

$_loggedIn
boolean
visibility
protected
default
final
false
static
false
since
LiveDocx 1.2

$_soapClient

Zend_Soap_Client $_soapClient = ''

SOAP client used to connect to LiveDocx service

Details

$_soapClient
Zend_Soap_Client
visibility
protected
default
final
false
static
false
since
LiveDocx 1.0

$_wsdl

string $_wsdl = ''

WSDL of LiveDocx web service

Details

$_wsdl
string
visibility
protected
default
final
false
static
false
since
LiveDocx 1.0

Methods

__construct

__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}

Arguments
$options
arrayZend_Config
Details
visibility
public
final
false
static
false
since
LiveDocx 1.0
throws

__destruct

__destruct( ) : boolean

Clean up and log out of LiveDocx service

Output
boolean
Details
visibility
public
final
false
static
false
since
LiveDocx 1.0

_initSoapClient

_initSoapClient( string $endpoint ) : void

Init Soap client - connect to SOAP service

Arguments
$endpoint
string
Details
visibility
protected
final
false
static
false
since
LiveDocx 1.2
throws

compareVersion

compareVersion( string $version ) : int

Compare the current API version with another version

Arguments
$version
string
(STRING NOT FLOAT)
Output
int
-1 (version is less than API version), 0 (versions are equal), or 1 (version is greater than API version)
Details
visibility
public
final
false
static
false
since
LiveDocx 1.0

getFormat

getFormat( string $filename ) : string

Return the document format (extension) of a filename

Arguments
$filename
string
Output
string
Details
visibility
public
final
false
static
false
since
LiveDocx 1.0

getPassword

getPassword( ) : string|null

Return current password

Output
string|null
Details
visibility
public
final
false
static
false
since
LiveDocx 1.0

getSoapClient

getSoapClient( ) : Zend_Soap_Client

Get SOAP client

Details
visibility
public
final
false
static
false
since
LiveDocx 1.2

getUsername

getUsername( ) : string|null

Return current username

Output
string|null
Details
visibility
public
final
false
static
false
since
LiveDocx 1.0

getVersion

getVersion( ) : string

Return the current API version

Output
string
Details
visibility
public
final
false
static
false
since
LiveDocx 1.0

getWsdl

getWsdl( ) : Zend_Service_LiveDocx

Return WSDL of LiveDocx web service

Details
visibility
public
final
false
static
false
since
LiveDocx 1.0

isLoggedIn

isLoggedIn( ) : boolean

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

Output
boolean
Details
visibility
public
final
false
static
false
since
LiveDocx 1.2

logIn

logIn( ) : boolean

Log in to LiveDocx service

Output
boolean
Details
visibility
public
final
false
static
false
since
LiveDocx 1.2
throws

logOut

logOut( ) : boolean

Log out of the LiveDocx service

Output
boolean
Details
visibility
public
final
false
static
false
since
LiveDocx 1.2
throws

setOptions

setOptions(  $options ) : Zend_Service_LiveDocx

Set options One or more of username, password, soapClient

Arguments
$options
Details
visibility
public
final
false
static
false
since
LiveDocx 1.2

setPassword

setPassword(  $password ) : Zend_Service_LiveDocx

Set password

Arguments
$password
Details
visibility
public
final
false
static
false
since
LiveDocx 1.0

setSoapClient

setSoapClient( Zend_Soap_Client $soapClient ) : Zend_Service_LiveDocx

Set SOAP client

Arguments
$soapClient
Zend_Soap_Client
Details
visibility
public
final
false
static
false
since
LiveDocx 1.2

setUsername

setUsername(  $username ) : Zend_Service_LiveDocx

Set username

Arguments
$username
Details
visibility
public
final
false
static
false
since
LiveDocx 1.0

setWsdl

setWsdl(  $wsdl ) : Zend_Service_LiveDocx

Set WSDL of LiveDocx web service

Arguments
$wsdl
Details
visibility
public
final
false
static
false
since
LiveDocx 1.0
Documentation was generated by DocBlox.