CRM_Member_Form_Task_PDFLetterCommon

class CRM_Member_Form_Task_PDFLetterCommon extends CRM_Contact_Form_Task_PDFLetterCommon

This class provides the common functionality for creating PDF letter for members

Methods

static array
getLoggingOptions()

No description

from CRM_Contact_Form_Task_PDFLetterCommon
static 
preProcess(CRM_Core_Form $form)

Build all the data structures needed to build the form.

from CRM_Contact_Form_Task_PDFLetterCommon
static 
preProcessSingle(CRM_Core_Form $form, int $cid)

No description

from CRM_Contact_Form_Task_PDFLetterCommon
static 
buildQuickForm($form)

Build the form object.

from CRM_Contact_Form_Task_PDFLetterCommon
static 
setDefaultValues()

Set default values.

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

Form rule.

from CRM_Contact_Form_Task_PDFLetterCommon
static array
processMessageTemplate(array $formValues)

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

from CRM_Contact_Form_Task_PDFLetterCommon
static 
postProcess(CRM_Core_Form $form)

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

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

No description

from CRM_Contact_Form_Task_PDFLetterCommon
static 
formatMessage($message)

No description

from CRM_Contact_Form_Task_PDFLetterCommon
static 
postProcessMembers(CRM_Core_Form $form, $membershipIDs, $skipOnHold, $skipDeceased, $contactIDs)

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

static array
generateHTML(array $membershipIDs, array $returnProperties, bool $skipOnHold, bool $skipDeceased, array $messageToken, $html_message, $categories)

Generate htmlfor pdf letters.

Details

in CRM_Contact_Form_Task_PDFLetterCommon at line 43
static array getLoggingOptions()

Return Value

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

in CRM_Contact_Form_Task_PDFLetterCommon at line 58
static preProcess(CRM_Core_Form $form)

Build all the data structures needed to build the form.

Parameters

CRM_Core_Form $form

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

Parameters

CRM_Core_Form $form
int $cid

in CRM_Contact_Form_Task_PDFLetterCommon at line 89
static buildQuickForm($form)

Build the form object.

Parameters

$form

in CRM_Contact_Form_Task_PDFLetterCommon at line 220
static setDefaultValues()

Set default values.

in CRM_Contact_Form_Task_PDFLetterCommon 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.

in CRM_Contact_Form_Task_PDFLetterCommon 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]

in CRM_Contact_Form_Task_PDFLetterCommon 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

in CRM_Contact_Form_Task_PDFLetterCommon 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

in CRM_Contact_Form_Task_PDFLetterCommon at line 545
static formatMessage($message)

Parameters

$message

at line 20
static postProcessMembers(CRM_Core_Form $form, $membershipIDs, $skipOnHold, $skipDeceased, $contactIDs)

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

Parameters

CRM_Core_Form $form
$membershipIDs
$skipOnHold
$skipDeceased
$contactIDs

at line 56
static array generateHTML(array $membershipIDs, array $returnProperties, bool $skipOnHold, bool $skipDeceased, array $messageToken, $html_message, $categories)

Generate htmlfor pdf letters.

Parameters

array $membershipIDs
array $returnProperties
bool $skipOnHold
bool $skipDeceased
array $messageToken
$html_message
$categories

Return Value

array