Documentation

CRM_Report_Form_Contact_LoggingSummary extends CRM_Logging_ReportSummary
in package

CRM

Class CRM_Logging_ReportSummary

Constants

ATTR_SPACING = '     ': Constants for attributes for various form elements attempt to standardize on the number of variations that we use of the below form elements
CB_PREFIX = 'mark_x_': All checkboxes are defined with a common prefix. This allows us to have the same javascript to check / clear all the checkboxes etc If u have multiple groups of checkboxes, you will need to give them different ids to avoid potential name collision
CB_PREFIX_LEN = 7: All checkboxes are defined with a common prefix. This allows us to have the same javascript to check / clear all the checkboxes etc If u have multiple groups of checkboxes, you will need to give them different ids to avoid potential name collision
CB_PREFIY = 'mark_y_': All checkboxes are defined with a common prefix. This allows us to have the same javascript to check / clear all the checkboxes etc If u have multiple groups of checkboxes, you will need to give them different ids to avoid potential name collision
CB_PREFIZ = 'mark_z_': All checkboxes are defined with a common prefix. This allows us to have the same javascript to check / clear all the checkboxes etc If u have multiple groups of checkboxes, you will need to give them different ids to avoid potential name collision
OP_DATE = 4: Operator types - used for displaying filter elements
OP_DATETIME = 5: Operator types - used for displaying filter elements
OP_ENTITYREF = 256: Operator types - used for displaying filter elements
OP_FLOAT = 8: Operator types - used for displaying filter elements
OP_INT = 1: Operator types - used for displaying filter elements
OP_MONTH = 128: Operator types - used for displaying filter elements
OP_MULTISELECT = 65: Operator types - used for displaying filter elements
OP_MULTISELECT_SEPARATOR = 66: Operator types - used for displaying filter elements
OP_SELECT = 64: Operator types - used for displaying filter elements
OP_STRING = 2: Operator types - used for displaying filter elements
ROW_COUNT_LIMIT = 50: Deprecated constant, Reports should be updated to use the getRowCount function.

Properties

$_absoluteUrl : bool: Whether to generate absolute URLs (ex: in report emails).
$_action : int: (QUASI-PROTECTED) The mode of operation for this form
$_columnHeaders : mixed
$_dashBoardRowCount : int: DashBoardRowCount Dashboard row count.
$_defaults : array<string|int, mixed>: The default values for the form.
$_description : string: Report description.
$_drilldownReport : mixed
$_from : string: SQL from clause. May be altered by hook_civicrm_alterReportVar.
$_groupBy : mixed
$_having : mixed
$_havingClauses : mixed
$_navigation : array<string|int, mixed>: Navigation fields
$_options : array<string|int, mixed>: The set of optional columns in the report
$_orderBy : mixed
$_orderByArray : mixed
$_orderByFields : mixed
$_paymentProcessorIDs : array<string|int, mixed>: Available payment processors (IDS).
$_section : int
$_select : mixed
$_selectClauses : mixed
$_where : string: SQL where clause. May be altered by hook_civicrm_alterReportVar.
$_whereClauses : mixed
$ajaxResponse : array<string|int, mixed>: What to return to the client if in ajax mode (snippet=json)
$controller : CRM_Core_Controller
$expectedSmartyVariables : array<string|int, string>: Variables smarty expects to have set.
$html5Types : array<string|int, mixed>: Extra input types we support via the "add" method
$noController : bool: Is this being called without a form controller (ie. the report is being render outside the normal form - e.g the api is retrieving the rows.
$optimisedForOnlyFullGroupBy : mixed
$printOnly : bool: Are we in print mode. Can be set by another outputMode, ex: sendmail.
$submitOnce : bool
$urlPath : array<string|int, mixed>: Url path used to reach this page
$_aclFrom : string|null: Variables to hold the acl inner join and where clause
$_aclWhere : mixed
$_actionButtonName : string: Name of action button
$_add2groupSupported : mixed
$_addressField : bool: Is an address field selected.
$_aliases : array<string|int, mixed>
$_autoIncludeIndexedFieldsAsOrderBys : mixed
$_chartButtonName : mixed
$_chartId : int
$_charts : array<string|int, string>: Determines which chart types are supported for this report
$_columns : array<string|int, mixed>: The set of all columns in the report. An associative array with column name as the key and attributes as the value
$_createNew : bool: Create new report instance? (or update existing) on save.
$_createNewButtonName : mixed
$_criteriaForm : mixed
$_csvSupported : mixed
$_currencyColumn : string|null: Variable to hold the currency alias.
$_customGroupExtends : null: Object type that a custom group extends
$_customGroupExtendsJoin : mixed
$_customGroupFilters : mixed
$_customGroupGroupBy : mixed
$_customGroupJoin : mixed
$_databaseAttributes : string: Database attributes - character set and collation.
$_emailField : bool: Is an email field selected.
$_exposeContactID : bool: By default most reports hide contact id.
$_filters : array<string|int, mixed>: The set of filters in the report
$_force : mixed
$_format : string|null: Format of any chart in use.
$_formValues : mixed
$_fourColumnAttribute : array<string|int, mixed>: An attribute for checkbox/radio form field layout
$_grandFlag : mixed
$_groupButtonName : mixed
$_groupByArray : array<string|int, mixed>: Array of clauses to group by.
$_groupByDateFreq : array<string|int, mixed>: To what frequency group-by a date column
$_groupFilter : bool: Build groups filter.
$_groups : mixed
$_id : int: The id of the report instance
$_instanceButtonName : mixed
$_instanceForm : mixed
$_instanceValues : mixed
$_interval : string
$_limit : string: SQL Limit clause
$_limitValue : int: This can be set to specify a limit to the number of rows Since it is currently envisaged as part of the api usage it is only being applied when $_output mode is not 'html' or 'group' so as not to have to interpret / mess with that part of the code (see limit() fn.
$_logTables : mixed
$_name : string: The name of this form
$_noDisplay : array<string|int, mixed>: List of fields not to be displayed
$_noFields : mixed
$_noRepeats : array<string|int, mixed>: List of fields not to be repeated during display
$_offsetValue : int: This can be set to specify row offset See notes on _limitValue
$_outputMode : string: Output mode e.g 'print', 'csv', 'pdf'.
$_params : mixed
$_paymentProcessorID : int: Default or selected processor id.
$_paymentProcessors : array<string|int, mixed>: Available payment processors.
$_phoneField : bool: Is a phone field selected.
$_renderer : object: The renderer used for this form
$_resultSet : bool: When _storeResultSet Flag is set use this var to store result set in form of array
$_rollup : mixed
$_rowCount : int: The Number of rows to display on screen
$_rowsFound : mixed
$_sections : array<string|int, mixed>
$_selectAliases : array<string|int, mixed>
$_selectedTables : array<string|int, mixed>: Array of DAO tables having columns included in SELECT or ORDER BY clause.
$_sendmail : bool
$_state : object: The state object that this form belongs to
$_statFields : array<string|int, mixed>: Set of statistic fields
$_statistics : array<string|int, mixed>: Set of statistics data
$_storeResultSet : bool: Flag to indicate if result-set is to be stored in a class variable which could be retrieved using getResultSet() method.
$_tagFilter : bool: Build tags filter
$_tagFilterTable : string: specify entity table for tags filter
$_template : CRM_Core_Smarty: Cache the smarty template for efficiency reasons
$_templateID : int: The id of the report template
$_title : string: The report title
$addPaging : bool: Should we add paging.
$campaigns : array<string|int, mixed>: Array of campaign data, populated by calling `$this::addCampaignFields()`
$cid : mixed
$context : string: Context of the form being loaded.
$currentLogTable : string: The log table currently being processed.
$exportedValues : array<string|int, mixed>: Values submitted by the user.
$filteredTables : array<string|int, mixed>: Array of DAO tables having columns included in WHERE or HAVING clause
$groupConcatTested : mixed
$groupFilterNotOptimised : bool: Has the report been optimised for group filtering.
$groupTempTable : string: Table containing list of contact IDs within the group filter.
$isForceGroupBy : mixed
$loggingDB : mixed
$logTypeTableClause : string: Clause used in the final run of buildQuery but not when doing preliminary work.
$noGroupBy : bool: An instruction not to add a Group By.
$optionalQuickFormElements : array<string|int, mixed>: Quick form elements which are conditionally added to the form.
$rollupRow : array<string|int, mixed>: When a grand total row has calculated the status we pop it off to here.
$sql : string: SQL being run in this report.
$sqlArray : array<string|int, mixed>: SQL being run in this report as an array.
$submittableMoneyFields : array<string|int, mixed>: Monetary fields that may be submitted.
$tabs : array<string|int, mixed>: Array of tabs to display on report.
$temporaryTable : CRM_Utils_SQL_TempTable: Set within `$this->buildTemporaryTables`
$temporaryTableName : string: The name of the temporary table.
$temporaryTables : array<string|int, mixed>: Tables created for the report that need removal afterwards.
$unsavedChangesWarn : bool: Indicate if this form should warn users of unsaved changes
$authenticatedContactID : int: The contact ID that has been authenticated and can be used for checking permissions.
$isValidated : true
$outputHandler : OutputHandlerInterface

Methods

__construct() : CRM_Core_Form: Class constructor.
add() : HTML_QuickForm_Element: Simple easy to use wrapper around addElement.
add2group() : mixed: Add contact to group.
addAddressFields() : array<string|int, mixed>: Add address fields.
addAutocomplete() : HTML_QuickForm_Element
addAutoSelector() : mixed: Add autoselector field -if user has permission to view contacts If adding this to a form you also need to add to the tpl e.g
addBreadCrumb() : mixed: Add bread crumb.
addButtons() : mixed: Add default Next / Back buttons.
addCampaignFields() : mixed: Add campaign fields.
addChainSelect() : HTML_QuickForm_Element: Create a chain-select target field. All settings are optional; the defaults usually work.
addChartOptions() : mixed: Add chart options to the report.
addCheckBox() : mixed
addCIDZeroOptions() : mixed: Add the options appropriate to cid = zero - ie. autocomplete
addClass() : mixed: Add one or more css classes to the form.
addColumns() : mixed: Add columns to report.
addCurrency() : mixed: Add currency element to the form.
addCustomDataToColumns() : mixed: Add custom data to the columns.
addDate() : mixed: Add date.
addDatePickerRange() : mixed: Add a search for a range using date picker fields.
addDateRange() : mixed
addDateTime() : mixed: Function that will add date and time.
addDefaultButtons() : mixed: Simple shell that derived classes can call to add buttons to the form with a customized title for the main Submit
addEntityRef() : HTML_QuickForm_Element: Create a single or multiple entity ref field.
addExpectedSmartyVariable() : void: Add an expected smarty variable to the array.
addExpectedSmartyVariables() : void: Add an expected smarty variable to the array.
addField() : mixed: Adds a field based on metadata.
addFilters() : mixed: Add filters to report.
addFinancialTrxnFromClause() : mixed: Add Financial Transaction into From Table if required.
addGroupBys() : mixed: Add group by options to the report.
addMoney() : HTML_QuickForm_Element: Add a currency and money element to the form.
addOptionalQuickFormElement() : void: Add an optional element to the optional elements array.
addOptions() : mixed: Add options defined in $this->_options to the report.
addOrderBys() : mixed: Add data for order by tab.
addProfileSelector() : mixed: Add a widget for selecting/editing/creating/copying a profile form
addRadio() : HTML_QuickForm_group
addRules() : mixed: This is a virtual function that adds group and global rules to the form.
addSelect() : HTML_QuickForm_Element: Adds a select based on field metadata.
addTaskMenu() : mixed: Add actions menu to results form.
addToDeveloperTab() : void: The intent is to add a tab for developers to view the sql.
addUploadElement() : mixed
addYesNo() : mixed
allowAjaxSubmit() : mixed: Sets form attribute.
alterCustomDataDisplay() : mixed: Alter the way in which custom data fields are displayed.
alterDisplay() : mixed: Alter display of rows.
alterDisplayAddressFields() : bool: Do AlterDisplay processing on Address Fields.
alterDisplayContactFields() : bool: Do AlterDisplay processing on Address Fields.
alterSectionHeaderForDateTime() : mixed: CRM-17793 - Alter DateTime section header to group by date from the datetime field.
append() : mixed: Appends values to template variables.
assign() : mixed: Assign value to name in template.
assign_by_ref() : mixed: Assign value to name in template by reference.
assignBillingName() : string: Assign billing name to the template.
assignBillingType() : mixed: Assign billing type id to bltID.
assignVariables() : mixed: Assign an array of variables to the form/tpl
beginPostProcess() : mixed: Post Processing function for Form.
beginPostProcessCommon() : mixed: Common processing, also via api/unit tests.
buildACLClause() : mixed: Build contact acl clause
buildChart() : mixed: Build chart.
buildForm() : mixed: Core function that builds the form.
buildGroupFilter() : mixed: Adds group filters to _columns (called from _Construct).
buildGroupTempTable() : void: Create a table of the contact ids included by the group filter.
buildInstanceAndButtons() : mixed: This adds the tab referred to as Title and Format, rendered through Instance.tpl.
buildPermissionClause() : mixed: Build the permission clause for all entities in this report
buildQuery() : string: Build the report query.
buildQuickForm() : mixed: Main build form function.
buildRows() : mixed: Build output rows.
buildTagFilter() : mixed: Build the tag filter field to display on the filters tab.
cancelAction() : mixed: Function that can be defined in Form to override or.
canUseAjaxContactLookups() : bool
cleanUpTemporaryTables() : mixed: Remove any temporary tables.
compileContent() : string: Compile the report content.
countStat() : mixed: Add count statistics.
createTemporaryTable() : string: Create a temporary table.
customDataFormRule() : array<string|int, mixed>: A form rule function for custom data.
customDataFrom() : mixed: Build custom data from clause.
dateClause() : null|string: Get SQL where clause for a date field.
doTemplateAssignment() : mixed: Assign rows to the template.
endPostProcess() : mixed: End post processing.
error() : mixed: Error reporting mechanism.
filterStat() : mixed: Filter statistics.
fiscalYearOffset() : string: Adjusts dates passed in to YEAR() for fiscal year.
fixSubTotalDisplay() : mixed: Fix subtotal display.
formatDisplay() : mixed: Format display output.
from() : mixed: Generate From Clause.
get() : mixed: Get the variable from the form scope.
get_template_vars() : array<string|int, mixed>: Returns an array containing template variables.
getAction() : int|null: Getter for action.
getAuthenticatedContactID() : int: Get the authenticated contact ID.
getBasicContactFields() : array<string|int, mixed>: Get a standard set of contact fields.
getBasicContactFilters() : array<string|int, mixed>: Get a standard set of contact filters.
getCompleteTitle() : string
getContactID() : int|null: Get the contact id that the form is being submitted for.
getContext() : string
getCurrency() : string: Get the currency for the form.
getDefaultContext() : mixed: Classes extending CRM_Core_Form should implement this method.
getDefaultEntity() : mixed: Classes extending CRM_Core_Form should implement this method.
getDefaultValues() : array<string|int, mixed>: Getter for $_defaultValues.
getElementFromGroup() : object|bool: Get element from group.
getEntityAction() : null|string: Get entity action.
getEntityValue() : mixed|null|string: Get entity value.
getFromTo() : array<string|int, mixed>: Get values for from and to for date ranges.
getHookedTemplateFileName() : mixed: A wrapper for getTemplateFileName.
getID() : int: Getter for $_id.
getLabels() : mixed: Get all labels for fields that are used in a group concat.
getLoggedInUserContactID() : int|false: Get the contact id of the logged in user.
getLogType() : string: Get log type.
getName() : string: Getter function for Name.
getOperationPair() : array<string|int, mixed>: Get operators to display on form.
getOptionalQuickFormElements() : array<string|int, mixed>: Get any quick-form elements that may not be present in the form.
getOutputMode() : string: Getter for _outputMode
getParams() : void|array<string|int, mixed>: Getter for $_params.
getPaymentProcessorID() : int|null
getPhoneColumns() : array<string|int, mixed>: Get phone columns to add to array.
getProfileDefaults() : array<string|int, mixed>: Set default values on form for given contact (or no contact defaults)
getRenderer() : CRM_Core_Form_Renderer: Getter function for renderer.
getReportFooter() : string: Getter for report footer form field value
getReportHeader() : string: Getter for report header form field value
getReportSql() : string: Get the sql used to generate the report.
getRequestedContactID() : int|null: Get the contact ID that has been requested (via url or form value).
getResultSet() : bool: Get result set.
getResultsLabel() : string: Get label for show results buttons.
getRootTitle() : null
getRowCount() : int: Get the number of rows to show
getSelectColumns() : array<string|int, mixed>: Get an array of the columns that have been selected for display.
getSQLOperator() : string: Get SQL operator from form text version.
getState() : object: Getter function for State.
getStateType() : int: Getter function for StateType.
getSubmittedValue() : mixed|null: Get value submitted by the user.
getSubmittedValues() : array<string|int, mixed>: Get values submitted by the user.
getTemplate() : CRM_Core_Smarty
getTemplateFileName() : string: Use the form name to create the tpl file name.
getTemplateVars() : mixed: Get the value/s assigned to the Template Engine (Smarty).
getTitle() : string: Getter function for title.
getUFGroupIDs() : array<string|int, mixed>: Get the active UFGroups (profiles) on this form Many forms load one or more UFGroups (profiles).
getVar() : mixed
grandTotal() : bool: Calculate grant total.
groupBy() : mixed: Build group by clause.
groupByStat() : mixed: Add group by statistics.
isFieldSelected() : bool: Check if the field is selected.
isFormInEditMode() : bool: Is the form in edit mode.
isFormInViewMode() : bool: Is the form in view mode.
isTableFiltered() : bool: Check if table name has columns in WHERE or HAVING clause.
isTableSelected() : bool: Check if table name has columns in SELECT clause.
joinGroupTempTable() : mixed: Join the temp table contacting contacts who are members of the filtered groups.
legacySlowGroupFilterClause() : string: Build a group filter with contempt for large data sets.
limit() : array<string|int, mixed>: Set limit.
mainProcess() : mixed: Main process wrapper.
modifyColumnHeaders() : mixed: Modify column headers.
moveSummaryColumnsToTheRightHandSide() : mixed: Move totals columns to the right edge of the table.
orderBy() : mixed: Build order by clause.
overrideExtraTemplateFileName() : string: Default extra tpl file basically just replaces .tpl with .extra.tpl.
postProcess() : mixed: Post process function.
postProcessHook() : mixed: The postProcess hook is typically called by the framework.
preProcess() : mixed: Pre process function.
preProcessCommon() : mixed: Shared pre-process function.
preProcessOrderBy() : mixed: Check for empty order_by configurations and remove them.
preventAjaxSubmit() : mixed: Sets form attribute.
processReportMode() : mixed: Set output mode.
registerFileField() : void: Register a field with quick form as supporting a file upload.
registerRules() : mixed: Register all the standard rules that most forms potentially use.
removeDuplicates() : mixed: Remove duplicate rows.
removeFileRequiredRules() : mixed
resetValues() : mixed
resultsDisplayed() : bool: Has this form been submitted already?
sectionTotals() : mixed: Calculate section totals.
select() : mixed: Generate the SELECT clause and set class variable $_select.
selectClause() : string: Adjust query for the activity_contact table.
selectedTables() : array<string|int, mixed>: Fetch array of DAO tables having columns included in SELECT or ORDER BY clause.
selectivelyAddLocationTablesJoinsToFilterQuery() : mixed: Add location tables to the query if they are used for filtering.
sendEmail() : mixed: Send report by email
set() : mixed: Store the variable with the value in the form scope.
setAction() : mixed: Setter for action.
setAddPaging() : mixed: Setter for $addPaging.
setContext() : mixed: Set context variable.
setDefaultValues() : array<string|int, mixed>: Set default values.
setEntityRefDefaults() : mixed: Apply common settings to entityRef fields.
setForce() : mixed: Setter for $_force.
setFromBase() : mixed: Set the base table for the FROM clause.
setID() : mixed: Setter for $_id.
setLimitValue() : mixed: Setter for $_limitValue.
setOffsetValue() : mixed: Setter for $_offsetValue.
setOptions() : mixed: Setter function for options.
setOutputHandler() : void: Retrieve a suitable object from the factory depending on the report parameters, which typically might just be dependent on outputMode.
setPager() : mixed: Set pager.
setPageTitle() : void: Sets page title based on entity and action.
setParams() : mixed: Setter for $_params.
setPurifiedDefaults() : mixed
setRowCount() : void: set the number of rows to show
setSelectedChild() : mixed: Set the active tab
setTitle() : mixed: Setter function for title.
setVar() : mixed
statistics() : array<string|int, mixed>: Build report statistics.
storeOrderByArray() : mixed: Extract order by fields and store as an array.
storeResultSet() : mixed: Set store result set indicator to TRUE.
storeWhereHavingClauseArray() : mixed: Store Where clauses into an array.
toSmarty() : string: Render form and return contents.
unselectedOrderByColumns() : array<string|int, mixed>: Determine unselected columns.
unselectedSectionColumns() : array<string|int, mixed>: Determine unselected columns.
validate() : bool: Performs the server side validation.
validateMandatoryFields() : mixed: Helper function to verify that required fields have been filled.
where() : mixed: Build where clause.
whereClause() : null|string: Generate where clause.
whereGroupClause() : string: Build where clause for groups.
whereMembershipOrgClause() : string: Generate membership organization clause.
whereMembershipTypeClause() : string: Generate Membership Type SQL Clause.
whereSubtypeClause() : string: Get SQL where clause for contact subtypes
whereTagClause() : string: Build where clause for tags.
addBasicFieldToSelect() : array<string|int, mixed>: Add a basic field to the select clause.
addDetailReportLinksToRow() : mixed: Add links & hovers to the detailed report.
addLinkToRow() : mixed: Add link fields to the row.
addStatisticsToSelect() : array<string|int, mixed>: Add statistics columns.
alterBoolean() : mixed
alterCommunicationtMethod() : mixed
alterContactID() : mixed
alterCountryID() : array<string|int, mixed>
alterCountyID() : array<string|int, mixed>
alterLocationTypeID() : mixed
alterStateProvinceID() : array<string|int, mixed>
assignPaymentProcessor() : mixed: This if a front end form function for setting the payment processor.
assignTabs() : mixed: Function to assign the tabs to the template in the correct order.
buildColumns() : array<string|int, mixed>: Build the columns.
buildTemporaryTables() : mixed: Build the temporary tables for the query.
executeReportQuery() : CRM_Core_DAO|object: Execute query and add it to the developer tab.
formatParamsForPaymentProcessor() : array<string|int, mixed>: Format the fields in $this->_params for the payment processor.
generateFilterClause() : string: Generate clause for the selected filter.
getActions() : array<string|int, mixed>: Get the actions for this report instance.
getAddressColumns() : array<string|int, mixed>: Get address columns to add to array.
getApiAction() : mixed: Based on form action, return a string representing the api action.
getAuthenticatedCheckSumContactID() : int: Get the contact ID authenticated as a valid by checksum.
getColumns() : array<string|int, mixed>: Function to add columns to reports.
getContactColumns() : array<string|int, mixed>: Get columns for contact table.
getContactIDIfAccessingOwnRecord() : int|false: Get the contact if from the url, using the checksum or the cid if it is the logged in user.
getDefaultsFromOptions() : array<string|int, mixed>
getFieldsToExcludeFromPurification() : array<string|int, mixed>: Override this in a subclass to prevent fields intended to contain "raw html" from getting broken. E.g. system message templates
getSelectClauseWithGroupConcatIfNotGroupedBy() : string: Get the select clause for a field, wrapping in GROUP_CONCAT if appropriate.
getSubmittableFields() : array<string|int, string>: Get the fields that can be submitted in this form flow.
handlePreApproval() : mixed: Handle pre approval for processors.
isFieldFiltered() : bool: Check if the field is used as a filter.
isFormInViewOrEditMode() : bool: Is the form in view or edit mode.
joinAddressFromContact() : mixed: Add Address into From Table if required.
joinCountryFromAddress() : mixed: Add Country into From Table if required.
joinEmailFromContact() : mixed: Add Email into From Table if required.
joinPhoneFromContact() : mixed: Add Phone into From Table if required.
prepareParamsForPaymentProcessor() : array<string|int, mixed>: Format the fields in $params for the payment processor.
preProcessPaymentOptions() : mixed: Handle Payment Processor switching for contribution and event registration forms.
pushUrlToUserContext() : void: Push path to the userContext (defaults to current url path).
setContactID() : null|int: Get contact iD for a form object.
setOutputMode() : mixed: Determine the output mode from the url or input.
setTableAlias() : string: Set table alias.
setTranslatedFields() : mixed: Set translated fields.
storeGroupByArray() : mixed: Store group bys into array - so we can check elsewhere what is grouped.
validateAuthenticatedCheckSumContactID() : int: Verify that a contact ID is authenticated as a valid contact by checksum
formatReferenceFieldAttributes() : mixed
preProcessChainSelectFields() : mixed: Set options and attributes for chain select fields based on the controlling field's value
selectOrAnyPlaceholder() : string: Handles a repeated bit supplying a placeholder for entity selection
validateChainSelectFields() : mixed: Validate country / state / county match and suppress unwanted "required" errors

ATTR_SPACING

Constants for attributes for various form elements attempt to standardize on the number of variations that we use of the below form elements


    public
        string
    ATTR_SPACING
    = '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'

CB_PREFIX

All checkboxes are defined with a common prefix. This allows us to have the same javascript to check / clear all the checkboxes etc If u have multiple groups of checkboxes, you will need to give them different ids to avoid potential name collision


    public
        string|int
    CB_PREFIX
    = 'mark_x_'

CB_PREFIX_LEN


    public
        string|int
    CB_PREFIX_LEN
    = 7

CB_PREFIY


    public
        string|int
    CB_PREFIY
    = 'mark_y_'