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 +--------------------------------------------------------------------+
13 * One place to store frequently used values in Select Elements. Note that
14 * some of the below elements will be dynamic, so we'll probably have a
15 * smart caching scheme on a per domain basis
18 * @copyright CiviCRM LLC https://civicrm.org/licensing
20 class CRM_Core_SelectValues
{
27 public static function boolean() {
35 * Preferred mail format.
39 public static function pmf() {
52 public static function privacy() {
54 'do_not_phone' => ts('Do not phone'),
55 'do_not_email' => ts('Do not email'),
56 'do_not_mail' => ts('Do not mail'),
57 'do_not_sms' => ts('Do not sms'),
58 'do_not_trade' => ts('Do not trade'),
59 'is_opt_out' => ts('No bulk emails (User Opt Out)'),
64 * Various pre defined contact super types.
68 public static function contactType() {
69 return CRM_Contact_BAO_ContactType
::basicTypePairs();
73 * Various pre defined unit list.
75 * @param string $unitType
78 public static function unitList($unitType = NULL) {
81 'month' => ts('month'),
84 if ($unitType === 'duration') {
85 $unitList['lifetime'] = ts('lifetime');
91 * Membership type unit.
95 public static function membershipTypeUnitList() {
96 return self
::unitList('duration');
100 * Various pre defined period types.
104 public static function periodType() {
106 'rolling' => ts('Rolling'),
107 'fixed' => ts('Fixed'),
112 * Various pre defined email selection methods.
116 public static function emailSelectMethods() {
118 'automatic' => ts('Automatic'),
119 'location-only' => ts('Only send to email addresses assigned to the specified location'),
120 'location-prefer' => ts('Prefer email addresses assigned to the specified location'),
121 'location-exclude' => ts('Exclude email addresses assigned to the specified location'),
126 * Various pre defined member visibility options.
130 public static function memberVisibility() {
132 'Public' => ts('Public'),
133 'Admin' => ts('Admin'),
138 * Member auto-renew options
142 public static function memberAutoRenew() {
144 ts('No auto-renew option'),
145 ts('Give option, but not required'),
146 ts('Auto-renew required'),
151 * Various pre defined event dates.
155 public static function eventDate() {
157 'start_date' => ts('start date'),
158 'end_date' => ts('end date'),
159 'join_date' => ts('member since'),
164 * Custom form field types.
168 public static function customHtmlType() {
170 'Text' => ts('Single-line input field (text or numeric)'),
171 'TextArea' => ts('Multi-line text box (textarea)'),
172 'Select' => ts('Drop-down (select list)'),
173 'Radio' => ts('Radio buttons'),
174 'CheckBox' => ts('Checkbox(es)'),
175 'Select Date' => ts('Select Date'),
176 'File' => ts('File'),
177 'RichTextEditor' => ts('Rich Text Editor'),
178 'Autocomplete-Select' => ts('Autocomplete-Select'),
179 'Link' => ts('Link'),
184 * Various pre defined extensions for dynamic properties and groups.
189 public static function customGroupExtends() {
190 $customGroupExtends = [
191 'Activity' => ts('Activities'),
192 'Relationship' => ts('Relationships'),
193 'Contribution' => ts('Contributions'),
194 'ContributionRecur' => ts('Recurring Contributions'),
195 'Group' => ts('Groups'),
196 'Membership' => ts('Memberships'),
197 'Event' => ts('Events'),
198 'Participant' => ts('Participants'),
199 'ParticipantRole' => ts('Participants (Role)'),
200 'ParticipantEventName' => ts('Participants (Event Name)'),
201 'ParticipantEventType' => ts('Participants (Event Type)'),
202 'Pledge' => ts('Pledges'),
203 'Grant' => ts('Grants'),
204 'Address' => ts('Addresses'),
205 'Campaign' => ts('Campaigns'),
207 $contactTypes = ['Contact' => ts('Contacts')] + self
::contactType();
208 $extendObjs = CRM_Core_OptionGroup
::values('cg_extend_objects');
209 $customGroupExtends = array_merge($contactTypes, $customGroupExtends, $extendObjs);
210 return $customGroupExtends;
214 * Styles for displaying the custom data group.
218 public static function customGroupStyle() {
221 'Inline' => ts('Inline'),
222 'Tab with table' => ts('Tab with table'),
227 * For displaying the uf group types.
231 public static function ufGroupTypes() {
233 'Profile' => ts('Standalone Form or Directory'),
234 'Search Profile' => ts('Search Views'),
237 if (CRM_Core_Config
::singleton()->userSystem
->supports_form_extensions
) {
239 'User Registration' => ts('Drupal User Registration'),
240 'User Account' => ts('View/Edit Drupal User Account'),
247 * The status of a contact within a group.
251 public static function groupContactStatus() {
253 'Added' => ts('Added'),
254 'Removed' => ts('Removed'),
255 'Pending' => ts('Pending'),
260 * List of Group Types.
264 public static function groupType() {
266 'query' => ts('Dynamic'),
267 'static' => ts('Static'),
272 * Compose the parameters for a date select object.
274 * @param string|null $type
276 * @param string|null $format
277 * date format (QF format)
278 * @param null $minOffset
279 * @param null $maxOffset
280 * @param string $context
284 * @throws CRM_Core_Exception
286 public static function date($type = NULL, $format = NULL, $minOffset = NULL, $maxOffset = NULL, $context = 'display') {
287 // These options are deprecated. Definitely not used in datepicker. Possibly not even in jcalendar+addDateTime.
289 'addEmptyOption' => TRUE,
290 'emptyOptionText' => ts('- select -'),
291 'emptyOptionValue' => '',
295 $date['format'] = $format;
299 $dao = new CRM_Core_DAO_PreferencesDate();
301 if (!$dao->find(TRUE)) {
302 throw new CRM_Core_Exception('Date preferences not configured.');
305 $maxOffset = $dao->end
;
308 $minOffset = $dao->start
;
311 $date['format'] = $dao->date_format
;
312 $date['time'] = (bool) $dao->time_format
;
315 if (empty($date['format'])) {
316 if ($context === 'Input') {
317 $date['format'] = Civi
::settings()->get('dateInputFormat');
320 $date['format'] = 'M d';
325 $date['smarty_view_format'] = CRM_Utils_Date
::getDateFieldViewFormat($date['format']);
326 if (!isset($date['time'])) {
327 $date['time'] = FALSE;
331 $date['minYear'] = $year - (int) $minOffset;
332 $date['maxYear'] = $year +
(int) $maxOffset;
337 * Values for UF form visibility options.
341 public static function ufVisibility() {
343 'User and User Admin Only' => ts('User and User Admin Only'),
344 'Public Pages' => ts('Expose Publicly'),
345 'Public Pages and Listings' => ts('Expose Publicly and for Listings'),
350 * Values for group form visibility options.
354 public static function groupVisibility() {
356 'User and User Admin Only' => ts('User and User Admin Only'),
357 'Public Pages' => ts('Public Pages'),
362 * Different type of Mailing Components.
366 public static function mailingComponents() {
368 'Header' => ts('Header'),
369 'Footer' => ts('Footer'),
370 'Reply' => ts('Reply Auto-responder'),
371 'OptOut' => ts('Opt-out Message'),
372 'Subscribe' => ts('Subscription Confirmation Request'),
373 'Welcome' => ts('Welcome Message'),
374 'Unsubscribe' => ts('Unsubscribe Message'),
375 'Resubscribe' => ts('Resubscribe Message'),
384 public function getHours() {
386 for ($i = 0; $i <= 6; $i++
) {
397 public function getMinutes() {
399 for ($i = 0; $i < 60; $i = $i +
15) {
406 * Get the Map Provider.
409 * array of map providers
411 public static function mapProvider() {
414 $map = ['' => '- select -'] + CRM_Utils_System
::getPluginList('templates/CRM/Contact/Form/Task/Map', ".tpl");
420 * Get the Geocoding Providers from available plugins.
423 * array of geocoder providers
425 public static function geoProvider() {
428 $geo = ['' => '- select -'] + CRM_Utils_System
::getPluginList('CRM/Utils/Geocode');
434 * Get options for displaying tax.
438 * @throws \CRM_Core_Exception
440 public static function taxDisplayOptions() {
442 'Do_not_show' => ts('Do not show breakdown, only show total - i.e %1', [
443 1 => CRM_Utils_Money
::format(120),
445 'Inclusive' => ts('Show [tax term] inclusive price - i.e. %1', [
446 1 => ts('%1 (includes [tax term] of %2)', [1 => CRM_Utils_Money
::format(120), 2 => CRM_Utils_Money
::format(20)]),
448 'Exclusive' => ts('Show [tax term] exclusive price - i.e. %1', [
449 1 => ts('%1 + %2 [tax term]', [1 => CRM_Utils_Money
::format(120), 2 => CRM_Utils_Money
::format(20)]),
455 * Get the Address Standardization Providers from available plugins.
458 * array of address standardization providers
460 public static function addressProvider() {
463 $addr = array_merge(['' => '- select -'], CRM_Utils_System
::getPluginList('CRM/Utils/Address', '.php', ['BatchUpdate']));
469 * Different type of Mailing Tokens.
473 public static function mailingTokens() {
475 '{action.unsubscribe}' => ts('Unsubscribe via email'),
476 '{action.unsubscribeUrl}' => ts('Unsubscribe via web page'),
477 '{action.resubscribe}' => ts('Resubscribe via email'),
478 '{action.resubscribeUrl}' => ts('Resubscribe via web page'),
479 '{action.optOut}' => ts('Opt out via email'),
480 '{action.optOutUrl}' => ts('Opt out via web page'),
481 '{action.forward}' => ts('Forward this email (link)'),
482 '{action.reply}' => ts('Reply to this email (link)'),
483 '{action.subscribeUrl}' => ts('Subscribe via web page'),
484 '{mailing.key}' => ts('Mailing key'),
485 '{mailing.name}' => ts('Mailing name'),
486 '{mailing.group}' => ts('Mailing group'),
487 '{mailing.viewUrl}' => ts('Mailing permalink'),
488 ] + self
::domainTokens();
496 public static function domainTokens() {
498 '{domain.name}' => ts('Domain name'),
499 '{domain.address}' => ts('Domain (organization) address'),
500 '{domain.phone}' => ts('Domain (organization) phone'),
501 '{domain.email}' => ts('Domain (organization) email'),
506 * Different type of Activity Tokens.
510 public static function activityTokens() {
512 '{activity.activity_id}' => ts('Activity ID'),
513 '{activity.subject}' => ts('Activity Subject'),
514 '{activity.details}' => ts('Activity Details'),
515 '{activity.activity_date_time}' => ts('Activity Date Time'),
520 * Different type of Membership Tokens.
524 public static function membershipTokens() {
526 '{membership.id}' => ts('Membership ID'),
527 '{membership.status}' => ts('Membership Status'),
528 '{membership.type}' => ts('Membership Type'),
529 '{membership.start_date}' => ts('Membership Start Date'),
530 '{membership.join_date}' => ts('Membership Join Date'),
531 '{membership.end_date}' => ts('Membership End Date'),
532 '{membership.fee}' => ts('Membership Fee'),
537 * Different type of Event Tokens.
541 public static function eventTokens() {
543 '{event.event_id}' => ts('Event ID'),
544 '{event.title}' => ts('Event Title'),
545 '{event.start_date}' => ts('Event Start Date'),
546 '{event.end_date}' => ts('Event End Date'),
547 '{event.event_type}' => ts('Event Type'),
548 '{event.summary}' => ts('Event Summary'),
549 '{event.contact_email}' => ts('Event Contact Email'),
550 '{event.contact_phone}' => ts('Event Contact Phone'),
551 '{event.description}' => ts('Event Description'),
552 '{event.location}' => ts('Event Location'),
553 '{event.fee_amount}' => ts('Event Fees'),
554 '{event.info_url}' => ts('Event Info URL'),
555 '{event.registration_url}' => ts('Event Registration URL'),
556 '{event.balance}' => ts('Event Balance'),
561 * Different type of Event Tokens.
565 public static function contributionTokens() {
567 '{contribution.contribution_id}' => ts('Contribution ID'),
568 '{contribution.total_amount}' => ts('Total Amount'),
569 '{contribution.fee_amount}' => ts('Fee Amount'),
570 '{contribution.net_amount}' => ts('Net Amount'),
571 '{contribution.non_deductible_amount}' => ts('Non-deductible Amount'),
572 '{contribution.receive_date}' => ts('Contribution Date Received'),
573 '{contribution.payment_instrument}' => ts('Payment Method'),
574 '{contribution.trxn_id}' => ts('Transaction ID'),
575 '{contribution.invoice_id}' => ts('Invoice ID'),
576 '{contribution.currency}' => ts('Currency'),
577 '{contribution.cancel_date}' => ts('Contribution Cancel Date'),
578 '{contribution.cancel_reason}' => ts('Contribution Cancel Reason'),
579 '{contribution.receipt_date}' => ts('Receipt Date'),
580 '{contribution.thankyou_date}' => ts('Thank You Date'),
581 '{contribution.contribution_source}' => ts('Contribution Source'),
582 '{contribution.amount_level}' => ts('Amount Level'),
583 //'{contribution.contribution_recur_id}' => ts('Contribution Recurring ID'),
584 //'{contribution.honor_contact_id}' => ts('Honor Contact ID'),
585 '{contribution.contribution_status_id}' => ts('Contribution Status ID'),
586 '{contribution.contribution_status_id:label}' => ts('Contribution Status'),
587 '{contribution.contribution_status_id:name}' => ts('Machine name') . ': ' . ts('Contribution Status'),
588 //'{contribution.honor_type_id}' => ts('Honor Type ID'),
589 //'{contribution.address_id}' => ts('Address ID'),
590 '{contribution.check_number}' => ts('Check Number'),
591 '{contribution.campaign}' => ts('Contribution Campaign'),
592 ], CRM_Utils_Token
::getCustomFieldTokens('Contribution', TRUE));
596 * Different type of Contact Tokens.
600 public static function contactTokens() {
601 static $tokens = NULL;
603 $additionalFields = [
604 'checksum' => ['title' => ts('Checksum')],
605 'contact_id' => ['title' => ts('Internal Contact ID')],
607 $exportFields = array_merge(CRM_Contact_BAO_Contact
::exportableFields(), $additionalFields);
609 $values = array_merge(array_keys($exportFields));
612 //FIXME:skipping some tokens for time being.
626 'postal_greeting_id',
629 $customFields = CRM_Core_BAO_CustomField
::getFields(['Individual', 'Address']);
630 $legacyTokenNames = array_flip(CRM_Utils_Token
::legacyContactTokens());
632 foreach ($values as $val) {
633 if (in_array($val, $skipTokens)) {
636 //keys for $tokens should be constant. $token Values are changed for Custom Fields. CRM-3734
637 $customFieldId = CRM_Core_BAO_CustomField
::getKeyID($val);
638 if ($customFieldId) {
639 // CRM-15191 - if key is not in $customFields then the field is disabled and should be ignored
640 if (!empty($customFields[$customFieldId])) {
641 $tokens["{contact.$val}"] = $customFields[$customFieldId]['label'] . " :: " . $customFields[$customFieldId]['groupTitle'];
645 // Support legacy token names
646 $tokenName = CRM_Utils_Array
::value($val, $legacyTokenNames, $val);
647 $tokens["{contact.$tokenName}"] = $exportFields[$val]['title'];
651 // Get all the hook tokens too
653 CRM_Utils_Hook
::tokens($hookTokens);
654 foreach ($hookTokens as $tokenValues) {
655 foreach ($tokenValues as $key => $value) {
656 if (is_numeric($key)) {
659 if (!preg_match('/^\{[^\}]+\}$/', $key)) {
660 $key = '{' . $key . '}';
662 if (preg_match('/^\{([^\}]+)\}$/', $value, $matches)) {
663 $value = $matches[1];
665 $tokens[$key] = $value;
674 * Different type of Participant Tokens.
678 public static function participantTokens() {
679 static $tokens = NULL;
681 $exportFields = CRM_Event_BAO_Participant
::exportableFields();
683 $values = array_merge(array_keys($exportFields));
686 // skipping some tokens for time being.
689 'participant_is_pay_later',
690 'participant_is_test',
691 'participant_contact_id',
692 'participant_fee_currency',
693 'participant_campaign_id',
694 'participant_status',
695 'participant_discount_name',
698 $customFields = CRM_Core_BAO_CustomField
::getFields('Participant');
700 foreach ($values as $key => $val) {
701 if (in_array($val, $skipTokens)) {
704 //keys for $tokens should be constant. $token Values are changed for Custom Fields. CRM-3734
705 if ($customFieldId = CRM_Core_BAO_CustomField
::getKeyID($val)) {
706 $tokens["{participant.$val}"] = !empty($customFields[$customFieldId]) ?
$customFields[$customFieldId]['label'] . " :: " . $customFields[$customFieldId]['groupTitle'] : '';
709 $tokens["{participant.$val}"] = $exportFields[$val]['title'];
717 * @param int $caseTypeId
720 public static function caseTokens($caseTypeId = NULL) {
721 static $tokens = NULL;
723 foreach (CRM_Case_BAO_Case
::fields() as $field) {
724 $tokens["{case.{$field['name']}}"] = $field['title'];
727 $customFields = CRM_Core_BAO_CustomField
::getFields('Case', FALSE, FALSE, $caseTypeId);
728 foreach ($customFields as $id => $field) {
729 $tokens["{case.custom_$id}"] = "{$field['label']} :: {$field['groupTitle']}";
736 * CiviCRM supported date input formats.
740 public static function getDatePluginInputFormats() {
742 'mm/dd/yy' => ts('mm/dd/yy (12/31/2009)'),
743 'dd/mm/yy' => ts('dd/mm/yy (31/12/2009)'),
744 'yy-mm-dd' => ts('yy-mm-dd (2009-12-31)'),
745 'dd-mm-yy' => ts('dd-mm-yy (31-12-2009)'),
746 'dd.mm.yy' => ts('dd.mm.yy (31.12.2009)'),
747 'M d, yy' => ts('M d, yy (Dec 31, 2009)'),
748 'd M yy' => ts('d M yy (31 Dec 2009)'),
749 'MM d, yy' => ts('MM d, yy (December 31, 2009)'),
750 'd MM yy' => ts('d MM yy (31 December 2009)'),
751 'DD, d MM yy' => ts('DD, d MM yy (Thursday, 31 December 2009)'),
752 'mm/dd' => ts('mm/dd (12/31)'),
753 'dd-mm' => ts('dd-mm (31-12)'),
754 'yy-mm' => ts('yy-mm (2009-12)'),
755 'M yy' => ts('M yy (Dec 2009)'),
756 'yy' => ts('yy (2009)'),
765 public static function getTimeFormats() {
767 '1' => ts('12 Hours'),
768 '2' => ts('24 Hours'),
773 * Get numeric options.
780 public static function getNumericOptions($start = 0, $end = 10) {
781 $numericOptions = [];
782 for ($i = $start; $i <= $end; $i++
) {
783 $numericOptions[$i] = $i;
785 return $numericOptions;
793 public static function getBarcodeTypes() {
795 'barcode' => ts('Linear (1D)'),
796 'qrcode' => ts('QR code'),
805 public static function getDedupeRuleTypes() {
807 'Unsupervised' => ts('Unsupervised'),
808 'Supervised' => ts('Supervised'),
809 'General' => ts('General'),
814 * Campaign group types.
818 public static function getCampaignGroupTypes() {
820 'Include' => ts('Include'),
821 'Exclude' => ts('Exclude'),
826 * Subscription history method.
830 public static function getSubscriptionHistoryMethods() {
832 'Admin' => ts('Admin'),
833 'Email' => ts('Email'),
844 public static function getPremiumUnits() {
847 'week' => ts('Week'),
848 'month' => ts('Month'),
849 'year' => ts('Year'),
858 public static function getExtensionTypes() {
860 'payment' => ts('Payment'),
861 'search' => ts('Search'),
862 'report' => ts('Report'),
863 'module' => ts('Module'),
873 public static function getJobFrequency() {
876 'Yearly' => ts('Yearly'),
877 'Quarter' => ts('Quarterly'),
878 'Monthly' => ts('Monthly'),
879 'Weekly' => ts('Weekly'),
881 'Daily' => ts('Daily'),
882 'Hourly' => ts('Hourly'),
883 'Always' => ts('Every time cron job is run'),
888 * Search builder operators.
892 public static function getSearchBuilderOperators() {
901 'NOT IN' => ts('Not In'),
902 'LIKE' => ts('Like'),
903 'NOT LIKE' => ts('Not Like'),
904 'RLIKE' => ts('Regex'),
905 'IS EMPTY' => ts('Is Empty'),
906 'IS NOT EMPTY' => ts('Not Empty'),
907 'IS NULL' => ts('Is Null'),
908 'IS NOT NULL' => ts('Not Null'),
913 * Profile group types.
917 public static function getProfileGroupType() {
918 $profileGroupType = [
919 'Activity' => ts('Activities'),
920 'Contribution' => ts('Contributions'),
921 'Membership' => ts('Memberships'),
922 'Participant' => ts('Participants'),
924 $contactTypes = self
::contactType();
925 $contactTypes = !empty($contactTypes) ?
['Contact' => 'Contacts'] +
$contactTypes : [];
926 $profileGroupType = array_merge($contactTypes, $profileGroupType);
928 return $profileGroupType;
932 * Word replacement match type.
936 public static function getWordReplacementMatchType() {
938 'exactMatch' => ts('Exact Match'),
939 'wildcardMatch' => ts('Wildcard Match'),
944 * Mailing group types.
948 public static function getMailingGroupTypes() {
950 'Include' => ts('Include'),
951 'Exclude' => ts('Exclude'),
952 'Base' => ts('Base'),
957 * Mailing Job Status.
961 public static function getMailingJobStatus() {
963 'Scheduled' => ts('Scheduled'),
964 'Running' => ts('Running'),
965 'Complete' => ts('Complete'),
966 'Paused' => ts('Paused'),
967 'Canceled' => ts('Canceled'),
974 public static function billingMode() {
976 CRM_Core_Payment
::BILLING_MODE_FORM
=> 'form',
977 CRM_Core_Payment
::BILLING_MODE_BUTTON
=> 'button',
978 CRM_Core_Payment
::BILLING_MODE_NOTIFY
=> 'notify',
985 public static function contributeMode() {
987 CRM_Core_Payment
::BILLING_MODE_FORM
=> 'direct',
988 CRM_Core_Payment
::BILLING_MODE_BUTTON
=> 'directIPN',
989 CRM_Core_Payment
::BILLING_MODE_NOTIFY
=> 'notify',
994 * Frequency unit for schedule reminders.
1000 public static function getRecurringFrequencyUnits($count = 1) {
1001 // @todo this used to refer to the 'recur_frequency_unit' option_values which
1002 // is for recurring payments and probably not good to re-use for recurring entities.
1003 // If something other than a hard-coded list is desired, add a new option_group.
1005 'hour' => ts('hour', ['plural' => 'hours', 'count' => $count]),
1006 'day' => ts('day', ['plural' => 'days', 'count' => $count]),
1007 'week' => ts('week', ['plural' => 'weeks', 'count' => $count]),
1008 'month' => ts('month', ['plural' => 'months', 'count' => $count]),
1009 'year' => ts('year', ['plural' => 'years', 'count' => $count]),
1014 * Relative Date Terms.
1018 public static function getRelativeDateTerms() {
1020 'previous' => ts('Previous'),
1021 'previous_2' => ts('Previous 2'),
1022 'previous_before' => ts('Prior to Previous'),
1023 'before_previous' => ts('All Prior to Previous'),
1024 'earlier' => ts('To End of Previous'),
1025 'greater_previous' => ts('From End of Previous'),
1026 'greater' => ts('From Start Of Current'),
1027 'current' => ts('Current'),
1028 'ending_3' => ts('Last 3'),
1029 'ending_2' => ts('Last 2'),
1030 'ending' => ts('Last'),
1031 'this' => ts('This'),
1032 'starting' => ts('Upcoming'),
1033 'less' => ts('To End of'),
1034 'next' => ts('Next'),
1039 * Relative Date Units.
1043 public static function getRelativeDateUnits() {
1045 'year' => ts('Years'),
1046 'fiscal_year' => ts('Fiscal Years'),
1047 'quarter' => ts('Quarters'),
1048 'month' => ts('Months'),
1049 'week' => ts('Weeks'),
1050 'day' => ts('Days'),
1055 * Exportable document formats.
1059 public static function documentFormat() {
1061 'pdf' => ts('Portable Document Format (.pdf)'),
1062 'docx' => ts('MS Word (.docx)'),
1063 'odt' => ts('Open Office (.odt)'),
1064 'html' => ts('Webpage (.html)'),
1069 * Application type of document.
1073 public static function documentApplicationType() {
1075 'docx' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
1076 'odt' => 'application/vnd.oasis.opendocument.text',
1081 * Activity Text options.
1085 public static function activityTextOptions() {
1087 2 => ts('Details Only'),
1088 3 => ts('Subject Only'),
1094 * Relationship permissions
1098 public static function getPermissionedRelationshipOptions() {
1100 CRM_Contact_BAO_Relationship
::NONE
=> ts('None'),
1101 CRM_Contact_BAO_Relationship
::VIEW
=> ts('View only'),
1102 CRM_Contact_BAO_Relationship
::EDIT
=> ts('View and update'),
1107 * Get option values for dashboard entries (used for 'how many events to display on dashboard').
1110 * Dashboard entries options - in practice [-1 => 'Show All', 10 => 10, 20 => 20, ... 100 => 100].
1112 public static function getDashboardEntriesCount() {
1114 $optionValues[-1] = ts('show all');
1115 for ($i = 10; $i <= 100; $i +
= 10) {
1116 $optionValues[$i] = $i;
1118 return $optionValues;
1122 * Dropdown options for quicksearch in the menu
1125 * @throws \CiviCRM_API3_Exception
1127 public static function quicksearchOptions() {
1128 $includeEmail = civicrm_api3('setting', 'getvalue', ['name' => 'includeEmailInName', 'group' => 'Search Preferences']);
1130 'sort_name' => $includeEmail ?
ts('Name/Email') : ts('Name'),
1131 'contact_id' => ts('Contact ID'),
1132 'external_identifier' => ts('External ID'),
1133 'first_name' => ts('First Name'),
1134 'last_name' => ts('Last Name'),
1135 'email' => ts('Email'),
1136 'phone_numeric' => ts('Phone'),
1137 'street_address' => ts('Street Address'),
1138 'city' => ts('City'),
1139 'postal_code' => ts('Postal Code'),
1140 'job_title' => ts('Job Title'),
1142 $custom = civicrm_api3('CustomField', 'get', [
1143 'return' => ['name', 'label', 'custom_group_id.title'],
1144 'custom_group_id.extends' => ['IN' => ['Contact', 'Individual', 'Organization', 'Household']],
1145 'data_type' => ['NOT IN' => ['ContactReference', 'Date', 'File']],
1146 'custom_group_id.is_active' => 1,
1148 'is_searchable' => 1,
1149 'options' => ['sort' => ['custom_group_id.weight', 'weight'], 'limit' => 0],
1151 foreach ($custom['values'] as $field) {
1152 $options['custom_' . $field['name']] = $field['custom_group_id.title'] . ': ' . $field['label'];
1158 * Get components (translated for display.
1162 * @throws \Exception
1164 public static function getComponentSelectValues() {
1166 $components = CRM_Core_Component
::getComponents();
1167 foreach ($components as $name => $object) {
1168 $ret[$name] = $object->info
['translatedName'];
1177 public static function fieldSerialization() {
1179 CRM_Core_DAO
::SERIALIZE_SEPARATOR_BOOKEND
=> 'separator_bookend',
1180 CRM_Core_DAO
::SERIALIZE_SEPARATOR_TRIMMED
=> 'separator_trimmed',
1181 CRM_Core_DAO
::SERIALIZE_JSON
=> 'json',
1182 CRM_Core_DAO
::SERIALIZE_PHP
=> 'php',
1183 CRM_Core_DAO
::SERIALIZE_COMMA
=> 'comma',
1190 public static function navigationMenuSeparator() {
1193 ts('After menu element'),
1194 ts('Before menu element'),
1201 public static function relationshipOrientation() {
1203 'a_b' => ts('A to B'),
1204 'b_a' => ts('B to A'),