CRM_Contact_Form_Edit_TagsAndGroups

class CRM_Contact_Form_Edit_TagsAndGroups

Constants

GROUP

Constant to determine which forms we are generating.

Used by both profile and edit contact
TAG

Constant to determine which forms we are generating.

Used by both profile and edit contact
ALL

Constant to determine which forms we are generating.

Used by both profile and edit contact

Methods

static 
buildQuickForm(CRM_Core_Form $form, int $contactId, int $type = self::ALL, bool $visibility = FALSE, null $isRequired = NULL, string $groupName = 'Group(s)', string $tagName = 'Tag(s)', string $fieldName = NULL, string $groupElementType = 'checkbox')

Build form elements.

static mixed
climbtree($form, $tree, $elements)

Climb tree.

static 
setDefaults(int $id, array $defaults, int $type = self::ALL, string $fieldName = NULL, string $groupElementType = 'checkbox')

Set defaults for relevant form elements.

static 
setDefaultValues(CRM_Core_Form $form, array $defaults)

Set default values for the form. Note that in edit/view mode the default values are retrieved from the database

Details

at line 64
static buildQuickForm(CRM_Core_Form $form, int $contactId, int $type = self::ALL, bool $visibility = FALSE, null $isRequired = NULL, string $groupName = 'Group(s)', string $tagName = 'Tag(s)', string $fieldName = NULL, string $groupElementType = 'checkbox')

Build form elements.

Parameters

CRM_Core_Form $form The form object that we are operating on.
int $contactId Contact id.
int $type What components are we interested in.
bool $visibility Visibility of the field.
null $isRequired
string $groupName If used for building group block.
string $tagName If used for building tag block.
string $fieldName This is used in batch profile(i.e to build multiple blocks).
string $groupElementType

at line 200
static mixed climbtree($form, $tree, $elements)

Climb tree.

Parameters

$form
$tree
$elements

Return Value

mixed

at line 230
static setDefaults(int $id, array $defaults, int $type = self::ALL, string $fieldName = NULL, string $groupElementType = 'checkbox')

Set defaults for relevant form elements.

Parameters

int $id The contact id.
array $defaults The defaults array to store the values in.
int $type What components are we interested in.
string $fieldName This is used in batch profile(i.e to build multiple blocks).
string $groupElementType

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

Set default values for the form. Note that in edit/view mode the default values are retrieved from the database

Parameters

CRM_Core_Form $form
array $defaults