Public Member Functions
	__construct ($options=null)
	Constructor (LiveDocx.MailMerge SOAP Service)

	setLocalTemplate ($filename)
	Set the filename of a LOCAL template (i.e.

	setRemoteTemplate ($filename)
	Set the filename of a REMOTE template (i.e.

	setFieldValues ($values)
	Set an associative or multi-associative array of keys and values pairs.

	setFieldValue ($field, $value)
	Set an array of key and value or array of values.

	setBlockFieldValues ($blockName, $blockFieldValues)
	Set block field values.

	assign ($field, $value=null)
	Assign values to template fields.

	setDocumentPassword ($password)
	Set a password to open to document.

	setDocumentAccessPermissions ($permissions, $password)
	Set a master password for document and determine which security features are accessible without using the master password.

	createDocument ()
	Merge assigned data with template to generate document.

	retrieveDocument ($format)
	Retrieve document in specified format.

	getMetafiles ($fromPage, $toPage)
	Return WMF (aka Windows metafile) data for specified page range of created document Return array contains WMF data (binary) - array key is page number.

	getAllMetafiles ()
	Return WMF (aka Windows metafile) data for pages of created document Return array contains WMF data (binary) - array key is page number.

	getBitmaps ($fromPage, $toPage, $zoomFactor, $format)
	Return graphical bitmap data for specified page range of created document Return array contains bitmap data (binary) - array key is page number.

	getAllBitmaps ($zoomFactor, $format)
	Return graphical bitmap data for all pages of created document Return array contains bitmap data (binary) - array key is page number.

	getFieldNames ()
	Return all the fields in the template.

	getBlockFieldNames ($blockName)
	Return all the block fields in the template.

	getBlockNames ()
	Return all the block fields in the template.

	uploadTemplate ($filename)
	Upload a template file to LiveDocx service.

	downloadTemplate ($filename)
	Download template file from LiveDocx service.

	deleteTemplate ($filename)
	Delete a template file from LiveDocx service.

	listTemplates ()
	List all templates stored on LiveDocx service.

	templateExists ($filename)
	Check whether a template file is available on LiveDocx service.

	shareDocument ()
	Share a document - i.e.

	listSharedDocuments ()
	List all shared documents stored on LiveDocx service.

	deleteSharedDocument ($filename)
	Delete a shared document from LiveDocx service.

	downloadSharedDocument ($filename)

	sharedDocumentExists ($filename)
	Check whether a shared document is available on LiveDocx service.

	getTemplateFormats ()
	Return supported template formats (lowercase)

	getDocumentFormats ()
	Return supported document formats (lowercase)

	getFontNames ()
	Return the names of all fonts that are installed on backend server.

	getDocumentAccessOptions ()
	Return supported document access options.

	getImageImportFormats ()
	Return supported image formats from which can be imported (lowercase)

	getImageExportFormats ()
	Return supported image formats to which can be exported (lowercase)

	getImageFormats ()

	uploadImage ($filename)
	Upload an image file to LiveDocx service.

	downloadImage ($filename)
	Download an image file from LiveDocx service.

	listImages ()
	List all images stored on LiveDocx service.

	deleteImage ($filename)
	Delete an image file from LiveDocx service.

	imageExists ($filename)
	Check whether an image file is available on LiveDocx service.

Public Member Functions inherited from Zend_Service_LiveDocx
	__construct ($options=null)
	Constructor.

	setOptions (array $options)
	Set options One or more of username, password, soapClient.

	__destruct ()
	Clean up and log out of LiveDocx service.

	getSoapClient ()
	Get SOAP client.

	setSoapClient (Zend_Soap_Client $soapClient)
	Set SOAP client.

	logIn ()
	Log in to LiveDocx service.

	logOut ()
	Log out of the LiveDocx service.

	isLoggedIn ()
	Return true, if session is currently logged into the backend server.

	setUsername ($username)
	Set username.

	setPassword ($password)
	Set password.

	setWsdl ($wsdl)
	Set WSDL of LiveDocx web service.

	getUsername ()
	Return current username.

	getPassword ()
	Return current password.

	getWsdl ()
	Return WSDL of LiveDocx web service.

	getFormat ($filename)
	Return the document format (extension) of a filename.

	getVersion ()
	Return the current API version.

	compareVersion ($version)
	Compare the current API version with another version.

Static Public Member Functions
static	assocArrayToArrayOfArrayOfString ($assoc)
	Convert assoc array to required SOAP type.

static	multiAssocArrayToArrayOfArrayOfString ($multi)
	Convert multi assoc array to required SOAP type.

Public Attributes
const	WSDL = 'https://api.livedocx.com/2.0/mailmerge.asmx?WSDL'
	URI of LiveDocx.MailMerge WSDL.

Public Attributes inherited from Zend_Service_LiveDocx
const	VERSION = '2.0'
	LiveDocx service version.

Protected Member Functions
	_backendListArrayToMultiAssocArray ($list)
	Convert LiveDocx service return value from list methods to consistent PHP array.

Protected Member Functions inherited from Zend_Service_LiveDocx
	_initSoapClient ($endpoint)
	Init Soap client - connect to SOAP service.

Protected Attributes
	$_fieldValues

	$_blockFieldValues

Protected Attributes inherited from Zend_Service_LiveDocx
	$_soapClient

	$_wsdl

	$_credentials

	$_loggedIn

Constructor & Destructor Documentation

__construct ( $options = null )

Constructor (LiveDocx.MailMerge SOAP Service)

Returns: void; throws Zend_Service_LiveDocx_Exception

Since: LiveDocx 1.0

Member Function Documentation

_backendListArrayToMultiAssocArray ( $list )

protected

Convert LiveDocx service return value from list methods to consistent PHP array.

Parameters

array $list

Returns: array

Since: LiveDocx 1.0

assign	(	$field,
		$value = `null`
	)

Assign values to template fields.

Parameters

array \| string	$field
array \| string	$value

Returns: Zend_Service_LiveDocx_MailMerge

Exceptions

Zend_Service_LiveDocx_Exception

Since: LiveDocx 1.0

static assocArrayToArrayOfArrayOfString ( $assoc )

static

Convert assoc array to required SOAP type.

Parameters

array $assoc

Returns: array

Since: LiveDocx 1.0

createDocument ( )

Merge assigned data with template to generate document.

Exceptions

Zend_Service_LiveDocx_Excpetion

Returns: void

Since: LiveDocx 1.0

deleteImage ( $filename )

Delete an image file from LiveDocx service.

Parameters

string $filename

Returns: void

Exceptions

Zend_Service_LiveDocx_Exception

Since: LiveDocx 2.0

deleteSharedDocument ( $filename )

Delete a shared document from LiveDocx service.

Parameters

string $filename

Returns: void

Since: LiveDocx 1.0

deleteTemplate ( $filename )

Delete a template file from LiveDocx service.

Parameters

string $filename

Returns: void

Exceptions

Zend_Service_LiveDocx_Exception

Since: LiveDocx 1.0

downloadImage ( $filename )

Download an image file from LiveDocx service.

Parameters

string $filename

Returns: void

Exceptions

Zend_Service_LiveDocx_Exception

Since: LiveDocx 2.0

downloadSharedDocument ( $filename )

downloadTemplate ( $filename )

Download template file from LiveDocx service.

Parameters

string $filename

Returns: binary

Exceptions

Zend_Service_LiveDocx_Exception

Since: LiveDocx 1.0

getAllBitmaps	(	$zoomFactor,
		$format
	)

Return graphical bitmap data for all pages of created document Return array contains bitmap data (binary) - array key is page number.

Parameters

integer	$zoomFactor
string	$format

Returns: array

Since: LiveDocx 1.2

getAllMetafiles ( )

Return WMF (aka Windows metafile) data for pages of created document Return array contains WMF data (binary) - array key is page number.

Returns: array

Since: LiveDocx 1.2

getBitmaps	(	$fromPage,
		$toPage,
		$zoomFactor,
		$format
	)

Return graphical bitmap data for specified page range of created document Return array contains bitmap data (binary) - array key is page number.

Parameters

integer	$fromPage
integer	$toPage
integer	$zoomFactor
string	$format

Returns: array

Since: LiveDocx 1.2

getBlockFieldNames ( $blockName )

Return all the block fields in the template.

Parameters

string $blockName

Returns: array

Since: LiveDocx 1.0

getBlockNames ( )

Return all the block fields in the template.

Returns: array

Since: LiveDocx 1.0

getDocumentAccessOptions ( )

Return supported document access options.

Returns: array

Since: LiveDocx 1.2 Premium

getDocumentFormats ( )

Return supported document formats (lowercase)

Returns: array

Since: LiveDocx 1.1

getFieldNames ( )

Return all the fields in the template.

Returns: array

Since: LiveDocx 1.0

getFontNames ( )

Return the names of all fonts that are installed on backend server.

Returns: array

Since: LiveDocx 1.2

getImageExportFormats ( )

Return supported image formats to which can be exported (lowercase)

Returns: array

Since: LiveDocx 2.0

getImageFormats ( )

getImageImportFormats ( )

Return supported image formats from which can be imported (lowercase)

Returns: array

Since: LiveDocx 2.0

getMetafiles	(	$fromPage,
		$toPage
	)

Return WMF (aka Windows metafile) data for specified page range of created document Return array contains WMF data (binary) - array key is page number.

Parameters

integer	$fromPage
integer	$toPage

Returns: array

Since: LiveDocx 1.2

getTemplateFormats ( )

Return supported template formats (lowercase)

Returns: array

Since: LiveDocx 1.0

imageExists ( $filename )

Check whether an image file is available on LiveDocx service.

Parameters

string $filename

Returns: boolean

Since: LiveDocx 2.0

listImages ( )

List all images stored on LiveDocx service.

Returns: array

Since: LiveDocx 2.0

listSharedDocuments ( )

List all shared documents stored on LiveDocx service.

Returns: array

Since: LiveDocx 1.0

listTemplates ( )

List all templates stored on LiveDocx service.

Returns: array

Since: LiveDocx 1.0

static multiAssocArrayToArrayOfArrayOfString ( $multi )

static

Convert multi assoc array to required SOAP type.

Parameters

array $multi

Returns: array

Since: LiveDocx 1.0

retrieveDocument ( $format )

Retrieve document in specified format.

Parameters

string $format

Exceptions

Zend_Service_LiveDocx_Exception

Returns: binary

Since: LiveDocx 1.0

setBlockFieldValues	(	$blockName,
		$blockFieldValues
	)

Set block field values.

Parameters

string	$blockName
array	$blockFieldValues

Returns: Zend_Service_LiveDocx_MailMerge

Exceptions

Zend_Service_LiveDocx_Exception

Since: LiveDocx 1.0

setDocumentAccessPermissions	(	$permissions,
		$password
	)

Set a master password for document and determine which security features are accessible without using the master password.

As default, nothing is allowed. To allow a security setting, explicatively set it using one of he DOCUMENT_ACCESS_PERMISSION_* class constants.

{code} $phpLiveDocx->setDocumentAccessPermissions( array ( Zend_Service_LiveDocx_MailMerge::DOCUMENT_ACCESS_PERMISSION_ALLOW_PRINTING_HIGH_LEVEL, Zend_Service_LiveDocx_MailMerge::DOCUMENT_ACCESS_PERMISSION_ALLOW_EXTRACT_CONTENTS ), 'myDocumentAccessPassword' ); {code}

This method can only be used for PDF documents

Parameters