Moodle  2.2.1
http://www.collinsharper.com
Public Member Functions | Static Public Member Functions | Data Fields | Protected Member Functions | Protected Attributes
Zend_Service_LiveDocx_MailMerge Class Reference
Inheritance diagram for Zend_Service_LiveDocx_MailMerge:
Inheritance graph
[legend]
Collaboration diagram for Zend_Service_LiveDocx_MailMerge:
Collaboration graph
[legend]

Public Member Functions

 __construct ($options=null)
 setLocalTemplate ($filename)
 setRemoteTemplate ($filename)
 setFieldValues ($values)
 setFieldValue ($field, $value)
 setBlockFieldValues ($blockName, $blockFieldValues)
 assign ($field, $value=null)
 setDocumentPassword ($password)
 setDocumentAccessPermissions ($permissions, $password)
 createDocument ()
 retrieveDocument ($format)
 getMetafiles ($fromPage, $toPage)
 getAllMetafiles ()
 getBitmaps ($fromPage, $toPage, $zoomFactor, $format)
 getAllBitmaps ($zoomFactor, $format)
 getFieldNames ()
 getBlockFieldNames ($blockName)
 getBlockNames ()
 uploadTemplate ($filename)
 downloadTemplate ($filename)
 deleteTemplate ($filename)
 listTemplates ()
 templateExists ($filename)
 shareDocument ()
 listSharedDocuments ()
 deleteSharedDocument ($filename)
 downloadSharedDocument ($filename)
 sharedDocumentExists ($filename)
 getTemplateFormats ()
 getDocumentFormats ()
 getImageFormats ()
 getFontNames ()
 getDocumentAccessOptions ()

Static Public Member Functions

static assocArrayToArrayOfArrayOfString ($assoc)
static multiAssocArrayToArrayOfArrayOfString ($multi)

Data Fields

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

Protected Member Functions

 _backendListArrayToMultiAssocArray ($list)

Protected Attributes

 $_fieldValues
 $_blockFieldValues

Detailed Description

Definition at line 37 of file MailMerge.php.

Constructor & Destructor Documentation

__construct ( $  options = null)

Constructor (LiveDocx.MailMerge SOAP Service)

Returns:
void
throws Zend_Service_LiveDocx_Exception
Since:
LiveDocx 1.0

Reimplemented from Zend_Service_LiveDocx.

Definition at line 68 of file MailMerge.php.

Member Function Documentation

_backendListArrayToMultiAssocArray ( $  list) [protected]

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

Parameters:
array$list
Returns:
array
Since:
LiveDocx 1.0

Definition at line 910 of file MailMerge.php.

Here is the call graph for this function:

Here is the caller graph for this function:

assign ( $  field,
$  value = null 
)

Assign values to template fields

Parameters:
array | string$field
array | string$value
Returns:
Zend_Service_LiveDocx_MailMerge
Exceptions:
Zend_Service_LiveDocx_Exception
Since:
LiveDocx 1.0

Definition at line 222 of file MailMerge.php.

Here is the call graph for this function:

static assocArrayToArrayOfArrayOfString ( $  assoc) [static]

Convert assoc array to required SOAP type

Parameters:
array$assoc
Returns:
array
Since:
LiveDocx 1.0

Definition at line 950 of file MailMerge.php.

createDocument ( )

Merge assigned data with template to generate document

Exceptions:
Zend_Service_LiveDocx_Excpetion
Returns:
void
Since:
LiveDocx 1.0

Definition at line 324 of file MailMerge.php.

Here is the call graph for this function:

deleteSharedDocument ( $  filename)

Delete a shared document from LiveDocx service

Parameters:
string$filename
Returns:
void
Since:
LiveDocx 1.0

Definition at line 740 of file MailMerge.php.

Here is the call graph for this function:

deleteTemplate ( $  filename)

Delete a template file from LiveDocx service

Parameters:
string$filename
Returns:
void
Exceptions:
Zend_Service_LiveDocx_Exception
Since:
LiveDocx 1.0

Definition at line 644 of file MailMerge.php.

Here is the call graph for this function:

downloadSharedDocument ( $  filename)

Definition at line 757 of file MailMerge.php.

Here is the call graph for this function:

downloadTemplate ( $  filename)

Download template file from LiveDocx service

Parameters:
string$filename
Returns:
binary
Exceptions:
Zend_Service_LiveDocx_Exception
Since:
LiveDocx 1.0

Definition at line 618 of file MailMerge.php.

Here is the call graph for this function:

getAllBitmaps ( $  zoomFactor,
$  format 
)

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

Parameters:
integer$zoomFactor
string$format
Returns:
array
Since:
LiveDocx 1.2

Definition at line 485 of file MailMerge.php.

Here is the call graph for this function:

getAllMetafiles ( )

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

Returns:
array
Since:
LiveDocx 1.2

Definition at line 415 of file MailMerge.php.

Here is the call graph for this function:

getBitmaps ( $  fromPage,
$  toPage,
$  zoomFactor,
$  format 
)

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

Parameters:
integer$fromPage
integer$toPage
integer$zoomFactor
string$format
Returns:
array
Since:
LiveDocx 1.2

Definition at line 448 of file MailMerge.php.

Here is the call graph for this function:

getBlockFieldNames ( $  blockName)

Return all the block fields in the template

Parameters:
string$blockName
Returns:
array
Since:
LiveDocx 1.0

Definition at line 541 of file MailMerge.php.

Here is the call graph for this function:

getBlockNames ( )

Return all the block fields in the template

Returns:
array
Since:
LiveDocx 1.0

Definition at line 567 of file MailMerge.php.

Here is the call graph for this function:

getDocumentAccessOptions ( )

Return supported document access options

Returns:
array
Since:
LiveDocx 1.2 Premium

Definition at line 889 of file MailMerge.php.

Here is the call graph for this function:

getDocumentFormats ( )

Return supported document formats (lowercase)

Returns:
array
Since:
LiveDocx 1.1

Definition at line 827 of file MailMerge.php.

Here is the call graph for this function:

getFieldNames ( )

Return all the fields in the template

Returns:
array
Since:
LiveDocx 1.0

Definition at line 516 of file MailMerge.php.

Here is the call graph for this function:

getFontNames ( )

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

Returns:
array
Since:
LiveDocx 1.2

Definition at line 869 of file MailMerge.php.

Here is the call graph for this function:

getImageFormats ( )

Definition at line 848 of file MailMerge.php.

Here is the call graph for this function:

getMetafiles ( $  fromPage,
$  toPage 
)

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:
integer$fromPage
integer$toPage
Returns:
array
Since:
LiveDocx 1.2

Definition at line 383 of file MailMerge.php.

Here is the call graph for this function:

getTemplateFormats ( )

Return supported template formats (lowercase)

Returns:
array
Since:
LiveDocx 1.0

Definition at line 806 of file MailMerge.php.

Here is the call graph for this function:

listSharedDocuments ( )

List all shared documents stored on LiveDocx service

Returns:
array
Since:
LiveDocx 1.0

Definition at line 717 of file MailMerge.php.

Here is the call graph for this function:

Here is the caller graph for this function:

listTemplates ( )

List all templates stored on LiveDocx service

Returns:
array
Since:
LiveDocx 1.0

Definition at line 659 of file MailMerge.php.

Here is the call graph for this function:

static multiAssocArrayToArrayOfArrayOfString ( $  multi) [static]

Convert multi assoc array to required SOAP type

Parameters:
array$multi
Returns:
array
Since:
LiveDocx 1.0

Definition at line 965 of file MailMerge.php.

retrieveDocument ( $  format)

Retrieve document in specified format

Parameters:
string$format
Exceptions:
Zend_Service_LiveDocx_Exception
Returns:
binary
Since:
LiveDocx 1.0

Definition at line 354 of file MailMerge.php.

Here is the call graph for this function:

setBlockFieldValues ( $  blockName,
$  blockFieldValues 
)

Set block field values

Parameters:
string$blockName
array$blockFieldValues
Returns:
Zend_Service_LiveDocx_MailMerge
Exceptions:
Zend_Service_LiveDocx_Exception
Since:
LiveDocx 1.0

Definition at line 194 of file MailMerge.php.

Here is the call graph for this function:

Here is the caller graph for this function:

setDocumentAccessPermissions ( $  permissions,
$  password 
)

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:
array$permissions
string$password
Returns:
Zend_Service_LiveDocx_MailMerge
Exceptions:
Zend_Service_LiveDocx_Exception
Since:
LiveDocx 1.2 Premium

Definition at line 298 of file MailMerge.php.

Here is the call graph for this function:

setDocumentPassword ( $  password)

Set a password to open to document

This method can only be used for PDF documents

Parameters:
string$password
Returns:
Zend_Service_LiveDocx_MailMerge
Exceptions:
Zend_Service_LiveDocx_Exception
Since:
LiveDocx 1.2 Premium

Definition at line 254 of file MailMerge.php.

Here is the call graph for this function:

setFieldValue ( $  field,
$  value 
)

Set an array of key and value or array of values

Parameters:
string$field
array | string$value
Exceptions:
Zend_Service_LiveDocx_Exception
Returns:
Zend_Service_LiveDocx_MailMerge
Since:
LiveDocx 1.0

Definition at line 177 of file MailMerge.php.

Here is the caller graph for this function:

setFieldValues ( $  values)

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

Parameters:
array$values
Returns:
Zend_Service_LiveDocx_MailMerge
Exceptions:
Zend_Service_LiveDocx_Exception
Since:
LiveDocx 1.0

Definition at line 140 of file MailMerge.php.

Here is the call graph for this function:

Here is the caller graph for this function:

setLocalTemplate ( $  filename)

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

Parameters:
string$filename
Returns:
Zend_Service_LiveDocx_MailMerge
Exceptions:
Zend_Service_LiveDocx_Exception
Since:
LiveDocx 1.0

Definition at line 86 of file MailMerge.php.

Here is the call graph for this function:

setRemoteTemplate ( $  filename)

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

Parameters:
string$filename
Returns:
Zend_Service_LiveDocx_MailMerge
Exceptions:
Zend_Service_LiveDocx_Exception
Since:
LiveDocx 1.0

Definition at line 114 of file MailMerge.php.

Here is the call graph for this function:

sharedDocumentExists ( $  filename)

Check whether a shared document is available on LiveDocx service

Parameters:
string$filename
Returns:
boolean
Since:
LiveDocx 1.0

Definition at line 782 of file MailMerge.php.

Here is the call graph for this function:

shareDocument ( )

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

Returns:
string
Since:
LiveDocx 1.0

Definition at line 697 of file MailMerge.php.

Here is the call graph for this function:

templateExists ( $  filename)

Check whether a template file is available on LiveDocx service

Parameters:
string$filename
Returns:
boolean
Since:
LiveDocx 1.0

Definition at line 680 of file MailMerge.php.

Here is the call graph for this function:

uploadTemplate ( $  filename)

Upload a template file to LiveDocx service

Parameters:
string$filename
Returns:
void
Exceptions:
Zend_Service_LiveDocx_Exception
Since:
LiveDocx 1.0

Definition at line 593 of file MailMerge.php.

Here is the call graph for this function:

Field Documentation

$_blockFieldValues [protected]

Definition at line 59 of file MailMerge.php.

$_fieldValues [protected]

Definition at line 51 of file MailMerge.php.

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

URI of LiveDocx.MailMerge WSDL

Since:
LiveDocx 1.0

Definition at line 43 of file MailMerge.php.

The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Enumerations