CRM_Contact_Form_Task_PDFLetterCommon

class CRM_Contact_Form_Task_PDFLetterCommon

This class provides the common functionality for creating PDF letter for one or a group of contact ids.

Methods

static array
getLoggingOptions()

No description

static 
preProcess(CRM_Core_Form $form)

Build all the data structures needed to build the form.

static 
preProcessSingle(CRM_Core_Form $form, int $cid)

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 array
processMessageTemplate(array $formValues)

Part of the post process which prepare and extract information from the template.

static 
postProcess(CRM_Core_Form $form)

Process the form after the input has been submitted and validated.

static array
createActivities(CRM_Core_Form $form, string $html_message, array $contactIds)

No description

static 
formatMessage($message)

No description

Details

at line 43
static array getLoggingOptions()

Return Value

array Array(string $machineName => string $label).

at line 58
static preProcess(CRM_Core_Form $form)

Build all the data structures needed to build the form.

Parameters

CRM_Core_Form $form

at line 78
static preProcessSingle(CRM_Core_Form $form, int $cid)

Parameters

CRM_Core_Form $form
int $cid

at line 89
static buildQuickForm($form)

Build the form object.

Parameters

$form

at line 220
static setDefaultValues()

Set default values.

at line 238
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 277
static array processMessageTemplate(array $formValues)

Part of the post process which prepare and extract information from the template.

Parameters

array $formValues

Return Value

array [$categories, $html_message, $messageToken, $returnProperties]

at line 356
static postProcess(CRM_Core_Form $form)

Process the form after the input has been submitted and validated.

Parameters

CRM_Core_Form $form

at line 473
static array createActivities(CRM_Core_Form $form, string $html_message, array $contactIds)

Parameters

CRM_Core_Form $form
string $html_message
array $contactIds

Return Value

array List of activity IDs. There may be 1 or more, depending on the system-settings and use-case.

Exceptions

CRM_Core_Exception

at line 545
static formatMessage($message)

Parameters

$message