Service/LiveDocx/MailMerge.php

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_MailMerge

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_MailMerge
jump to top

Extends from: 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: WSDL
Properties: $_fieldValues; $_blockFieldValues
Methods: __construct; setLocalTemplate; setRemoteTemplate; setFieldValues; setFieldValue; setBlockFieldValues; assign; setDocumentPassword; setDocumentAccessPermissions; createDocument; retrieveDocument; getMetafiles; getAllMetafiles; getBitmaps; getAllBitmaps; getFieldNames; getBlockFieldNames; getBlockNames; uploadTemplate; downloadTemplate; deleteTemplate; listTemplates; templateExists; shareDocument; listSharedDocuments; deleteSharedDocument; downloadSharedDocument; sharedDocumentExists; getTemplateFormats; getDocumentFormats; getImageFormats; getFontNames; getDocumentAccessOptions; _backendListArrayToMultiAssocArray; assocArrayToArrayOfArrayOfString; multiAssocArrayToArrayOfArrayOfString

Description

Constants

WSDL
jump to class

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

URI of LiveDocx.MailMerge WSDL

Details

value: https://api.livedocx.com/1.2/mailmerge.asmx?WSDL
since: LiveDocx 1.0

Properties

$_blockFieldValues
jump to class

array $_blockFieldValues = ''

Block field values

Details

$_blockFieldValues: array
visibility: protected
default
final: false
static: false
since: LiveDocx 1.0

$_fieldValues
jump to class

array $_fieldValues = ''

Field values

Details

$_fieldValues: array
visibility: protected
default
final: false
static: false
since: LiveDocx 1.0

Methods

__construct
jump to class

__construct(
           $options
              =
              null
          )
        
        :
        void|throws

Constructor (LiveDocx.MailMerge SOAP Service)

Arguments

$options

Output

void
throws: Zend_Service_LiveDocx_Exception

Details

visibility: public
final: false
static: false
since: LiveDocx 1.0

_backendListArrayToMultiAssocArray
jump to class

_backendListArrayToMultiAssocArray(
          array $list
          )
        
        :
        array

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

Arguments

$list: array

Output

array

Details

visibility: protected
final: false
static: false
since: LiveDocx 1.0

assign
jump to class

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

Assign values to template fields

Arguments

$field: arraystring
$value: arraystring

Output

Zend_Service_LiveDocx_MailMerge

Details

visibility: public
final: false
static: false
since: LiveDocx 1.0
throws

assocArrayToArrayOfArrayOfString
jump to class

assocArrayToArrayOfArrayOfString(
          array $assoc
          )
        
        :
        array

Convert assoc array to required SOAP type

Arguments

$assoc: array

Output

array

Details

visibility: public
final: false
static: true
since: LiveDocx 1.0

createDocument
jump to class

createDocument(
          
          )
        
        :
        void

Merge assigned data with template to generate document

Details

visibility: public
final: false
static: false
since: LiveDocx 1.0
throws

deleteSharedDocument
jump to class

deleteSharedDocument(
          string $filename
          )
        
        :
        void

Delete a shared document from LiveDocx service

Arguments

$filename: string

Details

visibility: public
final: false
static: false
since: LiveDocx 1.0

deleteTemplate
jump to class

deleteTemplate(
          string $filename
          )
        
        :
        void

Delete a template file from LiveDocx service

Arguments

$filename: string

Details

visibility: public
final: false
static: false
since: LiveDocx 1.0
throws

downloadSharedDocument
jump to class

downloadSharedDocument(
           $filename
          )
        
        :

Arguments

$filename

Details

visibility: public
final: false
static: false

downloadTemplate
jump to class

downloadTemplate(
          string $filename
          )
        
        :
        binary

Download template file from LiveDocx service

Arguments

$filename: string

Output

binary

Details

visibility: public
final: false
static: false
since: LiveDocx 1.0
throws

getAllBitmaps
jump to class

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

Arguments

$zoomFactor: integer
$format: string

Output

array

Details

visibility: public
final: false
static: false
since: LiveDocx 1.2

getAllMetafiles
jump to class

getAllMetafiles(
          
          )
        
        :
        array

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

Output

array

Details

visibility: public
final: false
static: false
since: LiveDocx 1.2

getBitmaps
jump to class

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

Arguments

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

Output

array

Details

visibility: public
final: false
static: false
since: LiveDocx 1.2

getBlockFieldNames
jump to class

getBlockFieldNames(
          string $blockName
          )
        
        :
        array

Return all the block fields in the template

Arguments

$blockName: string

Output

array

Details

visibility: public
final: false
static: false
since: LiveDocx 1.0

getBlockNames
jump to class

getBlockNames(
          
          )
        
        :
        array

Return all the block fields in the template

Output

array

Details

visibility: public
final: false
static: false
since: LiveDocx 1.0

getDocumentAccessOptions
jump to class

getDocumentAccessOptions(
          
          )
        
        :
        array

Return supported document access options

Output

array

Details

visibility: public
final: false
static: false
since: LiveDocx 1.2 Premium

getDocumentFormats
jump to class

getDocumentFormats(
          
          )
        
        :
        array

Return supported document formats (lowercase)

Output

array

Details

visibility: public
final: false
static: false
since: LiveDocx 1.1

getFieldNames
jump to class

getFieldNames(
          
          )
        
        :
        array

Return all the fields in the template

Output

array

Details

visibility: public
final: false
static: false
since: LiveDocx 1.0

getFontNames
jump to class

getFontNames(
          
          )
        
        :
        array

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

Output

array

Details

visibility: public
final: false
static: false
since: LiveDocx 1.2

getImageFormats
jump to class

getImageFormats(
          
          )
        
        :

Details

visibility: public
final: false
static: false

getMetafiles
jump to class

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

Arguments

$fromPage: integer
$toPage: integer

Output

array

Details

visibility: public
final: false
static: false
since: LiveDocx 1.2

getTemplateFormats
jump to class

getTemplateFormats(
          
          )
        
        :
        array

Return supported template formats (lowercase)

Output

array

Details

visibility: public
final: false
static: false
since: LiveDocx 1.0

listSharedDocuments
jump to class

listSharedDocuments(
          
          )
        
        :
        array

List all shared documents stored on LiveDocx service

Output

array

Details

visibility: public
final: false
static: false
since: LiveDocx 1.0

listTemplates
jump to class

listTemplates(
          
          )
        
        :
        array

List all templates stored on LiveDocx service

Output

array

Details

visibility: public
final: false
static: false
since: LiveDocx 1.0

multiAssocArrayToArrayOfArrayOfString
jump to class

multiAssocArrayToArrayOfArrayOfString(
          array $multi
          )
        
        :
        array

Convert multi assoc array to required SOAP type

Arguments

$multi: array

Output

array

Details

visibility: public
final: false
static: true
since: LiveDocx 1.0

retrieveDocument
jump to class

retrieveDocument(
          string $format
          )
        
        :
        binary

Retrieve document in specified format

Arguments

$format: string

Output

binary

Details

visibility: public
final: false
static: false
since: LiveDocx 1.0
throws

setBlockFieldValues
jump to class

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

Set block field values

Arguments

$blockName: string
$blockFieldValues: array

Output

Zend_Service_LiveDocx_MailMerge

Details

visibility: public
final: false
static: false
since: LiveDocx 1.0
throws

setDocumentAccessPermissions
jump to class

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

Arguments

$permissions: array
$password: string

Output

Zend_Service_LiveDocx_MailMerge

Details

visibility: public
final: false
static: false
since: LiveDocx 1.2 Premium
throws

setDocumentPassword
jump to class

setDocumentPassword(
          string $password
          )
        
        :
        Zend_Service_LiveDocx_MailMerge

Set a password to open to document

This method can only be used for PDF documents

Arguments

$password: string

Output

Zend_Service_LiveDocx_MailMerge

Details

visibility: public
final: false
static: false
since: LiveDocx 1.2 Premium
throws

setFieldValue
jump to class

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

Set an array of key and value or array of values

Arguments

$field: string
$value: arraystring

Output

Zend_Service_LiveDocx_MailMerge

Details

visibility: public
final: false
static: false
since: LiveDocx 1.0
throws

setFieldValues
jump to class

setFieldValues(
          array $values
          )
        
        :
        Zend_Service_LiveDocx_MailMerge

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

Arguments

$values: array

Output

Zend_Service_LiveDocx_MailMerge

Details

visibility: public
final: false
static: false
since: LiveDocx 1.0
throws

setLocalTemplate
jump to class

setLocalTemplate(
          string $filename
          )
        
        :
        Zend_Service_LiveDocx_MailMerge

Set the filename of a LOCAL template (i.e. a template stored locally on YOUR server)

Arguments

$filename: string

Output

Zend_Service_LiveDocx_MailMerge

Details

visibility: public
final: false
static: false
since: LiveDocx 1.0
throws

setRemoteTemplate
jump to class

setRemoteTemplate(
          string $filename
          )
        
        :
        Zend_Service_LiveDocx_MailMerge

Set the filename of a REMOTE template (i.e. a template stored remotely on the LIVEDOCX server)

Arguments

$filename: string

Output

Zend_Service_LiveDocx_MailMerge

Details

visibility: public
final: false
static: false
since: LiveDocx 1.0
throws

shareDocument
jump to class

shareDocument(
          
          )
        
        :
        string

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

Output

string

Details

visibility: public
final: false
static: false
since: LiveDocx 1.0

sharedDocumentExists
jump to class

sharedDocumentExists(
          string $filename
          )
        
        :
        boolean

Check whether a shared document is available on LiveDocx service

Arguments

$filename: string

Output

boolean

Details

visibility: public
final: false
static: false
since: LiveDocx 1.0

templateExists
jump to class

templateExists(
          string $filename
          )
        
        :
        boolean

Check whether a template file is available on LiveDocx service

Arguments

$filename: string

Output

boolean

Details

visibility: public
final: false
static: false
since: LiveDocx 1.0

uploadTemplate
jump to class

uploadTemplate(
          string $filename
          )
        
        :
        void

Upload a template file to LiveDocx service

Arguments

$filename: string

Details

visibility: public
final: false
static: false
since: LiveDocx 1.0
throws

API Documentation

Service/LiveDocx/MailMerge.php

Description

Zend_Service_LiveDocx_MailMergejump to top

Description

Constants

WSDLjump to class

Details

Properties

$_blockFieldValuesjump to class

Details

$_fieldValuesjump to class

Details

Methods

__constructjump to class

Arguments

Output

Details

_backendListArrayToMultiAssocArrayjump to class

Arguments

Output

Details

assignjump to class

Arguments

Output

Details

assocArrayToArrayOfArrayOfStringjump to class

Arguments

Output

Details

createDocumentjump to class

Details

deleteSharedDocumentjump to class

Arguments

Details

deleteTemplatejump to class

Arguments

Details

downloadSharedDocumentjump to class

Arguments

Details

downloadTemplatejump to class

Arguments

Output

Details

getAllBitmapsjump to class

Arguments

Output

Details

getAllMetafilesjump to class

Output

Details

getBitmapsjump to class

Arguments

Output

Details

getBlockFieldNamesjump to class

Arguments

Output

Details

getBlockNamesjump to class

Output

Details

getDocumentAccessOptionsjump to class

Output

Details

getDocumentFormatsjump to class

Output

Details

getFieldNamesjump to class

Output

Details

getFontNamesjump to class

Output

Details

getImageFormatsjump to class

Details

getMetafilesjump to class

Arguments

Output

Zend_Service_LiveDocx_MailMerge
jump to top

WSDL
jump to class

$_blockFieldValues
jump to class

$_fieldValues
jump to class

__construct
jump to class

_backendListArrayToMultiAssocArray
jump to class

assign
jump to class

assocArrayToArrayOfArrayOfString
jump to class

createDocument
jump to class

deleteSharedDocument
jump to class

deleteTemplate
jump to class

downloadSharedDocument
jump to class

downloadTemplate
jump to class

getAllBitmaps
jump to class

getAllMetafiles
jump to class

getBitmaps
jump to class

getBlockFieldNames
jump to class

getBlockNames
jump to class

getDocumentAccessOptions
jump to class

getDocumentFormats
jump to class

getFieldNames
jump to class

getFontNames
jump to class

getImageFormats
jump to class

getMetafiles
jump to class

getTemplateFormats
jump to class

listSharedDocuments
jump to class

listTemplates
jump to class

multiAssocArrayToArrayOfArrayOfString
jump to class

retrieveDocument
jump to class

setBlockFieldValues
jump to class

setDocumentAccessPermissions
jump to class

setDocumentPassword
jump to class

setFieldValue
jump to class

setFieldValues
jump to class

setLocalTemplate
jump to class

setRemoteTemplate
jump to class

shareDocument
jump to class

sharedDocumentExists
jump to class

templateExists
jump to class

uploadTemplate
jump to class