CRM_Core_SelectValues
in package
One place to store frequently used values in Select Elements. Note that some of the below elements will be dynamic, so we'll probably have a smart caching scheme on a per domain basis
Tags
Table of Contents
Methods
- activityTextOptions() : array<string|int, mixed>
- Activity Text options.
- activityTokens() : array<string|int, mixed>
- Different type of Activity Tokens.
- addressProvider() : array<string|int, mixed>
- Get the Address Standardization Providers from available plugins.
- andOr() : array<string|int, mixed>
- beforeAfter() : mixed
- billingMode() : array<string|int, mixed>
- boolean() : array<string|int, mixed>
- Yes/No options
- caseTokens() : array<string|int, mixed>
- contactTokens() : array<string|int, mixed>
- Different type of Contact Tokens.
- contactType() : array<string|int, mixed>
- Various pre defined contact super types.
- contributeMode() : array<string|int, mixed>
- contributionTokens() : array<string|int, mixed>
- Different type of Contribution Tokens.
- customGroupExtends() : array<string|int, mixed>
- List of entities to present on the Custom Group form.
- customGroupStyle() : array<string|int, mixed>
- Styles for displaying the custom data group.
- customHtmlType() : array<string|int, mixed>
- Custom form field types.
- date() : array<string|int, mixed>
- Compose the parameters for a date select object.
- documentApplicationType() : array<string|int, mixed>
- Application type of document.
- documentFormat() : array<string|int, mixed>
- Exportable document formats.
- domainTokens() : array<string|int, mixed>
- Domain tokens
- emailSelectMethods() : array<string|int, mixed>
- Various pre defined email selection methods.
- eventDate() : array<string|int, mixed>
- Various pre defined event dates.
- eventTokens() : array<string|int, mixed>
- Different type of Event Tokens.
- fieldSerialization() : array<string|int, string>
- geoProvider() : array<string|int, mixed>
- Get the Geocoding Providers from available plugins.
- getBarcodeTypes() : array<string|int, mixed>
- Barcode types.
- getCampaignGroupTypes() : array<string|int, mixed>
- Campaign group types.
- getComponentSelectValues() : array<string|int, mixed>
- Get components (translated for display.
- getDashboardEntriesCount() : array<string|int, mixed>
- Get option values for dashboard entries (used for 'how many events to display on dashboard').
- getDatePluginInputFormats() : array<string|int, mixed>
- CiviCRM supported date input formats.
- getDedupeRuleTypes() : array<string|int, mixed>
- Dedupe rule types.
- getExtensionTypes() : array<string|int, mixed>
- Extension types.
- getHours() : array<string|int, mixed>
- Get hours.
- getJobFrequency() : array<string|int, mixed>
- Job frequency.
- getLayoutUnits() : array<string|int, mixed>
- Get measurement units recognized by the TCPDF package used to create PDF labels.
- getMailingGroupTypes() : array<string|int, mixed>
- Mailing group types.
- getMailingJobStatus() : array<string|int, mixed>
- Mailing Job Status.
- getMinutes() : array<string|int, mixed>
- Get minutes.
- getNumericOptions() : array<string|int, mixed>
- Get numeric options.
- getPDFLoggingOptions() : array<string|int, mixed>
- getPermissionedRelationshipOptions() : array<string|int, mixed>
- Relationship permissions
- getPremiumUnits() : array<string|int, mixed>
- Premium units.
- getProfileGroupType() : array<string|int, mixed>
- Profile group types.
- getQuicksearchOptions() : array<string|int, mixed>
- getRecurringFrequencyUnits() : array<string|int, mixed>
- Frequency unit for schedule reminders.
- getRelativeDateTerms() : array<string|int, mixed>
- Relative Date Terms.
- getRelativeDateUnits() : array<string|int, mixed>
- Relative Date Units.
- getSearchBuilderOperators() : array<string|int, mixed>
- Search builder operators.
- getSubscriptionHistoryMethods() : array<string|int, mixed>
- Subscription history method.
- getTimeFormats() : array<string|int, mixed>
- Time formats.
- getWordReplacementMatchType() : array<string|int, mixed>
- Word replacement match type.
- groupContactStatus() : array<string|int, mixed>
- The status of a contact within a group.
- groupType() : array<string|int, mixed>
- List of Group Types.
- groupVisibility() : array<string|int, mixed>
- Values for group form visibility options.
- mailingComponents() : array<string|int, mixed>
- Different type of Mailing Components.
- mailingTokens() : array<string|int, mixed>
- Different type of Mailing Tokens.
- mapProvider() : array<string|int, mixed>
- Get the Map Provider.
- memberAutoRenew() : array<string|int, mixed>
- Member auto-renew options
- membershipTokens() : array<string|int, mixed>
- Different type of Membership Tokens.
- membershipTypeUnitList() : array<string|int, mixed>
- Membership type unit.
- memberVisibility() : array<string|int, mixed>
- Various pre defined member visibility options.
- navigationMenuSeparator() : array<string|int, mixed>
- optionAttributes() : array<string|int, mixed>
- The possible attributes of each item in an option list
- optionValueFields() : array<string|int, string>
- Columns from the option_value table which may or may not be used by each option_group.
- participantTokens() : array<string|int, mixed>
- Different type of Participant Tokens.
- periodType() : array<string|int, mixed>
- Various pre defined period types.
- permissions() : array<string|int, mixed>
- Callback for Role.permissions pseudoconstant values.
- pmf() : array<string|int, mixed>
- Preferred mail format.
- privacy() : array<string|int, mixed>
- Privacy options.
- quicksearchOptions() : array<string|int, mixed>
- Dropdown options for quicksearch in the menu
- relationshipOrientation() : array<string|int, mixed>
- smsProvider() : array<string|int, mixed>
- taxDisplayOptions() : array<string|int, mixed>
- Get options for displaying tax.
- ufGroupTypes() : array<string|int, mixed>
- For displaying the uf group types.
- ufVisibility() : array<string|int, mixed>
- Values for UF form visibility options.
- unitList() : array<string|int, mixed>
- Various pre defined unit list.
Methods
activityTextOptions()
Activity Text options.
public
static activityTextOptions() : array<string|int, mixed>
Return values
array<string|int, mixed>activityTokens()
Different type of Activity Tokens.
public
static activityTokens() : array<string|int, mixed>
Return values
array<string|int, mixed>addressProvider()
Get the Address Standardization Providers from available plugins.
public
static addressProvider() : array<string|int, mixed>
Return values
array<string|int, mixed> —array of address standardization providers
andOr()
public
static andOr() : array<string|int, mixed>
Return values
array<string|int, mixed>beforeAfter()
public
static beforeAfter() : mixed
billingMode()
public
static billingMode() : array<string|int, mixed>
Return values
array<string|int, mixed>boolean()
Yes/No options
public
static boolean() : array<string|int, mixed>
Return values
array<string|int, mixed>caseTokens()
public
static caseTokens([int $caseTypeId = NULL ]) : array<string|int, mixed>
Parameters
- $caseTypeId : int = NULL
Return values
array<string|int, mixed>contactTokens()
Different type of Contact Tokens.
public
static contactTokens() : array<string|int, mixed>
Return values
array<string|int, mixed>contactType()
Various pre defined contact super types.
public
static contactType() : array<string|int, mixed>
Return values
array<string|int, mixed>contributeMode()
public
static contributeMode() : array<string|int, mixed>
Return values
array<string|int, mixed>contributionTokens()
Different type of Contribution Tokens.
public
static contributionTokens() : array<string|int, mixed>
Return values
array<string|int, mixed>customGroupExtends()
List of entities to present on the Custom Group form.
public
static customGroupExtends() : array<string|int, mixed>
Includes pseudo-entities for Participant, in order to present sub-types on the form.
Return values
array<string|int, mixed>customGroupStyle()
Styles for displaying the custom data group.
public
static customGroupStyle() : array<string|int, mixed>
Return values
array<string|int, mixed>customHtmlType()
Custom form field types.
public
static customHtmlType() : array<string|int, mixed>
Return values
array<string|int, mixed>date()
Compose the parameters for a date select object.
public
static date([string|null $type = NULL ][, string|null $format = NULL ][, null $minOffset = NULL ][, null $maxOffset = NULL ][, string $context = 'display' ]) : array<string|int, mixed>
Parameters
- $type : string|null = NULL
-
the type of date
- $format : string|null = NULL
-
date format (QF format)
- $minOffset : null = NULL
- $maxOffset : null = NULL
- $context : string = 'display'
Tags
Return values
array<string|int, mixed> —the date array
documentApplicationType()
Application type of document.
public
static documentApplicationType() : array<string|int, mixed>
Return values
array<string|int, mixed>documentFormat()
Exportable document formats.
public
static documentFormat() : array<string|int, mixed>
Return values
array<string|int, mixed>domainTokens()
Domain tokens
public
static domainTokens() : array<string|int, mixed>
Return values
array<string|int, mixed>emailSelectMethods()
Various pre defined email selection methods.
public
static emailSelectMethods() : array<string|int, mixed>
Return values
array<string|int, mixed>eventDate()
Various pre defined event dates.
public
static eventDate() : array<string|int, mixed>
Return values
array<string|int, mixed>eventTokens()
Different type of Event Tokens.
public
static eventTokens() : array<string|int, mixed>
Return values
array<string|int, mixed>fieldSerialization()
public
static fieldSerialization() : array<string|int, string>
Return values
array<string|int, string>geoProvider()
Get the Geocoding Providers from available plugins.
public
static geoProvider() : array<string|int, mixed>
Return values
array<string|int, mixed> —array of geocoder providers
getBarcodeTypes()
Barcode types.
public
static getBarcodeTypes() : array<string|int, mixed>
Return values
array<string|int, mixed>getCampaignGroupTypes()
Campaign group types.
public
static getCampaignGroupTypes() : array<string|int, mixed>
Return values
array<string|int, mixed>getComponentSelectValues()
Get components (translated for display.
public
static getComponentSelectValues() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>getDashboardEntriesCount()
Get option values for dashboard entries (used for 'how many events to display on dashboard').
public
static getDashboardEntriesCount() : array<string|int, mixed>
Return values
array<string|int, mixed> —Dashboard entries options - in practice [-1 => 'Show All', 10 => 10, 20 => 20, ... 100 => 100].
getDatePluginInputFormats()
CiviCRM supported date input formats.
public
static getDatePluginInputFormats() : array<string|int, mixed>
Return values
array<string|int, mixed>getDedupeRuleTypes()
Dedupe rule types.
public
static getDedupeRuleTypes() : array<string|int, mixed>
Return values
array<string|int, mixed>getExtensionTypes()
Extension types.
public
static getExtensionTypes() : array<string|int, mixed>
Return values
array<string|int, mixed>getHours()
Get hours.
public
getHours() : array<string|int, mixed>
Return values
array<string|int, mixed>getJobFrequency()
Job frequency.
public
static getJobFrequency() : array<string|int, mixed>
Return values
array<string|int, mixed>getLayoutUnits()
Get measurement units recognized by the TCPDF package used to create PDF labels.
public
static getLayoutUnits() : array<string|int, mixed>
Return values
array<string|int, mixed> —array of measurement units
getMailingGroupTypes()
Mailing group types.
public
static getMailingGroupTypes() : array<string|int, mixed>
Return values
array<string|int, mixed>getMailingJobStatus()
Mailing Job Status.
public
static getMailingJobStatus() : array<string|int, mixed>
Return values
array<string|int, mixed>getMinutes()
Get minutes.
public
getMinutes() : array<string|int, mixed>
Return values
array<string|int, mixed>getNumericOptions()
Get numeric options.
public
static getNumericOptions([int $start = 0 ][, int $end = 10 ]) : array<string|int, mixed>
Parameters
- $start : int = 0
- $end : int = 10
Return values
array<string|int, mixed>getPDFLoggingOptions()
public
static getPDFLoggingOptions() : array<string|int, mixed>
Return values
array<string|int, mixed> —Array(string $machineName => string $label).
getPermissionedRelationshipOptions()
Relationship permissions
public
static getPermissionedRelationshipOptions() : array<string|int, mixed>
Return values
array<string|int, mixed>getPremiumUnits()
Premium units.
public
static getPremiumUnits() : array<string|int, mixed>
Return values
array<string|int, mixed>getProfileGroupType()
Profile group types.
public
static getProfileGroupType() : array<string|int, mixed>
Return values
array<string|int, mixed>getQuicksearchOptions()
public
static getQuicksearchOptions() : array<string|int, mixed>
Return values
array<string|int, mixed>getRecurringFrequencyUnits()
Frequency unit for schedule reminders.
public
static getRecurringFrequencyUnits([int $count = 1 ]) : array<string|int, mixed>
Parameters
- $count : int = 1
-
For pluralization
Return values
array<string|int, mixed>getRelativeDateTerms()
Relative Date Terms.
public
static getRelativeDateTerms() : array<string|int, mixed>
Return values
array<string|int, mixed>getRelativeDateUnits()
Relative Date Units.
public
static getRelativeDateUnits() : array<string|int, mixed>
Return values
array<string|int, mixed>getSearchBuilderOperators()
Search builder operators.
public
static getSearchBuilderOperators() : array<string|int, mixed>
Return values
array<string|int, mixed>getSubscriptionHistoryMethods()
Subscription history method.
public
static getSubscriptionHistoryMethods() : array<string|int, mixed>
Return values
array<string|int, mixed>getTimeFormats()
Time formats.
public
static getTimeFormats() : array<string|int, mixed>
Return values
array<string|int, mixed>getWordReplacementMatchType()
Word replacement match type.
public
static getWordReplacementMatchType() : array<string|int, mixed>
Return values
array<string|int, mixed>groupContactStatus()
The status of a contact within a group.
public
static groupContactStatus() : array<string|int, mixed>
Return values
array<string|int, mixed>groupType()
List of Group Types.
public
static groupType() : array<string|int, mixed>
Return values
array<string|int, mixed>groupVisibility()
Values for group form visibility options.
public
static groupVisibility() : array<string|int, mixed>
Return values
array<string|int, mixed>mailingComponents()
Different type of Mailing Components.
public
static mailingComponents() : array<string|int, mixed>
Return values
array<string|int, mixed>mailingTokens()
Different type of Mailing Tokens.
public
static mailingTokens() : array<string|int, mixed>
Return values
array<string|int, mixed>mapProvider()
Get the Map Provider.
public
static mapProvider() : array<string|int, mixed>
Return values
array<string|int, mixed> —array of map providers
memberAutoRenew()
Member auto-renew options
public
static memberAutoRenew() : array<string|int, mixed>
Return values
array<string|int, mixed>membershipTokens()
Different type of Membership Tokens.
public
static membershipTokens() : array<string|int, mixed>
Return values
array<string|int, mixed>membershipTypeUnitList()
Membership type unit.
public
static membershipTypeUnitList() : array<string|int, mixed>
Return values
array<string|int, mixed>memberVisibility()
Various pre defined member visibility options.
public
static memberVisibility() : array<string|int, mixed>
Return values
array<string|int, mixed>navigationMenuSeparator()
public
static navigationMenuSeparator() : array<string|int, mixed>
Return values
array<string|int, mixed>optionAttributes()
The possible attributes of each item in an option list
public
static optionAttributes() : array<string|int, mixed>
APIv4 refers to these as "suffixes".
Return values
array<string|int, mixed>optionValueFields()
Columns from the option_value table which may or may not be used by each option_group.
public
static optionValueFields() : array<string|int, string>
This is a subset of the full list of optionAttributes
Tags
Return values
array<string|int, string>participantTokens()
Different type of Participant Tokens.
public
static participantTokens() : array<string|int, mixed>
Return values
array<string|int, mixed>periodType()
Various pre defined period types.
public
static periodType() : array<string|int, mixed>
Return values
array<string|int, mixed>permissions()
Callback for Role.permissions pseudoconstant values.
public
static permissions() : array<string|int, mixed>
Permissions for Civi Standalone, not used by CMS-based systems.
Return values
array<string|int, mixed>pmf()
Preferred mail format.
public
static pmf() : array<string|int, mixed>
Return values
array<string|int, mixed>privacy()
Privacy options.
public
static privacy() : array<string|int, mixed>
Return values
array<string|int, mixed>quicksearchOptions()
Dropdown options for quicksearch in the menu
public
static quicksearchOptions() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>relationshipOrientation()
public
static relationshipOrientation() : array<string|int, mixed>
Return values
array<string|int, mixed>smsProvider()
public
static smsProvider() : array<string|int, mixed>
Return values
array<string|int, mixed>taxDisplayOptions()
Get options for displaying tax.
public
static taxDisplayOptions() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>ufGroupTypes()
For displaying the uf group types.
public
static ufGroupTypes() : array<string|int, mixed>
Return values
array<string|int, mixed>ufVisibility()
Values for UF form visibility options.
public
static ufVisibility() : array<string|int, mixed>
Return values
array<string|int, mixed>unitList()
Various pre defined unit list.
public
static unitList([string $unitType = NULL ]) : array<string|int, mixed>
Parameters
- $unitType : string = NULL