Service/LiveDocx/MailMerge.php

Show:

inherited

Classes
- \Zend_Service_LiveDocx_MailMerge

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 [email protected] so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Service
Subpackage: LiveDocx
Version: $Id: MailMerge.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Service_LiveDocx_MailMerge
jump to top

Package: Zend\Service\LiveDocx

Parent(s): \Zend_Service_LiveDocx
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Since: LiveDocx 1.0

Constants

 
                WSDL
                = 'https://api.livedocx.com/2.0/mailmerge.asmx?WSDL'

 
                VERSION
                = '2.0'

inherited

LiveDocx service version

Inherited from: \Zend_Service_LiveDocx::VERSION

Inherited_from: \Zend_Service_LiveDocx::VERSION
Since: LiveDocx 1.0

Properties

array $_blockFieldValues =

Block field values

Details

Type: array
Since: LiveDocx 1.0

array $_credentials =

inherited

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

Inherited from: \Zend_Service_LiveDocx::$$_credentials

Details

Type: array
Inherited_from: \Zend_Service_LiveDocx::$$_credentials
Since: LiveDocx 1.2

array $_fieldValues =

Field values

Details

Type: array
Since: LiveDocx 1.0

boolean $_loggedIn =

inherited

Set to true, when session is logged into backend server

Inherited from: \Zend_Service_LiveDocx::$$_loggedIn

Details

Type: boolean
Inherited_from: \Zend_Service_LiveDocx::$$_loggedIn
Since: LiveDocx 1.2

\Zend_Soap_Client $_soapClient =

inherited

SOAP client used to connect to LiveDocx service

Inherited from: \Zend_Service_LiveDocx::$$_soapClient

Details

Type: \Zend_Soap_Client
Inherited_from: \Zend_Service_LiveDocx::$$_soapClient
Since: LiveDocx 1.0

string $_wsdl =

inherited

WSDL of LiveDocx web service

Inherited from: \Zend_Service_LiveDocx::$$_wsdl

Details

Type: string
Inherited_from: \Zend_Service_LiveDocx::$$_wsdl
Since: LiveDocx 1.0

Methods

__construct(array | \Zend_Config $options = null) : void\throws

Constructor (LiveDocx.MailMerge SOAP Service)

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

Returns

Type	Description
void\throws	Zend_Service_LiveDocx_Exception

Throws

Exception	Description
\Zend_Service_LiveDocx_Exception

Details

Since: LiveDocx 1.0

__destruct() : boolean

inherited

Clean up and log out of LiveDocx service

Inherited from: \Zend_Service_LiveDocx::__destruct()

Returns

Type	Description
boolean

Details

Since: LiveDocx 1.0

_backendListArrayToMultiAssocArray(array $list) : array

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

Parameters

Name	Type	Description
$list	array

Returns

Type	Description
array

Details

Since: LiveDocx 1.0

_initSoapClient(string $endpoint) : void

inherited

Init Soap client - connect to SOAP service

Inherited from: \Zend_Service_LiveDocx::_initSoapClient()

Parameters

Name	Type	Description
$endpoint	string

Throws

Exception	Description
\Zend_Service_LiveDocx_Exception

Details

Since: LiveDocx 1.2

assign(array | string $field, array | string $value = null) : \Zend_Service_LiveDocx_MailMerge

Assign values to template fields

Parameters

Name	Type	Description
$field	array \| string
$value	array \| string

Returns

Type	Description
\Zend_Service_LiveDocx_MailMerge

Throws

Exception	Description
\Zend_Service_LiveDocx_Exception

Details

Since: LiveDocx 1.0

assocArrayToArrayOfArrayOfString(array $assoc) : array

static

Convert assoc array to required SOAP type

Parameters

Name	Type	Description
$assoc	array

Returns

Type	Description
array

Details

Since: LiveDocx 1.0

compareVersion(string $version) : int

inherited

Compare the current API version with another version

Inherited from: \Zend_Service_LiveDocx::compareVersion()

Parameters

Name	Type	Description
$version	string	(STRING NOT FLOAT)

Returns

Type	Description
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

createDocument() : void

Merge assigned data with template to generate document

Throws

Exception	Description
\Zend_Service_LiveDocx_Excpetion

Details

Since: LiveDocx 1.0

deleteImage(string $filename) : void

Delete an image file from LiveDocx service

Parameters

Name	Type	Description
$filename	string

Throws

Exception	Description
\Zend_Service_LiveDocx_Exception

Details

Since: LiveDocx 2.0

deleteSharedDocument(string $filename) : void

Delete a shared document from LiveDocx service

Parameters

Name	Type	Description
$filename	string

Details

Since: LiveDocx 1.0

deleteTemplate(string $filename) : void

Delete a template file from LiveDocx service

Parameters

Name	Type	Description
$filename	string

Throws

Exception	Description
\Zend_Service_LiveDocx_Exception

Details

Since: LiveDocx 1.0

downloadImage(string $filename) : void

Download an image file from LiveDocx service

Parameters

Name	Type	Description
$filename	string

Throws

Exception	Description
\Zend_Service_LiveDocx_Exception

Details

Since: LiveDocx 2.0

downloadSharedDocument( $filename) : void

Parameters

Name	Type	Description
$filename

downloadTemplate(string $filename) : \binary

Download template file from LiveDocx service

Parameters

Name	Type	Description
$filename	string

Returns

Type	Description
\binary

Throws

Exception	Description
\Zend_Service_LiveDocx_Exception

Details

Since: LiveDocx 1.0

getAllBitmaps(integer $zoomFactor, string $format) : array

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

Parameters

Name	Type	Description
$zoomFactor	integer
$format	string

Returns

Type	Description
array

Details

Since: LiveDocx 1.2

getAllMetafiles() : array

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

Returns

Type	Description
array

Details

Since: LiveDocx 1.2

getBitmaps(integer $fromPage, integer $toPage, integer $zoomFactor, string $format) : array

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

Parameters

Name	Type	Description
$fromPage	integer
$toPage	integer
$zoomFactor	integer
$format	string

Returns

Type	Description
array

Details

Since: LiveDocx 1.2

getBlockFieldNames(string $blockName) : array

Return all the block fields in the template

Parameters

Name	Type	Description
$blockName	string

Returns

Type	Description
array

Details

Since: LiveDocx 1.0

getBlockNames() : array

Return all the block fields in the template

Returns

Type	Description
array

Details

Since: LiveDocx 1.0

getDocumentAccessOptions() : array

Return supported document access options

Returns

Type	Description
array

Details

Since: LiveDocx 1.2 Premium

getDocumentFormats() : array

Return supported document formats (lowercase)

Returns

Type	Description
array

Details

Since: LiveDocx 1.1

getFieldNames() : array

Return all the fields in the template

Returns

Type	Description
array

Details

Since: LiveDocx 1.0

getFontNames() : array

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

Returns

Type	Description
array

Details

Since: LiveDocx 1.2

getFormat(string $filename) : string

inherited

Return the document format (extension) of a filename

Inherited from: \Zend_Service_LiveDocx::getFormat()

Parameters

Name	Type	Description
$filename	string

Returns

Type	Description
string

Details

Since: LiveDocx 1.0

getImageExportFormats() : array

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

Returns

Type	Description
array

Details

Since: LiveDocx 2.0

getImageFormats() : void

getImageImportFormats() : array

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

Returns

Type	Description
array

Details

Since: LiveDocx 2.0

getMetafiles(integer $fromPage, integer $toPage) : array

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

Name	Type	Description
$fromPage	integer
$toPage	integer

Returns

Type	Description
array

Details

Since: LiveDocx 1.2

getPassword() : string | null

inherited

Return current password

Inherited from: \Zend_Service_LiveDocx::getPassword()

Returns

Type	Description
string \| null

Details

Since: LiveDocx 1.0

getSoapClient() : \Zend_Soap_Client

inherited

Get SOAP client

Inherited from: \Zend_Service_LiveDocx::getSoapClient()

Returns

Type	Description
\Zend_Soap_Client

Details

Since: LiveDocx 1.2

getTemplateFormats() : array

Return supported template formats (lowercase)

Returns

Type	Description
array

Details

Since: LiveDocx 1.0

getUsername() : string | null

inherited

Return current username

Inherited from: \Zend_Service_LiveDocx::getUsername()

Returns

Type	Description
string \| null

Details

Since: LiveDocx 1.0

getVersion() : string

inherited

Return the current API version

Inherited from: \Zend_Service_LiveDocx::getVersion()

Returns

Type	Description
string

Details

Since: LiveDocx 1.0

getWsdl() : \Zend_Service_LiveDocx

inherited

Return WSDL of LiveDocx web service

Inherited from: \Zend_Service_LiveDocx::getWsdl()

Returns

Type	Description
\Zend_Service_LiveDocx

Details

Since: LiveDocx 1.0

imageExists(string $filename) : boolean

Check whether an image file is available on LiveDocx service

Parameters

Name	Type	Description
$filename	string

Returns

Type	Description
boolean

Details

Since: LiveDocx 2.0

isLoggedIn() : boolean

inherited

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

Inherited from: \Zend_Service_LiveDocx::isLoggedIn()

Returns

Type	Description
boolean

Details

Since: LiveDocx 1.2

listImages() : array

List all images stored on LiveDocx service

Returns

Type	Description
array

Details

Since: LiveDocx 2.0

listSharedDocuments() : array

List all shared documents stored on LiveDocx service

Returns

Type	Description
array

Details

Since: LiveDocx 1.0

listTemplates() : array

List all templates stored on LiveDocx service

Returns

Type	Description
array

Details

Since: LiveDocx 1.0

logIn() : boolean

inherited

Inherited from: \Zend_Service_LiveDocx::logIn()

Returns

Type	Description
boolean

Throws

Exception	Description
\Zend_Service_LiveDocx_Exception

Details

Since: LiveDocx 1.2

logOut() : boolean

inherited

Log out of the LiveDocx service

Inherited from: \Zend_Service_LiveDocx::logOut()

Returns

Type	Description
boolean

Throws

Exception	Description
\Zend_Service_LiveDocx_Exception

Details

Since: LiveDocx 1.2

multiAssocArrayToArrayOfArrayOfString(array $multi) : array

static

Convert multi assoc array to required SOAP type

Parameters

Name	Type	Description
$multi	array

Returns

Type	Description
array

Details

Since: LiveDocx 1.0

retrieveDocument(string $format) : \binary

Retrieve document in specified format

Parameters

Name	Type	Description
$format	string

Returns

Type	Description
\binary

Throws

Exception	Description
\Zend_Service_LiveDocx_Exception

Details

Since: LiveDocx 1.0

setBlockFieldValues(string $blockName, array $blockFieldValues) : \Zend_Service_LiveDocx_MailMerge

Set block field values

Parameters

Name	Type	Description
$blockName	string
$blockFieldValues	array

Returns

Type	Description
\Zend_Service_LiveDocx_MailMerge

Throws

Exception	Description
\Zend_Service_LiveDocx_Exception

Details

Since: LiveDocx 1.0

setDocumentAccessPermissions(array $permissions, string $password) : \Zend_Service_LiveDocx_MailMerge

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

Name	Type	Description
$permissions	array
$password	string

Returns

Type	Description
\Zend_Service_LiveDocx_MailMerge

Throws

Exception	Description
\Zend_Service_LiveDocx_Exception

Details

Since: LiveDocx 1.2 Premium

setDocumentPassword(string $password) : \Zend_Service_LiveDocx_MailMerge

Set a password to open to document

This method can only be used for PDF documents

Parameters

Name	Type	Description
$password	string

Returns

Type	Description
\Zend_Service_LiveDocx_MailMerge

Throws

Exception	Description
\Zend_Service_LiveDocx_Exception

Details

Since: LiveDocx 1.2 Premium

setFieldValue(string $field, array | string $value) : \Zend_Service_LiveDocx_MailMerge

Set an array of key and value or array of values

Parameters

Name	Type	Description
$field	string
$value	array \| string

Returns

Type	Description
\Zend_Service_LiveDocx_MailMerge

Throws

Exception	Description
\Zend_Service_LiveDocx_Exception

Details

Since: LiveDocx 1.0

setFieldValues(array $values) : \Zend_Service_LiveDocx_MailMerge

Set an associative or multi-associative array of keys and values pairs

Parameters

Name	Type	Description
$values	array

Returns

Type	Description
\Zend_Service_LiveDocx_MailMerge

Throws

Exception	Description
\Zend_Service_LiveDocx_Exception

Details

Since: LiveDocx 1.0

setLocalTemplate(string $filename) : \Zend_Service_LiveDocx_MailMerge

Set the filename of a LOCAL template (i.e.

a template stored locally on YOUR server)

Parameters

Name	Type	Description
$filename	string

Returns

Type	Description
\Zend_Service_LiveDocx_MailMerge

Throws

Exception	Description
\Zend_Service_LiveDocx_Exception

Details

Since: LiveDocx 1.0

setOptions(array $options) : \Zend_Service_LiveDocx

inherited

Set options One or more of username, password, soapClient

Inherited from: \Zend_Service_LiveDocx::setOptions()

Parameters

Name	Type	Description
$options	array

Returns

Type	Description
\Zend_Service_LiveDocx

Details

Since: LiveDocx 1.2

setPassword( $password) : \Zend_Service_LiveDocx

inherited

Set password

Inherited from: \Zend_Service_LiveDocx::setPassword()

Parameters

Name	Type	Description
$password

Returns

Type	Description
\Zend_Service_LiveDocx

Details

Since: LiveDocx 1.0

setRemoteTemplate(string $filename) : \Zend_Service_LiveDocx_MailMerge

Set the filename of a REMOTE template (i.e.

a template stored remotely on the LIVEDOCX server)

Parameters

Name	Type	Description
$filename	string

Returns

Type	Description
\Zend_Service_LiveDocx_MailMerge

Throws

Exception	Description
\Zend_Service_LiveDocx_Exception

Details

Since: LiveDocx 1.0

setSoapClient(\Zend_Soap_Client $soapClient) : \Zend_Service_LiveDocx

inherited

Set SOAP client

Inherited from: \Zend_Service_LiveDocx::setSoapClient()

Parameters

Name	Type	Description
$soapClient	\Zend_Soap_Client

Returns

Type	Description
\Zend_Service_LiveDocx

Details

Since: LiveDocx 1.2

setUsername( $username) : \Zend_Service_LiveDocx

inherited

Set username

Inherited from: \Zend_Service_LiveDocx::setUsername()

Parameters

Name	Type	Description
$username

Returns

Type	Description
\Zend_Service_LiveDocx

Details

Since: LiveDocx 1.0

setWsdl( $wsdl) : \Zend_Service_LiveDocx

inherited

Set WSDL of LiveDocx web service

Inherited from: \Zend_Service_LiveDocx::setWsdl()

Parameters

Name	Type	Description
$wsdl

Returns

Type	Description
\Zend_Service_LiveDocx

Details

Since: LiveDocx 1.0

shareDocument() : string

Share a document - i.e.

the document is available to all over the Internet

Returns

Type	Description
string

Details

Since: LiveDocx 1.0

sharedDocumentExists(string $filename) : boolean

Check whether a shared document is available on LiveDocx service

Parameters

Name	Type	Description
$filename	string

Returns

Type	Description
boolean

Details

Since: LiveDocx 1.0

templateExists(string $filename) : boolean

Check whether a template file is available on LiveDocx service

Parameters

Name	Type	Description
$filename	string

Returns

Type	Description
boolean

Details

Since: LiveDocx 1.0

uploadImage(string $filename) : void

Upload an image file to LiveDocx service

Parameters

Name	Type	Description
$filename	string

Throws

Exception	Description
\Zend_Service_LiveDocx_Exception

Details

Since: LiveDocx 2.0

uploadTemplate(string $filename) : void

Upload a template file to LiveDocx service

Parameters

Name	Type	Description
$filename	string

Throws

Exception	Description
\Zend_Service_LiveDocx_Exception

Details

Since: LiveDocx 1.0

Service/LiveDocx/MailMerge.php

\Zend_Service_LiveDocx_MailMergejump to top

Constants

Properties

Methods

\Zend_Service_LiveDocx_MailMerge
jump to top