[ Index ]

PHP Cross Reference of moodle-2.8

title

Body

[close]

/lib/zend/Zend/Service/LiveDocx/ -> MailMerge.php (summary)

Zend Framework LICENSE

Copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
License: http://framework.zend.com/license/new-bsd New BSD License
Version: $Id$
File Size: 978 lines (28 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Zend_Service_LiveDocx_MailMerge:: (36 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()


Class: Zend_Service_LiveDocx_MailMerge  - X-Ref


__construct($options = null)   X-Ref
Constructor (LiveDocx.MailMerge SOAP Service)

return: void
return: throws Zend_Service_LiveDocx_Exception

setLocalTemplate($filename)   X-Ref
Set the filename of a LOCAL template
(i.e. a template stored locally on YOUR server)

param: string $filename
return: Zend_Service_LiveDocx_MailMerge

setRemoteTemplate($filename)   X-Ref
Set the filename of a REMOTE template
(i.e. a template stored remotely on the LIVEDOCX server)

param: string $filename
return: Zend_Service_LiveDocx_MailMerge

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

param: array $values
return: Zend_Service_LiveDocx_MailMerge

setFieldValue($field, $value)   X-Ref
Set an array of key and value or array of values

param: string $field
param: array|string $value
return: Zend_Service_LiveDocx_MailMerge

setBlockFieldValues($blockName, $blockFieldValues)   X-Ref
Set block field values

param: string $blockName
param: array $blockFieldValues
return: Zend_Service_LiveDocx_MailMerge

assign($field, $value = null)   X-Ref
Assign values to template fields

param: array|string $field
param: array|string $value
return: Zend_Service_LiveDocx_MailMerge

setDocumentPassword($password)   X-Ref
Set a password to open to document

This method can only be used for PDF documents

param: string  $password
return: Zend_Service_LiveDocx_MailMerge

setDocumentAccessPermissions($permissions, $password)   X-Ref
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

param: array  $permissions
param: string $password
return: Zend_Service_LiveDocx_MailMerge

createDocument()   X-Ref
Merge assigned data with template to generate document

return: void

retrieveDocument($format)   X-Ref
Retrieve document in specified format

param: string $format
return: binary

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

param: integer $fromPage
param: integer $toPage
return: array

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

return: array

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

param: integer $fromPage
param: integer $toPage
param: integer $zoomFactor
param: string  $format
return: array

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

param: integer $zoomFactor
param: string  $format
return: array

getFieldNames()   X-Ref
Return all the fields in the template

return: array

getBlockFieldNames($blockName)   X-Ref
Return all the block fields in the template

param: string $blockName
return: array

getBlockNames()   X-Ref
Return all the block fields in the template

return: array

uploadTemplate($filename)   X-Ref
Upload a template file to LiveDocx service

param: string $filename
return: void

downloadTemplate($filename)   X-Ref
Download template file from LiveDocx service

param: string $filename
return: binary

deleteTemplate($filename)   X-Ref
Delete a template file from LiveDocx service

param: string $filename
return: void

listTemplates()   X-Ref
List all templates stored on LiveDocx service

return: array

templateExists($filename)   X-Ref
Check whether a template file is available on LiveDocx service

param: string $filename
return: boolean

shareDocument()   X-Ref
Share a document - i.e. the document is available to all over the Internet

return: string

listSharedDocuments()   X-Ref
List all shared documents stored on LiveDocx service

return: array

deleteSharedDocument($filename)   X-Ref
Delete a shared document from LiveDocx service

param: string $filename
return: void

downloadSharedDocument($filename)   X-Ref
No description

sharedDocumentExists($filename)   X-Ref
Check whether a shared document is available on LiveDocx service

param: string $filename
return: boolean

getTemplateFormats()   X-Ref
Return supported template formats (lowercase)

return: array

getDocumentFormats()   X-Ref
Return supported document formats (lowercase)

return: array

getImageFormats()   X-Ref
No description

getFontNames()   X-Ref
Return the names of all fonts that are installed on backend server

return: array

getDocumentAccessOptions()   X-Ref
Return supported document access options

return: array

_backendListArrayToMultiAssocArray($list)   X-Ref
Convert LiveDocx service return value from list methods to consistent PHP array

param: array $list
return: array

assocArrayToArrayOfArrayOfString($assoc)   X-Ref
Convert assoc array to required SOAP type

param: array $assoc
return: array

multiAssocArrayToArrayOfArrayOfString($multi)   X-Ref
Convert multi assoc array to required SOAP type

param: array $multi
return: array



Generated: Fri Nov 28 20:29:05 2014 Cross-referenced by PHPXref 0.7.1