CRM_Core_Form_Task_PDFLetterCommon

class CRM_Core_Form_Task_PDFLetterCommon

This is the base class for common PDF/Doc Merge functionality.

Most CRM_*_Form_Task_PDFLetterCommon classes extend the Contact version but the assumptions there are not always appropriate for other classes resulting in code duplication and unexpected dependencies. The intention is that common functionality can be moved here and the other classes cleaned up. Keep old-style token handling out of this class.

Methods

static 
preProcess($form)

No description

static 
buildQuickForm($form)

Build the form object.

static 
setDefaultValues()

Set default values.

static bool
formRule(array $fields, array $files, array $self)

Form rule.

static 
processTemplate($formValues)

Handle the template processing part of the form

static 
formatMessage($message)

No description

Details

at line 48
static preProcess($form)

Parameters

$form

at line 57
static buildQuickForm($form)

Build the form object.

Parameters

$form

at line 188
static setDefaultValues()

Set default values.

at line 206
static bool formRule(array $fields, array $files, array $self)

Form rule.

Parameters

array $fields The input form values.
array $files
array $self Additional values form 'this'.

Return Value

bool TRUE if no errors, else array of errors.

at line 239
static processTemplate($formValues)

Handle the template processing part of the form

Parameters

$formValues

at line 299
static formatMessage($message)

Parameters

$message