CRM_Core_Form_RecurringEntity
in package
This class generates form components for processing Entity.
Table of Contents
Properties
- $_entityTable : string
- Entity Table
- $_excludeDateInfo : array<string|int, mixed>
- Exclude date information
- $_hasParent : string
- Checks current entityID has parent
- $_entityId : int
- Current entity id
- $_parentEntityId : int
- Parent Entity ID
- $_scheduleReminderDetails : CRM_Core_DAO|null
- Schedule Reminder data
- $_scheduleReminderID : int
- Schedule Reminder ID
- $preDeleteFunction : mixed
Methods
- buildQuickForm() : mixed
- Build form.
- formRule() : array<string|int, mixed>
- Global validation rules for the form.
- getTitle() : string
- Return a descriptive name for the page, used in wizard header
- postProcess() : mixed
- Process the form submission.
- preProcess() : mixed
- setDefaultValues() : array<string|int, mixed>
- Set default values for the form. For edit/view mode the default values are retrieved from the database
Properties
$_entityTable
Entity Table
public
static string
$_entityTable
$_excludeDateInfo
Exclude date information
public
static array<string|int, mixed>
$_excludeDateInfo
= []
$_hasParent
Checks current entityID has parent
public
static string
$_hasParent
= \FALSE
$_entityId
Current entity id
protected
static int
$_entityId
= \NULL
$_parentEntityId
Parent Entity ID
protected
static int
$_parentEntityId
= \NULL
$_scheduleReminderDetails
Schedule Reminder data
protected
static CRM_Core_DAO|null
$_scheduleReminderDetails
= \NULL
$_scheduleReminderID
Schedule Reminder ID
protected
static int
$_scheduleReminderID
= \NULL
$preDeleteFunction
private
static mixed
$preDeleteFunction
= ['Event' => 'CRM_Event_Form_ManageEvent_Repeat::checkRegistrationForEvents', 'Activity' => \NULL]
Methods
buildQuickForm()
Build form.
public
static buildQuickForm(CRM_Core_Form &$form) : mixed
Parameters
- $form : CRM_Core_Form
formRule()
Global validation rules for the form.
public
static formRule(array<string|int, mixed> $values) : array<string|int, mixed>
Parameters
- $values : array<string|int, mixed>
-
Posted values of the form.
Return values
array<string|int, mixed> —list of errors to be posted back to the form
getTitle()
Return a descriptive name for the page, used in wizard header
public
getTitle() : string
Return values
stringpostProcess()
Process the form submission.
public
static postProcess(array<string|int, mixed> $params, string $type[, array<string|int, mixed> $linkedEntities = [] ]) : mixed
Parameters
- $params : array<string|int, mixed>
- $type : string
-
Redundant - always the same as
$params['entity_table'] - $linkedEntities : array<string|int, mixed> = []
Tags
preProcess()
public
static preProcess(mixed $entityTable) : mixed
Parameters
- $entityTable : mixed
setDefaultValues()
Set default values for the form. For edit/view mode the default values are retrieved from the database
public
static setDefaultValues() : array<string|int, mixed>