3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
12 use Civi\Token\TokenProcessor
;
15 * One place to store frequently used values in Select Elements. Note that
16 * some of the below elements will be dynamic, so we'll probably have a
17 * smart caching scheme on a per domain basis
20 * @copyright CiviCRM LLC https://civicrm.org/licensing
22 class CRM_Core_SelectValues
{
29 public static function boolean() {
37 * Preferred mail format.
41 public static function pmf() {
54 public static function privacy() {
56 'do_not_phone' => ts('Do not phone'),
57 'do_not_email' => ts('Do not email'),
58 'do_not_mail' => ts('Do not mail'),
59 'do_not_sms' => ts('Do not sms'),
60 'do_not_trade' => ts('Do not trade'),
61 'is_opt_out' => ts('No bulk emails (User Opt Out)'),
66 * Various pre defined contact super types.
70 public static function contactType() {
71 return CRM_Contact_BAO_ContactType
::basicTypePairs();
75 * Various pre defined unit list.
77 * @param string $unitType
80 public static function unitList($unitType = NULL) {
83 'month' => ts('month'),
86 if ($unitType === 'duration') {
87 $unitList['lifetime'] = ts('lifetime');
93 * Membership type unit.
97 public static function membershipTypeUnitList() {
98 return self
::unitList('duration');
102 * Various pre defined period types.
106 public static function periodType() {
108 'rolling' => ts('Rolling'),
109 'fixed' => ts('Fixed'),
114 * Various pre defined email selection methods.
118 public static function emailSelectMethods() {
120 'automatic' => ts('Automatic'),
121 'location-only' => ts('Only send to email addresses assigned to the specified location'),
122 'location-prefer' => ts('Prefer email addresses assigned to the specified location'),
123 'location-exclude' => ts('Exclude email addresses assigned to the specified location'),
128 * Various pre defined member visibility options.
132 public static function memberVisibility() {
134 'Public' => ts('Public'),
135 'Admin' => ts('Admin'),
140 * Member auto-renew options
144 public static function memberAutoRenew() {
146 ts('No auto-renew option'),
147 ts('Give option, but not required'),
148 ts('Auto-renew required'),
153 * Various pre defined event dates.
157 public static function eventDate() {
159 'start_date' => ts('start date'),
160 'end_date' => ts('end date'),
161 'join_date' => ts('member since'),
166 * Custom form field types.
170 public static function customHtmlType() {
172 'Text' => ts('Single-line input field (text or numeric)'),
173 'TextArea' => ts('Multi-line text box (textarea)'),
174 'Select' => ts('Drop-down (select list)'),
175 'Radio' => ts('Radio buttons'),
176 'CheckBox' => ts('Checkbox(es)'),
177 'Select Date' => ts('Select Date'),
178 'File' => ts('File'),
179 'RichTextEditor' => ts('Rich Text Editor'),
180 'Autocomplete-Select' => ts('Autocomplete-Select'),
181 'Link' => ts('Link'),
186 * Various pre defined extensions for dynamic properties and groups.
191 public static function customGroupExtends() {
192 $customGroupExtends = [
193 'Activity' => ts('Activities'),
194 'Relationship' => ts('Relationships'),
195 'Contribution' => ts('Contributions'),
196 'ContributionRecur' => ts('Recurring Contributions'),
197 'Group' => ts('Groups'),
198 'Membership' => ts('Memberships'),
199 'Event' => ts('Events'),
200 'Participant' => ts('Participants'),
201 'ParticipantRole' => ts('Participants (Role)'),
202 'ParticipantEventName' => ts('Participants (Event Name)'),
203 'ParticipantEventType' => ts('Participants (Event Type)'),
204 'Pledge' => ts('Pledges'),
205 'Grant' => ts('Grants'),
206 'Address' => ts('Addresses'),
207 'Campaign' => ts('Campaigns'),
209 $contactTypes = ['Contact' => ts('Contacts')] + self
::contactType();
210 $extendObjs = CRM_Core_OptionGroup
::values('cg_extend_objects');
211 $customGroupExtends = array_merge($contactTypes, $customGroupExtends, $extendObjs);
212 return $customGroupExtends;
216 * Styles for displaying the custom data group.
220 public static function customGroupStyle() {
223 'Inline' => ts('Inline'),
224 'Tab with table' => ts('Tab with table'),
229 * For displaying the uf group types.
233 public static function ufGroupTypes() {
235 'Profile' => ts('Standalone Form or Directory'),
236 'Search Profile' => ts('Search Views'),
239 if (CRM_Core_Config
::singleton()->userSystem
->supports_form_extensions
) {
240 $ufGroupType +
= CRM_Core_Config
::singleton()->userSystem
->getUfGroupTypes();
246 * The status of a contact within a group.
250 public static function groupContactStatus() {
252 'Added' => ts('Added'),
253 'Removed' => ts('Removed'),
254 'Pending' => ts('Pending'),
259 * List of Group Types.
263 public static function groupType() {
265 'query' => ts('Dynamic'),
266 'static' => ts('Static'),
271 * Compose the parameters for a date select object.
273 * @param string|null $type
275 * @param string|null $format
276 * date format (QF format)
277 * @param null $minOffset
278 * @param null $maxOffset
279 * @param string $context
283 * @throws CRM_Core_Exception
285 public static function date($type = NULL, $format = NULL, $minOffset = NULL, $maxOffset = NULL, $context = 'display') {
286 // These options are deprecated. Definitely not used in datepicker. Possibly not even in jcalendar+addDateTime.
288 'addEmptyOption' => TRUE,
289 'emptyOptionText' => ts('- select -'),
290 'emptyOptionValue' => '',
294 $date['format'] = $format;
298 $dao = new CRM_Core_DAO_PreferencesDate();
300 if (!$dao->find(TRUE)) {
301 throw new CRM_Core_Exception('Date preferences not configured.');
304 $maxOffset = $dao->end
;
307 $minOffset = $dao->start
;
310 $date['format'] = $dao->date_format
;
311 $date['time'] = (bool) $dao->time_format
;
314 if (empty($date['format'])) {
315 if ($context === 'Input') {
316 $date['format'] = Civi
::settings()->get('dateInputFormat');
319 $date['format'] = 'M d';
324 $date['smarty_view_format'] = CRM_Utils_Date
::getDateFieldViewFormat($date['format']);
325 if (!isset($date['time'])) {
326 $date['time'] = FALSE;
330 $date['minYear'] = $year - (int) $minOffset;
331 $date['maxYear'] = $year +
(int) $maxOffset;
336 * Values for UF form visibility options.
340 public static function ufVisibility() {
342 'User and User Admin Only' => ts('User and User Admin Only'),
343 'Public Pages' => ts('Expose Publicly'),
344 'Public Pages and Listings' => ts('Expose Publicly and for Listings'),
349 * Values for group form visibility options.
353 public static function groupVisibility() {
355 'User and User Admin Only' => ts('User and User Admin Only'),
356 'Public Pages' => ts('Public Pages'),
361 * Different type of Mailing Components.
365 public static function mailingComponents() {
367 'Header' => ts('Header'),
368 'Footer' => ts('Footer'),
369 'Reply' => ts('Reply Auto-responder'),
370 'OptOut' => ts('Opt-out Message'),
371 'Subscribe' => ts('Subscription Confirmation Request'),
372 'Welcome' => ts('Welcome Message'),
373 'Unsubscribe' => ts('Unsubscribe Message'),
374 'Resubscribe' => ts('Resubscribe Message'),
383 public function getHours() {
385 for ($i = 0; $i <= 6; $i++
) {
396 public function getMinutes() {
398 for ($i = 0; $i < 60; $i = $i +
15) {
405 * Get the Map Provider.
408 * array of map providers
410 public static function mapProvider() {
413 $map = ['' => ts('- select -')] + CRM_Utils_System
::getPluginList('templates/CRM/Contact/Form/Task/Map', ".tpl");
419 * Get the Geocoding Providers from available plugins.
422 * array of geocoder providers
424 public static function geoProvider() {
427 $geo = ['' => ts('- select -')] + CRM_Utils_System
::getPluginList('CRM/Utils/Geocode');
433 * Get options for displaying tax.
437 * @throws \CRM_Core_Exception
439 public static function taxDisplayOptions() {
441 'Do_not_show' => ts('Do not show breakdown, only show total - i.e %1', [
442 1 => CRM_Utils_Money
::format(120),
444 'Inclusive' => ts('Show [tax term] inclusive price - i.e. %1', [
445 1 => ts('%1 (includes [tax term] of %2)', [1 => CRM_Utils_Money
::format(120), 2 => CRM_Utils_Money
::format(20)]),
447 'Exclusive' => ts('Show [tax term] exclusive price - i.e. %1', [
448 1 => ts('%1 + %2 [tax term]', [1 => CRM_Utils_Money
::format(120), 2 => CRM_Utils_Money
::format(20)]),
454 * Get the Address Standardization Providers from available plugins.
457 * array of address standardization providers
459 public static function addressProvider() {
462 $addr = array_merge(['' => ts('- select -')], CRM_Utils_System
::getPluginList('CRM/Utils/Address', '.php', ['BatchUpdate']));
468 * Different type of Mailing Tokens.
472 public static function mailingTokens() {
474 '{action.unsubscribe}' => ts('Unsubscribe via email'),
475 '{action.unsubscribeUrl}' => ts('Unsubscribe via web page'),
476 '{action.resubscribe}' => ts('Resubscribe via email'),
477 '{action.resubscribeUrl}' => ts('Resubscribe via web page'),
478 '{action.optOut}' => ts('Opt out via email'),
479 '{action.optOutUrl}' => ts('Opt out via web page'),
480 '{action.forward}' => ts('Forward this email (link)'),
481 '{action.reply}' => ts('Reply to this email (link)'),
482 '{action.subscribeUrl}' => ts('Subscribe via web page'),
483 '{mailing.key}' => ts('Mailing key'),
484 '{mailing.name}' => ts('Mailing name'),
485 '{mailing.group}' => ts('Mailing group'),
486 '{mailing.viewUrl}' => ts('Mailing permalink'),
487 ] + self
::domainTokens();
497 public static function domainTokens() {
498 $tokenProcessor = new TokenProcessor(Civi
::dispatcher(), []);
499 return $tokenProcessor->listTokens();
503 * Different type of Activity Tokens.
507 public static function activityTokens() {
509 '{activity.activity_id}' => ts('Activity ID'),
510 '{activity.subject}' => ts('Activity Subject'),
511 '{activity.details}' => ts('Activity Details'),
512 '{activity.activity_date_time}' => ts('Activity Date Time'),
517 * Different type of Membership Tokens.
521 public static function membershipTokens(): array {
523 '{membership.id}' => ts('Membership ID'),
524 '{membership.status_id:label}' => ts('Status'),
525 '{membership.membership_type_id:label}' => ts('Membership Type'),
526 '{membership.start_date}' => ts('Membership Start Date'),
527 '{membership.join_date}' => ts('Member Since'),
528 '{membership.end_date}' => ts('Membership Expiration Date'),
529 '{membership.fee}' => ts('Membership Fee'),
534 * Different type of Event Tokens.
540 public static function eventTokens(): array {
541 $tokenProcessor = new TokenProcessor(Civi
::dispatcher(), ['schema' => ['eventId']]);
542 $allTokens = $tokenProcessor->listTokens();
543 foreach (array_keys($allTokens) as $token) {
544 if (strpos($token, '{domain.') === 0) {
545 unset($allTokens[$token]);
552 * Different type of Contribution Tokens.
558 public static function contributionTokens(): array {
559 $tokenProcessor = new TokenProcessor(Civi
::dispatcher(), ['schema' => ['contributionId']]);
560 $allTokens = $tokenProcessor->listTokens();
561 foreach (array_keys($allTokens) as $token) {
562 if (strpos($token, '{domain.') === 0) {
563 unset($allTokens[$token]);
570 * Different type of Contact Tokens.
576 public static function contactTokens(): array {
577 $tokenProcessor = new TokenProcessor(Civi
::dispatcher(), ['schema' => ['contactId']]);
578 $allTokens = $tokenProcessor->listTokens();
579 foreach (array_keys($allTokens) as $token) {
580 if (strpos($token, '{domain.') === 0) {
581 unset($allTokens[$token]);
588 * Different type of Participant Tokens.
594 public static function participantTokens(): array {
595 $tokenProcessor = new TokenProcessor(Civi
::dispatcher(), ['schema' => ['participantId']]);
596 $allTokens = $tokenProcessor->listTokens();
597 foreach (array_keys($allTokens) as $token) {
598 if (strpos($token, '{domain.') === 0 ||
strpos($token, '{event.') === 0) {
599 unset($allTokens[$token]);
606 * @param int $caseTypeId
609 public static function caseTokens($caseTypeId = NULL) {
611 '{case.id}' => ts('Case ID'),
612 '{case.case_type_id:label}' => ts('Case Type'),
613 '{case.subject}' => ts('Case Subject'),
614 '{case.start_date}' => ts('Case Start Date'),
615 '{case.end_date}' => ts('Case End Date'),
616 '{case.details}' => ts('Details'),
617 '{case.status_id:label}' => ts('Case Status'),
618 '{case.is_deleted:label}' => ts('Case is in the Trash'),
619 '{case.created_date}' => ts('Created Date'),
620 '{case.modified_date}' => ts('Modified Date'),
623 $customFields = CRM_Core_BAO_CustomField
::getFields('Case', FALSE, FALSE, $caseTypeId);
624 foreach ($customFields as $id => $field) {
625 $tokens["{case.custom_$id}"] = "{$field['label']} :: {$field['groupTitle']}";
631 * CiviCRM supported date input formats.
635 public static function getDatePluginInputFormats() {
637 'mm/dd/yy' => ts('mm/dd/yy (12/31/2009)'),
638 'dd/mm/yy' => ts('dd/mm/yy (31/12/2009)'),
639 'yy-mm-dd' => ts('yy-mm-dd (2009-12-31)'),
640 'dd-mm-yy' => ts('dd-mm-yy (31-12-2009)'),
641 'dd.mm.yy' => ts('dd.mm.yy (31.12.2009)'),
642 'M d, yy' => ts('M d, yy (Dec 31, 2009)'),
643 'd M yy' => ts('d M yy (31 Dec 2009)'),
644 'MM d, yy' => ts('MM d, yy (December 31, 2009)'),
645 'd MM yy' => ts('d MM yy (31 December 2009)'),
646 'DD, d MM yy' => ts('DD, d MM yy (Thursday, 31 December 2009)'),
647 'mm/dd' => ts('mm/dd (12/31)'),
648 'dd-mm' => ts('dd-mm (31-12)'),
649 'yy-mm' => ts('yy-mm (2009-12)'),
650 'M yy' => ts('M yy (Dec 2009)'),
651 'yy' => ts('yy (2009)'),
660 public static function getTimeFormats() {
662 '1' => ts('12 Hours'),
663 '2' => ts('24 Hours'),
668 * Get numeric options.
675 public static function getNumericOptions($start = 0, $end = 10) {
676 $numericOptions = [];
677 for ($i = $start; $i <= $end; $i++
) {
678 $numericOptions[$i] = $i;
680 return $numericOptions;
688 public static function getBarcodeTypes() {
690 'barcode' => ts('Linear (1D)'),
691 'qrcode' => ts('QR code'),
700 public static function getDedupeRuleTypes() {
702 'Unsupervised' => ts('Unsupervised'),
703 'Supervised' => ts('Supervised'),
704 'General' => ts('General'),
709 * Campaign group types.
713 public static function getCampaignGroupTypes() {
715 'Include' => ts('Include'),
716 'Exclude' => ts('Exclude'),
721 * Subscription history method.
725 public static function getSubscriptionHistoryMethods() {
727 'Admin' => ts('Admin'),
728 'Email' => ts('Email'),
739 public static function getPremiumUnits() {
742 'week' => ts('Week'),
743 'month' => ts('Month'),
744 'year' => ts('Year'),
753 public static function getExtensionTypes() {
755 'payment' => ts('Payment'),
756 'search' => ts('Search'),
757 'report' => ts('Report'),
758 'module' => ts('Module'),
768 public static function getJobFrequency() {
771 'Yearly' => ts('Yearly'),
772 'Quarter' => ts('Quarterly'),
773 'Monthly' => ts('Monthly'),
774 'Weekly' => ts('Weekly'),
776 'Daily' => ts('Daily'),
777 'Hourly' => ts('Hourly'),
778 'Always' => ts('Every time cron job is run'),
783 * Search builder operators.
787 public static function getSearchBuilderOperators() {
796 'NOT IN' => ts('Not In'),
797 'LIKE' => ts('Like'),
798 'NOT LIKE' => ts('Not Like'),
799 'RLIKE' => ts('Regex'),
800 'IS EMPTY' => ts('Is Empty'),
801 'IS NOT EMPTY' => ts('Not Empty'),
802 'IS NULL' => ts('Is Null'),
803 'IS NOT NULL' => ts('Not Null'),
808 * Profile group types.
812 public static function getProfileGroupType() {
813 $profileGroupType = [
814 'Activity' => ts('Activities'),
815 'Contribution' => ts('Contributions'),
816 'Membership' => ts('Memberships'),
817 'Participant' => ts('Participants'),
819 $contactTypes = self
::contactType();
820 $contactTypes = !empty($contactTypes) ?
['Contact' => 'Contacts'] +
$contactTypes : [];
821 $profileGroupType = array_merge($contactTypes, $profileGroupType);
823 return $profileGroupType;
827 * Word replacement match type.
831 public static function getWordReplacementMatchType() {
833 'exactMatch' => ts('Exact Match'),
834 'wildcardMatch' => ts('Wildcard Match'),
839 * Mailing group types.
843 public static function getMailingGroupTypes() {
845 'Include' => ts('Include'),
846 'Exclude' => ts('Exclude'),
847 'Base' => ts('Base'),
852 * Mailing Job Status.
856 public static function getMailingJobStatus() {
858 'Scheduled' => ts('Scheduled'),
859 'Running' => ts('Running'),
860 'Complete' => ts('Complete'),
861 'Paused' => ts('Paused'),
862 'Canceled' => ts('Canceled'),
869 public static function billingMode() {
871 CRM_Core_Payment
::BILLING_MODE_FORM
=> 'form',
872 CRM_Core_Payment
::BILLING_MODE_BUTTON
=> 'button',
873 CRM_Core_Payment
::BILLING_MODE_NOTIFY
=> 'notify',
880 public static function contributeMode() {
882 CRM_Core_Payment
::BILLING_MODE_FORM
=> 'direct',
883 CRM_Core_Payment
::BILLING_MODE_BUTTON
=> 'directIPN',
884 CRM_Core_Payment
::BILLING_MODE_NOTIFY
=> 'notify',
889 * Frequency unit for schedule reminders.
895 public static function getRecurringFrequencyUnits($count = 1) {
896 // @todo this used to refer to the 'recur_frequency_unit' option_values which
897 // is for recurring payments and probably not good to re-use for recurring entities.
898 // If something other than a hard-coded list is desired, add a new option_group.
900 'minute' => ts('minute', ['plural' => 'minutes', 'count' => $count]),
901 'hour' => ts('hour', ['plural' => 'hours', 'count' => $count]),
902 'day' => ts('day', ['plural' => 'days', 'count' => $count]),
903 'week' => ts('week', ['plural' => 'weeks', 'count' => $count]),
904 'month' => ts('month', ['plural' => 'months', 'count' => $count]),
905 'year' => ts('year', ['plural' => 'years', 'count' => $count]),
910 * Relative Date Terms.
914 public static function getRelativeDateTerms() {
916 'previous' => ts('Previous'),
917 'previous_2' => ts('Previous 2'),
918 'previous_before' => ts('Prior to Previous'),
919 'before_previous' => ts('All Prior to Previous'),
920 'earlier' => ts('To End of Previous'),
921 'greater_previous' => ts('From End of Previous'),
922 'greater' => ts('From Start Of Current'),
923 'current' => ts('Current'),
924 'ending_3' => ts('Last 3'),
925 'ending_2' => ts('Last 2'),
926 'ending' => ts('Last'),
927 'this' => ts('This'),
928 'starting' => ts('Upcoming'),
929 'less' => ts('To End of'),
930 'next' => ts('Next'),
935 * Relative Date Units.
939 public static function getRelativeDateUnits() {
941 'year' => ts('Years'),
942 'fiscal_year' => ts('Fiscal Years'),
943 'quarter' => ts('Quarters'),
944 'month' => ts('Months'),
945 'week' => ts('Weeks'),
951 * Exportable document formats.
955 public static function documentFormat() {
957 'pdf' => ts('Portable Document Format (.pdf)'),
958 'docx' => ts('MS Word (.docx)'),
959 'odt' => ts('Open Office (.odt)'),
960 'html' => ts('Webpage (.html)'),
965 * Application type of document.
969 public static function documentApplicationType() {
971 'docx' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
972 'odt' => 'application/vnd.oasis.opendocument.text',
977 * Activity Text options.
981 public static function activityTextOptions() {
983 2 => ts('Details Only'),
984 3 => ts('Subject Only'),
990 * Relationship permissions
994 public static function getPermissionedRelationshipOptions() {
996 CRM_Contact_BAO_Relationship
::NONE
=> ts('None'),
997 CRM_Contact_BAO_Relationship
::VIEW
=> ts('View only'),
998 CRM_Contact_BAO_Relationship
::EDIT
=> ts('View and update'),
1003 * Get option values for dashboard entries (used for 'how many events to display on dashboard').
1006 * Dashboard entries options - in practice [-1 => 'Show All', 10 => 10, 20 => 20, ... 100 => 100].
1008 public static function getDashboardEntriesCount() {
1010 $optionValues[-1] = ts('show all');
1011 for ($i = 10; $i <= 100; $i +
= 10) {
1012 $optionValues[$i] = $i;
1014 return $optionValues;
1018 * Dropdown options for quicksearch in the menu
1021 * @throws \CiviCRM_API3_Exception
1023 public static function quicksearchOptions() {
1024 $includeEmail = civicrm_api3('setting', 'getvalue', ['name' => 'includeEmailInName', 'group' => 'Search Preferences']);
1026 'sort_name' => $includeEmail ?
ts('Name/Email') : ts('Name'),
1027 'contact_id' => ts('Contact ID'),
1028 'external_identifier' => ts('External ID'),
1029 'first_name' => ts('First Name'),
1030 'last_name' => ts('Last Name'),
1031 'email' => ts('Email'),
1032 'phone_numeric' => ts('Phone'),
1033 'street_address' => ts('Street Address'),
1034 'city' => ts('City'),
1035 'postal_code' => ts('Postal Code'),
1036 'job_title' => ts('Job Title'),
1038 $custom = civicrm_api3('CustomField', 'get', [
1039 'return' => ['name', 'label', 'custom_group_id.title'],
1040 'custom_group_id.extends' => ['IN' => ['Contact', 'Individual', 'Organization', 'Household']],
1041 'data_type' => ['NOT IN' => ['ContactReference', 'Date', 'File']],
1042 'custom_group_id.is_active' => 1,
1044 'is_searchable' => 1,
1045 'options' => ['sort' => ['custom_group_id.weight', 'weight'], 'limit' => 0],
1047 foreach ($custom['values'] as $field) {
1048 $options['custom_' . $field['name']] = $field['custom_group_id.title'] . ': ' . $field['label'];
1054 * Get components (translated for display.
1058 * @throws \Exception
1060 public static function getComponentSelectValues() {
1062 $components = CRM_Core_Component
::getComponents();
1063 foreach ($components as $name => $object) {
1064 $ret[$name] = $object->info
['translatedName'];
1073 public static function fieldSerialization() {
1075 CRM_Core_DAO
::SERIALIZE_SEPARATOR_BOOKEND
=> 'separator_bookend',
1076 CRM_Core_DAO
::SERIALIZE_SEPARATOR_TRIMMED
=> 'separator_trimmed',
1077 CRM_Core_DAO
::SERIALIZE_JSON
=> 'json',
1078 CRM_Core_DAO
::SERIALIZE_PHP
=> 'php',
1079 CRM_Core_DAO
::SERIALIZE_COMMA
=> 'comma',
1086 public static function navigationMenuSeparator() {
1089 ts('After menu element'),
1090 ts('Before menu element'),
1097 public static function relationshipOrientation() {
1099 'a_b' => ts('A to B'),
1100 'b_a' => ts('B to A'),
1107 public static function andOr() {