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.

__construct(
$options
=
null
)
:
void\throws
Constructor (LiveDocx.MailMerge SOAP Service)
Name | Type | Description |
---|---|---|
$options |
Type | Description |
---|---|
void\throws | Zend_Service_LiveDocx_Exception |

_backendListArrayToMultiAssocArray(
array $list
)
:
array
Convert LiveDocx service return value from list methods to consistent PHP array
Name | Type | Description |
---|---|---|
$list | array |
Type | Description |
---|---|
array |

assign(
array|string $field, array|string $value
=
null
)
:
\Zend_Service_LiveDocx_MailMerge
Assign values to template fields
Name | Type | Description |
---|---|---|
$field | array|string | |
$value | array|string |
Type | Description |
---|---|
\Zend_Service_LiveDocx_MailMerge |
Exception | Description |
---|---|
\Zend_Service_LiveDocx_Exception |

assocArrayToArrayOfArrayOfString(
array $assoc
)
:
array
Convert assoc array to required SOAP type
Name | Type | Description |
---|---|---|
$assoc | array |
Type | Description |
---|---|
array |

createDocument(
)
:
void
Merge assigned data with template to generate document
Exception | Description |
---|---|
\Zend_Service_LiveDocx_Excpetion |

deleteImage(
string $filename
)
:
void
Delete an image file from LiveDocx service
Name | Type | Description |
---|---|---|
$filename | string |
Exception | Description |
---|---|
\Zend_Service_LiveDocx_Exception |

deleteSharedDocument(
string $filename
)
:
void
Delete a shared document from LiveDocx service
Name | Type | Description |
---|---|---|
$filename | string |

deleteTemplate(
string $filename
)
:
void
Delete a template file from LiveDocx service
Name | Type | Description |
---|---|---|
$filename | string |
Exception | Description |
---|---|
\Zend_Service_LiveDocx_Exception |

downloadImage(
string $filename
)
:
void
Download an image file from LiveDocx service
Name | Type | Description |
---|---|---|
$filename | string |
Exception | Description |
---|---|
\Zend_Service_LiveDocx_Exception |

downloadTemplate(
string $filename
)
:
\binary
Download template file from LiveDocx service
Name | Type | Description |
---|---|---|
$filename | string |
Type | Description |
---|---|
\binary |
Exception | Description |
---|---|
\Zend_Service_LiveDocx_Exception |

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
Name | Type | Description |
---|---|---|
$zoomFactor | integer | |
$format | string |
Type | Description |
---|---|
array |

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

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
Name | Type | Description |
---|---|---|
$fromPage | integer | |
$toPage | integer | |
$zoomFactor | integer | |
$format | string |
Type | Description |
---|---|
array |

getBlockFieldNames(
string $blockName
)
:
array
Return all the block fields in the template
Name | Type | Description |
---|---|---|
$blockName | string |
Type | Description |
---|---|
array |

getBlockNames(
)
:
array
Return all the block fields in the template
Type | Description |
---|---|
array |

getDocumentAccessOptions(
)
:
array
Return supported document access options
Type | Description |
---|---|
array |

getDocumentFormats(
)
:
array
Return supported document formats (lowercase)
Type | Description |
---|---|
array |

getFieldNames(
)
:
array
Return all the fields in the template
Type | Description |
---|---|
array |

getFontNames(
)
:
array
Return the names of all fonts that are installed on backend server
Type | Description |
---|---|
array |

getImageExportFormats(
)
:
array
Return supported image formats to which can be exported (lowercase)
Type | Description |
---|---|
array |

getImageImportFormats(
)
:
array
Return supported image formats from which can be imported (lowercase)
Type | Description |
---|---|
array |

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
Name | Type | Description |
---|---|---|
$fromPage | integer | |
$toPage | integer |
Type | Description |
---|---|
array |

getTemplateFormats(
)
:
array
Return supported template formats (lowercase)
Type | Description |
---|---|
array |

imageExists(
string $filename
)
:
boolean
Check whether an image file is available on LiveDocx service
Name | Type | Description |
---|---|---|
$filename | string |
Type | Description |
---|---|
boolean |

listImages(
)
:
array
List all images stored on LiveDocx service
Type | Description |
---|---|
array |

listSharedDocuments(
)
:
array
List all shared documents stored on LiveDocx service
Type | Description |
---|---|
array |

listTemplates(
)
:
array
List all templates stored on LiveDocx service
Type | Description |
---|---|
array |

multiAssocArrayToArrayOfArrayOfString(
array $multi
)
:
array
Convert multi assoc array to required SOAP type
Name | Type | Description |
---|---|---|
$multi | array |
Type | Description |
---|---|
array |

retrieveDocument(
string $format
)
:
\binary
Retrieve document in specified format
Name | Type | Description |
---|---|---|
$format | string |
Type | Description |
---|---|
\binary |
Exception | Description |
---|---|
\Zend_Service_LiveDocx_Exception |

setBlockFieldValues(
string $blockName, array $blockFieldValues
)
:
\Zend_Service_LiveDocx_MailMerge
Set block field values
Name | Type | Description |
---|---|---|
$blockName | string | |
$blockFieldValues | array |
Type | Description |
---|---|
\Zend_Service_LiveDocx_MailMerge |
Exception | Description |
---|---|
\Zend_Service_LiveDocx_Exception |

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
Name | Type | Description |
---|---|---|
$permissions | array | |
$password | string |
Type | Description |
---|---|
\Zend_Service_LiveDocx_MailMerge |
Exception | Description |
---|---|
\Zend_Service_LiveDocx_Exception |

setDocumentPassword(
string $password
)
:
\Zend_Service_LiveDocx_MailMerge
Set a password to open to document
This method can only be used for PDF documents
Name | Type | Description |
---|---|---|
$password | string |
Type | Description |
---|---|
\Zend_Service_LiveDocx_MailMerge |
Exception | Description |
---|---|
\Zend_Service_LiveDocx_Exception |

setFieldValue(
string $field, array|string $value
)
:
\Zend_Service_LiveDocx_MailMerge
Set an array of key and value or array of values
Name | Type | Description |
---|---|---|
$field | string | |
$value | array|string |
Type | Description |
---|---|
\Zend_Service_LiveDocx_MailMerge |
Exception | Description |
---|---|
\Zend_Service_LiveDocx_Exception |

setFieldValues(
array $values
)
:
\Zend_Service_LiveDocx_MailMerge
Set an associative or multi-associative array of keys and values pairs
Name | Type | Description |
---|---|---|
$values | array |
Type | Description |
---|---|
\Zend_Service_LiveDocx_MailMerge |
Exception | Description |
---|---|
\Zend_Service_LiveDocx_Exception |

setLocalTemplate(
string $filename
)
:
\Zend_Service_LiveDocx_MailMerge
Set the filename of a LOCAL template (i.e. a template stored locally on YOUR server)
Name | Type | Description |
---|---|---|
$filename | string |
Type | Description |
---|---|
\Zend_Service_LiveDocx_MailMerge |
Exception | Description |
---|---|
\Zend_Service_LiveDocx_Exception |

setRemoteTemplate(
string $filename
)
:
\Zend_Service_LiveDocx_MailMerge
Set the filename of a REMOTE template (i.e. a template stored remotely on the LIVEDOCX server)
Name | Type | Description |
---|---|---|
$filename | string |
Type | Description |
---|---|
\Zend_Service_LiveDocx_MailMerge |
Exception | Description |
---|---|
\Zend_Service_LiveDocx_Exception |

shareDocument(
)
:
string
Share a document - i.e. the document is available to all over the Internet
Type | Description |
---|---|
string |

sharedDocumentExists(
string $filename
)
:
boolean
Check whether a shared document is available on LiveDocx service
Name | Type | Description |
---|---|---|
$filename | string |
Type | Description |
---|---|
boolean |

templateExists(
string $filename
)
:
boolean
Check whether a template file is available on LiveDocx service
Name | Type | Description |
---|---|---|
$filename | string |
Type | Description |
---|---|
boolean |

uploadImage(
string $filename
)
:
void
Upload an image file to LiveDocx service
Name | Type | Description |
---|---|---|
$filename | string |
Exception | Description |
---|---|
\Zend_Service_LiveDocx_Exception |

uploadTemplate(
string $filename
)
:
void
Upload a template file to LiveDocx service
Name | Type | Description |
---|---|---|
$filename | string |
Exception | Description |
---|---|
\Zend_Service_LiveDocx_Exception |