CRM_Contact_Form_Task_ProximityCommon
in package
This class provides the functionality to support Proximity Searches.
Table of Contents
Properties
- $_context : string
- The context that we are working on.
- $_id : int
- The groupId retrieved from the GET vars.
- $_title : string
- The title of the group.
Methods
- buildQuickForm() : mixed
- Build the form object.
- formRule() : bool|array<string|int, mixed>
- Global form rule.
- setDefaultValues() : array<string|int, mixed>
- Set the default form values.
Properties
$_context
The context that we are working on.
protected
string
$_context
$_id
The groupId retrieved from the GET vars.
protected
int
$_id
$_title
The title of the group.
protected
string
$_title
Methods
buildQuickForm()
Build the form object.
public
static buildQuickForm(CRM_Core_Form $form, int $proxSearch) : mixed
Parameters
- $form : CRM_Core_Form
- $proxSearch : int
formRule()
Global form rule.
public
static formRule(array<string|int, mixed> $fields, array<string|int, mixed> $files, CRM_Core_Form $form) : bool|array<string|int, mixed>
Parameters
- $fields : array<string|int, mixed>
-
The input form values.
- $files : array<string|int, mixed>
-
The uploaded files if any.
- $form : CRM_Core_Form
Return values
bool|array<string|int, mixed> —true if no errors, else array of errors
setDefaultValues()
Set the default form values.
public
static setDefaultValues(CRM_Core_Form $form) : array<string|int, mixed>
Parameters
- $form : CRM_Core_Form
Return values
array<string|int, mixed> —the default array reference