API Documentation

Zend/Service/LiveDocx/MailMerge.php

Show: inherited
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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Service  
Subpackage
LiveDocx  
Version
$Id: MailMerge.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Service_LiveDocx_MailMerge

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

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

URI of LiveDocx.MailMerge WSDL

Since
LiveDocx 1.0  

Properties

Propertyprotectedarray  $_blockFieldValues= ''

Block field values

Details
Type
array
Since
LiveDocx 1.0  
Propertyprotectedarray  $_fieldValues= ''

Field values

Details
Type
array
Since
LiveDocx 1.0  

Methods

methodpublic__construct(  $options = null ) : void\throws

Constructor (LiveDocx.MailMerge SOAP Service)

Parameters
Name Type Description
$options
Returns
Type Description
void\throws Zend_Service_LiveDocx_Exception
Details
Since
LiveDocx 1.0  
methodprotected_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  
methodpublicassign( 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  
methodpublicassocArrayToArrayOfArrayOfString( 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  
methodpubliccreateDocument( ) : void

Merge assigned data with template to generate document

Throws
Exception Description
\Zend_Service_LiveDocx_Excpetion
Details
Since
LiveDocx 1.0  
methodpublicdeleteImage( 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  
methodpublicdeleteSharedDocument( string $filename ) : void

Delete a shared document from LiveDocx service

Parameters
Name Type Description
$filename string
Details
Since
LiveDocx 1.0  
methodpublicdeleteTemplate( 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  
methodpublicdownloadImage( 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  
methodpublicdownloadSharedDocument(  $filename ) : void

Parameters
Name Type Description
$filename
methodpublicdownloadTemplate( 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  
methodpublicgetAllBitmaps( 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  
methodpublicgetAllMetafiles( ) : 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  
methodpublicgetBitmaps( 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  
methodpublicgetBlockFieldNames( 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  
methodpublicgetBlockNames( ) : array

Return all the block fields in the template

Returns
Type Description
array
Details
Since
LiveDocx 1.0  
methodpublicgetDocumentAccessOptions( ) : array

Return supported document access options

Returns
Type Description
array
Details
Since
LiveDocx 1.2 Premium  
methodpublicgetDocumentFormats( ) : array

Return supported document formats (lowercase)

Returns
Type Description
array
Details
Since
LiveDocx 1.1  
methodpublicgetFieldNames( ) : array

Return all the fields in the template

Returns
Type Description
array
Details
Since
LiveDocx 1.0  
methodpublicgetFontNames( ) : array

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

Returns
Type Description
array
Details
Since
LiveDocx 1.2  
methodpublicgetImageExportFormats( ) : array

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

Returns
Type Description
array
Details
Since
LiveDocx 2.0  
methodpublicgetImageFormats( ) : void

methodpublicgetImageImportFormats( ) : array

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

Returns
Type Description
array
Details
Since
LiveDocx 2.0  
methodpublicgetMetafiles( 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  
methodpublicgetTemplateFormats( ) : array

Return supported template formats (lowercase)

Returns
Type Description
array
Details
Since
LiveDocx 1.0  
methodpublicimageExists( 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  
methodpubliclistImages( ) : array

List all images stored on LiveDocx service

Returns
Type Description
array
Details
Since
LiveDocx 2.0  
methodpubliclistSharedDocuments( ) : array

List all shared documents stored on LiveDocx service

Returns
Type Description
array
Details
Since
LiveDocx 1.0  
methodpubliclistTemplates( ) : array

List all templates stored on LiveDocx service

Returns
Type Description
array
Details
Since
LiveDocx 1.0  
methodpublicmultiAssocArrayToArrayOfArrayOfString( 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  
methodpublicretrieveDocument( 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  
methodpublicsetBlockFieldValues( 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  
methodpublicsetDocumentAccessPermissions( 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  
methodpublicsetDocumentPassword( 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  
methodpublicsetFieldValue( 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  
methodpublicsetFieldValues( 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  
methodpublicsetLocalTemplate( 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  
methodpublicsetRemoteTemplate( 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  
methodpublicshareDocument( ) : string

Share a document - i.e. the document is available to all over the Internet

Returns
Type Description
string
Details
Since
LiveDocx 1.0  
methodpublicsharedDocumentExists( 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  
methodpublictemplateExists( 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  
methodpublicuploadImage( 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  
methodpublicuploadTemplate( 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  
Documentation was generated by DocBlox 0.15.1.