CRM_Contact_Form_Edit_Address

class CRM_Contact_Form_Edit_Address

This class is used to build address block.

Methods

static 
buildQuickForm(CRM_Core_Form $form, int $addressBlockCount = NULL, bool $sharing = TRUE, bool $inlineEdit = FALSE)

Build form for address input fields.

static array|bool
formRule(array $fields, array $files = [], CRM_Core_Form $self = NULL)

Check for correct state / country mapping.

static 
setDefaultValues(array $defaults, CRM_Core_Form $form)

Set default values for address block.

static 
storeRequiredCustomDataInfo(CRM_Core_Form $form, array $groupTree)

Store required custom data info.

static 
addCustomDataToForm(CRM_Core_Form $form, int $entityId, int $blockId)

Add custom data to the form.

Details

at line 52
static buildQuickForm(CRM_Core_Form $form, int $addressBlockCount = NULL, bool $sharing = TRUE, bool $inlineEdit = FALSE)

Build form for address input fields.

Parameters

CRM_Core_Form $form
int $addressBlockCount The index of the address array (if multiple addresses on a page).
bool $sharing False, if we want to skip the address sharing features.
bool $inlineEdit True when edit used in inline edit.

Exceptions

CiviCRM_API3_Exception

at line 189
static array|bool formRule(array $fields, array $files = [], CRM_Core_Form $self = NULL)

Check for correct state / country mapping.

Parameters

array $fields
array $files
CRM_Core_Form $self

Return Value

array|bool if no errors

at line 245
static setDefaultValues(array $defaults, CRM_Core_Form $form)

Set default values for address block.

Parameters

array $defaults Defaults associated array.
CRM_Core_Form $form Form object.

at line 366
static storeRequiredCustomDataInfo(CRM_Core_Form $form, array $groupTree)

Store required custom data info.

Parameters

CRM_Core_Form $form
array $groupTree

at line 400
static protected addCustomDataToForm(CRM_Core_Form $form, int $entityId, int $blockId)

Add custom data to the form.

Parameters

CRM_Core_Form $form
int $entityId
int $blockId

Exceptions

CRM_Core_Exception
CiviCRM_API3_Exception