PHPXRef 0.7.1 : moodle-2.8 : Detail view of LiveDocx.php

Zend Framework LICENSE

Copyright:	Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
License:	http://framework.zend.com/license/new-bsd New BSD License
Version:	$Id$
File Size:	415 lines (11 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 1 class

Zend_Service_LiveDocx:: (18 methods):
  __construct()
  setOptions()
  __destruct()
  _initSoapClient()
  getSoapClient()
  setSoapClient()
  logIn()
  logOut()
  isLoggedIn()
  setUsername()
  setPassword()
  setWsdl()
  getUsername()
  getPassword()
  getWsdl()
  getFormat()
  getVersion()
  compareVersion()

Class: Zend_Service_LiveDocx - X-Ref

__construct($options = null) X-Ref

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}

param: array|Zend_Config $options
return: void

setOptions(array $options) X-Ref

Set options
One or more of username, password, soapClient

param: $options
return: Zend_Service_LiveDocx

__destruct() X-Ref

Clean up and log out of LiveDocx service

return: boolean

_initSoapClient($endpoint) X-Ref

Init Soap client - connect to SOAP service

param: string $endpoint
return: void

getSoapClient() X-Ref

Get SOAP client

return: Zend_Soap_Client

setSoapClient(Zend_Soap_Client $soapClient) X-Ref

Set SOAP client

param: Zend_Soap_Client $soapClient
return: Zend_Service_LiveDocx

Log in to LiveDocx service

param: string $username
param: string $password
return: boolean

logOut() X-Ref

Log out of the LiveDocx service

return: boolean

isLoggedIn() X-Ref

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

return: boolean

setUsername($username) X-Ref

Set username

return: Zend_Service_LiveDocx

setPassword($password) X-Ref

Set password

return: Zend_Service_LiveDocx

setWsdl($wsdl) X-Ref

Set WSDL of LiveDocx web service

return: Zend_Service_LiveDocx

getUsername() X-Ref

Return current username

return: string|null

getPassword() X-Ref

Return current password

return: string|null

getWsdl() X-Ref

Return WSDL of LiveDocx web service

return: Zend_Service_LiveDocx

getFormat($filename) X-Ref

Return the document format (extension) of a filename

param: string $filename
return: string

getVersion() X-Ref

Return the current API version

return: string

compareVersion($version) X-Ref

Compare the current API version with another version

param: string $version (STRING NOT FLOAT)
return: int -1 (version is less than API version), 0 (versions are equal), or 1 (version is greater than API version)

PHP Cross Reference of moodle-2.8

/lib/zend/Zend/Service/ -> LiveDocx.php (summary)

Defines 1 class