CRM/Core/SelectValues.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   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  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  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
  16  *
  17  * @package CRM
  18  * @copyright CiviCRM LLC https://civicrm.org/licensing
  19  */
  20 class CRM_Core_SelectValues {
  21
  22   /**
  23    * Yes/No options
  24    *
  25    * @return array
  26    */
  27   public static function boolean() {
  28     return [
  29       1 => ts('Yes'),
  30       0 => ts('No'),
  31     ];
  32   }
  33
  34   /**
  35    * Preferred mail format.
  36    *
  37    * @return array
  38    */
  39   public static function pmf() {
  40     return [
  41       'Both' => ts('Both'),
  42       'HTML' => ts('HTML'),
  43       'Text' => ts('Text'),
  44     ];
  45   }
  46
  47   /**
  48    * Privacy options.
  49    *
  50    * @return array
  51    */
  52   public static function privacy() {
  53     return [
  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)'),
  60     ];
  61   }
  62
  63   /**
  64    * Various pre defined contact super types.
  65    *
  66    * @return array
  67    */
  68   public static function contactType() {
  69     return CRM_Contact_BAO_ContactType::basicTypePairs();
  70   }
  71
  72   /**
  73    * Various pre defined unit list.
  74    *
  75    * @param string $unitType
  76    * @return array
  77    */
  78   public static function unitList($unitType = NULL) {
  79     $unitList = [
  80       'day' => ts('day'),
  81       'month' => ts('month'),
  82       'year' => ts('year'),
  83     ];
  84     if ($unitType === 'duration') {
  85       $unitList['lifetime'] = ts('lifetime');
  86     }
  87     return $unitList;
  88   }
  89
  90   /**
  91    * Membership type unit.
  92    *
  93    * @return array
  94    */
  95   public static function membershipTypeUnitList() {
  96     return self::unitList('duration');
  97   }
  98
  99   /**
 100    * Various pre defined period types.
 101    *
 102    * @return array
 103    */
 104   public static function periodType() {
 105     return [
 106       'rolling' => ts('Rolling'),
 107       'fixed' => ts('Fixed'),
 108     ];
 109   }
 110
 111   /**
 112    * Various pre defined email selection methods.
 113    *
 114    * @return array
 115    */
 116   public static function emailSelectMethods() {
 117     return [
 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'),
 122     ];
 123   }
 124
 125   /**
 126    * Various pre defined member visibility options.
 127    *
 128    * @return array
 129    */
 130   public static function memberVisibility() {
 131     return [
 132       'Public' => ts('Public'),
 133       'Admin' => ts('Admin'),
 134     ];
 135   }
 136
 137   /**
 138    * Member auto-renew options
 139    *
 140    * @return array
 141    */
 142   public static function memberAutoRenew() {
 143     return [
 144       ts('No auto-renew option'),
 145       ts('Give option, but not required'),
 146       ts('Auto-renew required'),
 147     ];
 148   }
 149
 150   /**
 151    * Various pre defined event dates.
 152    *
 153    * @return array
 154    */
 155   public static function eventDate() {
 156     return [
 157       'start_date' => ts('start date'),
 158       'end_date' => ts('end date'),
 159       'join_date' => ts('member since'),
 160     ];
 161   }
 162
 163   /**
 164    * Custom form field types.
 165    *
 166    * @return array
 167    */
 168   public static function customHtmlType() {
 169     return [
 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'),
 180     ];
 181   }
 182
 183   /**
 184    * Various pre defined extensions for dynamic properties and groups.
 185    *
 186    * @return array
 187    *
 188    */
 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'),
 206     ];
 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;
 211   }
 212
 213   /**
 214    * Styles for displaying the custom data group.
 215    *
 216    * @return array
 217    */
 218   public static function customGroupStyle() {
 219     return [
 220       'Tab' => ts('Tab'),
 221       'Inline' => ts('Inline'),
 222       'Tab with table' => ts('Tab with table'),
 223     ];
 224   }
 225
 226   /**
 227    * For displaying the uf group types.
 228    *
 229    * @return array
 230    */
 231   public static function ufGroupTypes() {
 232     $ufGroupType = [
 233       'Profile' => ts('Standalone Form or Directory'),
 234       'Search Profile' => ts('Search Views'),
 235     ];
 236
 237     if (CRM_Core_Config::singleton()->userSystem->supports_form_extensions) {
 238       $ufGroupType += [
 239         'User Registration' => ts('Drupal User Registration'),
 240         'User Account' => ts('View/Edit Drupal User Account'),
 241       ];
 242     }
 243     return $ufGroupType;
 244   }
 245
 246   /**
 247    * The status of a contact within a group.
 248    *
 249    * @return array
 250    */
 251   public static function groupContactStatus() {
 252     return [
 253       'Added' => ts('Added'),
 254       'Removed' => ts('Removed'),
 255       'Pending' => ts('Pending'),
 256     ];
 257   }
 258
 259   /**
 260    * List of Group Types.
 261    *
 262    * @return array
 263    */
 264   public static function groupType() {
 265     return [
 266       'query' => ts('Dynamic'),
 267       'static' => ts('Static'),
 268     ];
 269   }
 270
 271   /**
 272    * Compose the parameters for a date select object.
 273    *
 274    * @param string|null $type
 275    *   the type of date
 276    * @param string|null $format
 277    *   date format (QF format)
 278    * @param null $minOffset
 279    * @param null $maxOffset
 280    * @param string $context
 281    *
 282    * @return array
 283    *   the date array
 284    * @throws CRM_Core_Exception
 285    */
 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.
 288     $date = [
 289       'addEmptyOption' => TRUE,
 290       'emptyOptionText' => ts('- select -'),
 291       'emptyOptionValue' => '',
 292     ];
 293
 294     if ($format) {
 295       $date['format'] = $format;
 296     }
 297     else {
 298       if ($type) {
 299         $dao = new CRM_Core_DAO_PreferencesDate();
 300         $dao->name = $type;
 301         if (!$dao->find(TRUE)) {
 302           throw new CRM_Core_Exception('Date preferences not configured.');
 303         }
 304         if (!$maxOffset) {
 305           $maxOffset = $dao->end;
 306         }
 307         if (!$minOffset) {
 308           $minOffset = $dao->start;
 309         }
 310
 311         $date['format'] = $dao->date_format;
 312         $date['time'] = (bool) $dao->time_format;
 313       }
 314
 315       if (empty($date['format'])) {
 316         if ($context === 'Input') {
 317           $date['format'] = Civi::settings()->get('dateInputFormat');
 318         }
 319         else {
 320           $date['format'] = 'M d';
 321         }
 322       }
 323     }
 324
 325     $date['smarty_view_format'] = CRM_Utils_Date::getDateFieldViewFormat($date['format']);
 326     if (!isset($date['time'])) {
 327       $date['time'] = FALSE;
 328     }
 329
 330     $year = date('Y');
 331     $date['minYear'] = $year - (int) $minOffset;
 332     $date['maxYear'] = $year + (int) $maxOffset;
 333     return $date;
 334   }
 335
 336   /**
 337    * Values for UF form visibility options.
 338    *
 339    * @return array
 340    */
 341   public static function ufVisibility() {
 342     return [
 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'),
 346     ];
 347   }
 348
 349   /**
 350    * Values for group form visibility options.
 351    *
 352    * @return array
 353    */
 354   public static function groupVisibility() {
 355     return [
 356       'User and User Admin Only' => ts('User and User Admin Only'),
 357       'Public Pages' => ts('Public Pages'),
 358     ];
 359   }
 360
 361   /**
 362    * Different type of Mailing Components.
 363    *
 364    * @return array
 365    */
 366   public static function mailingComponents() {
 367     return [
 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'),
 376     ];
 377   }
 378
 379   /**
 380    * Get hours.
 381    *
 382    * @return array
 383    */
 384   public function getHours() {
 385     $hours = [];
 386     for ($i = 0; $i <= 6; $i++) {
 387       $hours[$i] = $i;
 388     }
 389     return $hours;
 390   }
 391
 392   /**
 393    * Get minutes.
 394    *
 395    * @return array
 396    */
 397   public function getMinutes() {
 398     $minutes = [];
 399     for ($i = 0; $i < 60; $i = $i + 15) {
 400       $minutes[$i] = $i;
 401     }
 402     return $minutes;
 403   }
 404
 405   /**
 406    * Get the Map Provider.
 407    *
 408    * @return array
 409    *   array of map providers
 410    */
 411   public static function mapProvider() {
 412     static $map = NULL;
 413     if (!$map) {
 414       $map = ['' => '- select -'] + CRM_Utils_System::getPluginList('templates/CRM/Contact/Form/Task/Map', ".tpl");
 415     }
 416     return $map;
 417   }
 418
 419   /**
 420    * Get the Geocoding Providers from available plugins.
 421    *
 422    * @return array
 423    *   array of geocoder providers
 424    */
 425   public static function geoProvider() {
 426     static $geo = NULL;
 427     if (!$geo) {
 428       $geo = ['' => '- select -'] + CRM_Utils_System::getPluginList('CRM/Utils/Geocode');
 429     }
 430     return $geo;
 431   }
 432
 433   /**
 434    * Get options for displaying tax.
 435    *
 436    * @return array
 437    *
 438    * @throws \CRM_Core_Exception
 439    */
 440   public static function taxDisplayOptions() {
 441     return [
 442       'Do_not_show' => ts('Do not show breakdown, only show total - i.e %1', [
 443         1 => CRM_Utils_Money::format(120),
 444       ]),
 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)]),
 447       ]),
 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)]),
 450       ]),
 451     ];
 452   }
 453
 454   /**
 455    * Get the Address Standardization Providers from available plugins.
 456    *
 457    * @return array
 458    *   array of address standardization providers
 459    */
 460   public static function addressProvider() {
 461     static $addr = NULL;
 462     if (!$addr) {
 463       $addr = array_merge(['' => '- select -'], CRM_Utils_System::getPluginList('CRM/Utils/Address', '.php', ['BatchUpdate']));
 464     }
 465     return $addr;
 466   }
 467
 468   /**
 469    * Different type of Mailing Tokens.
 470    *
 471    * @return array
 472    */
 473   public static function mailingTokens() {
 474     return [
 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();
 489   }
 490
 491   /**
 492    * Domain tokens
 493    *
 494    * @return array
 495    */
 496   public static function domainTokens() {
 497     return [
 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'),
 502     ];
 503   }
 504
 505   /**
 506    * Different type of Activity Tokens.
 507    *
 508    * @return array
 509    */
 510   public static function activityTokens() {
 511     return [
 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'),
 516     ];
 517   }
 518
 519   /**
 520    * Different type of Membership Tokens.
 521    *
 522    * @return array
 523    */
 524   public static function membershipTokens() {
 525     return [
 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'),
 533     ];
 534   }
 535
 536   /**
 537    * Different type of Event Tokens.
 538    *
 539    * @return array
 540    */
 541   public static function eventTokens() {
 542     return [
 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'),
 557     ];
 558   }
 559
 560   /**
 561    * Different type of Event Tokens.
 562    *
 563    * @return array
 564    */
 565   public static function contributionTokens(): array {
 566     $tokens = [];
 567     $processor = new CRM_Contribute_Tokens();
 568     foreach ($processor->getAllTokens() as $token => $title) {
 569       $tokens['{contribution.' . $token . '}'] = $title;
 570     }
 571     return $tokens;
 572   }
 573
 574   /**
 575    * Different type of Contact Tokens.
 576    *
 577    * @return array
 578    */
 579   public static function contactTokens() {
 580     static $tokens = NULL;
 581     if (!$tokens) {
 582       $additionalFields = [
 583         'checksum' => ['title' => ts('Checksum')],
 584         'contact_id' => ['title' => ts('Internal Contact ID')],
 585       ];
 586       $exportFields = array_merge(CRM_Contact_BAO_Contact::exportableFields(), $additionalFields);
 587
 588       $values = array_merge(array_keys($exportFields));
 589       unset($values[0]);
 590
 591       //FIXME:skipping some tokens for time being.
 592       $skipTokens = [
 593         'is_bulkmail',
 594         'group',
 595         'tag',
 596         'contact_sub_type',
 597         'note',
 598         'is_deceased',
 599         'deceased_date',
 600         'legal_identifier',
 601         'contact_sub_type',
 602         'user_unique_id',
 603         'addressee_id',
 604         'email_greeting_id',
 605         'postal_greeting_id',
 606       ];
 607
 608       $customFields = CRM_Core_BAO_CustomField::getFields(['Individual', 'Address']);
 609       $legacyTokenNames = array_flip(CRM_Utils_Token::legacyContactTokens());
 610
 611       foreach ($values as $val) {
 612         if (in_array($val, $skipTokens)) {
 613           continue;
 614         }
 615         //keys for $tokens should be constant. $token Values are changed for Custom Fields. CRM-3734
 616         $customFieldId = CRM_Core_BAO_CustomField::getKeyID($val);
 617         if ($customFieldId) {
 618           // CRM-15191 - if key is not in $customFields then the field is disabled and should be ignored
 619           if (!empty($customFields[$customFieldId])) {
 620             $tokens["{contact.$val}"] = $customFields[$customFieldId]['label'] . " :: " . $customFields[$customFieldId]['groupTitle'];
 621           }
 622         }
 623         else {
 624           // Support legacy token names
 625           $tokenName = CRM_Utils_Array::value($val, $legacyTokenNames, $val);
 626           $tokens["{contact.$tokenName}"] = $exportFields[$val]['title'];
 627         }
 628       }
 629
 630       // Get all the hook tokens too
 631       $hookTokens = [];
 632       CRM_Utils_Hook::tokens($hookTokens);
 633       foreach ($hookTokens as $tokenValues) {
 634         foreach ($tokenValues as $key => $value) {
 635           if (is_numeric($key)) {
 636             $key = $value;
 637           }
 638           if (!preg_match('/^\{[^\}]+\}$/', $key)) {
 639             $key = '{' . $key . '}';
 640           }
 641           if (preg_match('/^\{([^\}]+)\}$/', $value, $matches)) {
 642             $value = $matches[1];
 643           }
 644           $tokens[$key] = $value;
 645         }
 646       }
 647     }
 648
 649     return $tokens;
 650   }
 651
 652   /**
 653    * Different type of Participant Tokens.
 654    *
 655    * @return array
 656    */
 657   public static function participantTokens() {
 658     static $tokens = NULL;
 659     if (!$tokens) {
 660       $exportFields = CRM_Event_BAO_Participant::exportableFields();
 661
 662       $values = array_merge(array_keys($exportFields));
 663       unset($values[0]);
 664
 665       // skipping some tokens for time being.
 666       $skipTokens = [
 667         'event_id',
 668         'participant_is_pay_later',
 669         'participant_is_test',
 670         'participant_contact_id',
 671         'participant_fee_currency',
 672         'participant_campaign_id',
 673         'participant_status',
 674         'participant_discount_name',
 675       ];
 676
 677       $customFields = CRM_Core_BAO_CustomField::getFields('Participant');
 678
 679       foreach ($values as $key => $val) {
 680         if (in_array($val, $skipTokens)) {
 681           continue;
 682         }
 683         //keys for $tokens should be constant. $token Values are changed for Custom Fields. CRM-3734
 684         if ($customFieldId = CRM_Core_BAO_CustomField::getKeyID($val)) {
 685           $tokens["{participant.$val}"] = !empty($customFields[$customFieldId]) ? $customFields[$customFieldId]['label'] . " :: " . $customFields[$customFieldId]['groupTitle'] : '';
 686         }
 687         else {
 688           $tokens["{participant.$val}"] = $exportFields[$val]['title'];
 689         }
 690       }
 691     }
 692     return $tokens;
 693   }
 694
 695   /**
 696    * @param int $caseTypeId
 697    * @return array
 698    */
 699   public static function caseTokens($caseTypeId = NULL) {
 700     static $tokens = NULL;
 701     if (!$tokens) {
 702       foreach (CRM_Case_BAO_Case::fields() as $field) {
 703         $tokens["{case.{$field['name']}}"] = $field['title'];
 704       }
 705
 706       $customFields = CRM_Core_BAO_CustomField::getFields('Case', FALSE, FALSE, $caseTypeId);
 707       foreach ($customFields as $id => $field) {
 708         $tokens["{case.custom_$id}"] = "{$field['label']} :: {$field['groupTitle']}";
 709       }
 710     }
 711     return $tokens;
 712   }
 713
 714   /**
 715    * CiviCRM supported date input formats.
 716    *
 717    * @return array
 718    */
 719   public static function getDatePluginInputFormats() {
 720     return [
 721       'mm/dd/yy' => ts('mm/dd/yy (12/31/2009)'),
 722       'dd/mm/yy' => ts('dd/mm/yy (31/12/2009)'),
 723       'yy-mm-dd' => ts('yy-mm-dd (2009-12-31)'),
 724       'dd-mm-yy' => ts('dd-mm-yy (31-12-2009)'),
 725       'dd.mm.yy' => ts('dd.mm.yy (31.12.2009)'),
 726       'M d, yy' => ts('M d, yy (Dec 31, 2009)'),
 727       'd M yy' => ts('d M yy (31 Dec 2009)'),
 728       'MM d, yy' => ts('MM d, yy (December 31, 2009)'),
 729       'd MM yy' => ts('d MM yy (31 December 2009)'),
 730       'DD, d MM yy' => ts('DD, d MM yy (Thursday, 31 December 2009)'),
 731       'mm/dd' => ts('mm/dd (12/31)'),
 732       'dd-mm' => ts('dd-mm (31-12)'),
 733       'yy-mm' => ts('yy-mm (2009-12)'),
 734       'M yy' => ts('M yy (Dec 2009)'),
 735       'yy' => ts('yy (2009)'),
 736     ];
 737   }
 738
 739   /**
 740    * Time formats.
 741    *
 742    * @return array
 743    */
 744   public static function getTimeFormats() {
 745     return [
 746       '1' => ts('12 Hours'),
 747       '2' => ts('24 Hours'),
 748     ];
 749   }
 750
 751   /**
 752    * Get numeric options.
 753    *
 754    * @param int $start
 755    * @param int $end
 756    *
 757    * @return array
 758    */
 759   public static function getNumericOptions($start = 0, $end = 10) {
 760     $numericOptions = [];
 761     for ($i = $start; $i <= $end; $i++) {
 762       $numericOptions[$i] = $i;
 763     }
 764     return $numericOptions;
 765   }
 766
 767   /**
 768    * Barcode types.
 769    *
 770    * @return array
 771    */
 772   public static function getBarcodeTypes() {
 773     return [
 774       'barcode' => ts('Linear (1D)'),
 775       'qrcode' => ts('QR code'),
 776     ];
 777   }
 778
 779   /**
 780    * Dedupe rule types.
 781    *
 782    * @return array
 783    */
 784   public static function getDedupeRuleTypes() {
 785     return [
 786       'Unsupervised' => ts('Unsupervised'),
 787       'Supervised' => ts('Supervised'),
 788       'General' => ts('General'),
 789     ];
 790   }
 791
 792   /**
 793    * Campaign group types.
 794    *
 795    * @return array
 796    */
 797   public static function getCampaignGroupTypes() {
 798     return [
 799       'Include' => ts('Include'),
 800       'Exclude' => ts('Exclude'),
 801     ];
 802   }
 803
 804   /**
 805    * Subscription history method.
 806    *
 807    * @return array
 808    */
 809   public static function getSubscriptionHistoryMethods() {
 810     return [
 811       'Admin' => ts('Admin'),
 812       'Email' => ts('Email'),
 813       'Web' => ts('Web'),
 814       'API' => ts('API'),
 815     ];
 816   }
 817
 818   /**
 819    * Premium units.
 820    *
 821    * @return array
 822    */
 823   public static function getPremiumUnits() {
 824     return [
 825       'day' => ts('Day'),
 826       'week' => ts('Week'),
 827       'month' => ts('Month'),
 828       'year' => ts('Year'),
 829     ];
 830   }
 831
 832   /**
 833    * Extension types.
 834    *
 835    * @return array
 836    */
 837   public static function getExtensionTypes() {
 838     return [
 839       'payment' => ts('Payment'),
 840       'search' => ts('Search'),
 841       'report' => ts('Report'),
 842       'module' => ts('Module'),
 843       'sms' => ts('SMS'),
 844     ];
 845   }
 846
 847   /**
 848    * Job frequency.
 849    *
 850    * @return array
 851    */
 852   public static function getJobFrequency() {
 853     return [
 854       // CRM-17669
 855       'Yearly' => ts('Yearly'),
 856       'Quarter' => ts('Quarterly'),
 857       'Monthly' => ts('Monthly'),
 858       'Weekly' => ts('Weekly'),
 859
 860       'Daily' => ts('Daily'),
 861       'Hourly' => ts('Hourly'),
 862       'Always' => ts('Every time cron job is run'),
 863     ];
 864   }
 865
 866   /**
 867    * Search builder operators.
 868    *
 869    * @return array
 870    */
 871   public static function getSearchBuilderOperators() {
 872     return [
 873       '=' => '=',
 874       '!=' => '≠',
 875       '>' => '>',
 876       '<' => '<',
 877       '>=' => '≥',
 878       '<=' => '≤',
 879       'IN' => ts('In'),
 880       'NOT IN' => ts('Not In'),
 881       'LIKE' => ts('Like'),
 882       'NOT LIKE' => ts('Not Like'),
 883       'RLIKE' => ts('Regex'),
 884       'IS EMPTY' => ts('Is Empty'),
 885       'IS NOT EMPTY' => ts('Not Empty'),
 886       'IS NULL' => ts('Is Null'),
 887       'IS NOT NULL' => ts('Not Null'),
 888     ];
 889   }
 890
 891   /**
 892    * Profile group types.
 893    *
 894    * @return array
 895    */
 896   public static function getProfileGroupType() {
 897     $profileGroupType = [
 898       'Activity' => ts('Activities'),
 899       'Contribution' => ts('Contributions'),
 900       'Membership' => ts('Memberships'),
 901       'Participant' => ts('Participants'),
 902     ];
 903     $contactTypes = self::contactType();
 904     $contactTypes = !empty($contactTypes) ? ['Contact' => 'Contacts'] + $contactTypes : [];
 905     $profileGroupType = array_merge($contactTypes, $profileGroupType);
 906
 907     return $profileGroupType;
 908   }
 909
 910   /**
 911    * Word replacement match type.
 912    *
 913    * @return array
 914    */
 915   public static function getWordReplacementMatchType() {
 916     return [
 917       'exactMatch' => ts('Exact Match'),
 918       'wildcardMatch' => ts('Wildcard Match'),
 919     ];
 920   }
 921
 922   /**
 923    * Mailing group types.
 924    *
 925    * @return array
 926    */
 927   public static function getMailingGroupTypes() {
 928     return [
 929       'Include' => ts('Include'),
 930       'Exclude' => ts('Exclude'),
 931       'Base' => ts('Base'),
 932     ];
 933   }
 934
 935   /**
 936    * Mailing Job Status.
 937    *
 938    * @return array
 939    */
 940   public static function getMailingJobStatus() {
 941     return [
 942       'Scheduled' => ts('Scheduled'),
 943       'Running' => ts('Running'),
 944       'Complete' => ts('Complete'),
 945       'Paused' => ts('Paused'),
 946       'Canceled' => ts('Canceled'),
 947     ];
 948   }
 949
 950   /**
 951    * @return array
 952    */
 953   public static function billingMode() {
 954     return [
 955       CRM_Core_Payment::BILLING_MODE_FORM => 'form',
 956       CRM_Core_Payment::BILLING_MODE_BUTTON => 'button',
 957       CRM_Core_Payment::BILLING_MODE_NOTIFY => 'notify',
 958     ];
 959   }
 960
 961   /**
 962    * @return array
 963    */
 964   public static function contributeMode() {
 965     return [
 966       CRM_Core_Payment::BILLING_MODE_FORM => 'direct',
 967       CRM_Core_Payment::BILLING_MODE_BUTTON => 'directIPN',
 968       CRM_Core_Payment::BILLING_MODE_NOTIFY => 'notify',
 969     ];
 970   }
 971
 972   /**
 973    * Frequency unit for schedule reminders.
 974    *
 975    * @param int $count
 976    *   For pluralization
 977    * @return array
 978    */
 979   public static function getRecurringFrequencyUnits($count = 1) {
 980     // @todo this used to refer to the 'recur_frequency_unit' option_values which
 981     // is for recurring payments and probably not good to re-use for recurring entities.
 982     // If something other than a hard-coded list is desired, add a new option_group.
 983     return [
 984       'hour' => ts('hour', ['plural' => 'hours', 'count' => $count]),
 985       'day' => ts('day', ['plural' => 'days', 'count' => $count]),
 986       'week' => ts('week', ['plural' => 'weeks', 'count' => $count]),
 987       'month' => ts('month', ['plural' => 'months', 'count' => $count]),
 988       'year' => ts('year', ['plural' => 'years', 'count' => $count]),
 989     ];
 990   }
 991
 992   /**
 993    * Relative Date Terms.
 994    *
 995    * @return array
 996    */
 997   public static function getRelativeDateTerms() {
 998     return [
 999       'previous' => ts('Previous'),
1000       'previous_2' => ts('Previous 2'),
1001       'previous_before' => ts('Prior to Previous'),
1002       'before_previous' => ts('All Prior to Previous'),
1003       'earlier' => ts('To End of Previous'),
1004       'greater_previous' => ts('From End of Previous'),
1005       'greater' => ts('From Start Of Current'),
1006       'current' => ts('Current'),
1007       'ending_3' => ts('Last 3'),
1008       'ending_2' => ts('Last 2'),
1009       'ending' => ts('Last'),
1010       'this' => ts('This'),
1011       'starting' => ts('Upcoming'),
1012       'less' => ts('To End of'),
1013       'next' => ts('Next'),
1014     ];
1015   }
1016
1017   /**
1018    * Relative Date Units.
1019    *
1020    * @return array
1021    */
1022   public static function getRelativeDateUnits() {
1023     return [
1024       'year' => ts('Years'),
1025       'fiscal_year' => ts('Fiscal Years'),
1026       'quarter' => ts('Quarters'),
1027       'month' => ts('Months'),
1028       'week' => ts('Weeks'),
1029       'day' => ts('Days'),
1030     ];
1031   }
1032
1033   /**
1034    * Exportable document formats.
1035    *
1036    * @return array
1037    */
1038   public static function documentFormat() {
1039     return [
1040       'pdf' => ts('Portable Document Format (.pdf)'),
1041       'docx' => ts('MS Word (.docx)'),
1042       'odt' => ts('Open Office (.odt)'),
1043       'html' => ts('Webpage (.html)'),
1044     ];
1045   }
1046
1047   /**
1048    * Application type of document.
1049    *
1050    * @return array
1051    */
1052   public static function documentApplicationType() {
1053     return [
1054       'docx' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
1055       'odt' => 'application/vnd.oasis.opendocument.text',
1056     ];
1057   }
1058
1059   /**
1060    * Activity Text options.
1061    *
1062    * @return array
1063    */
1064   public static function activityTextOptions() {
1065     return [
1066       2 => ts('Details Only'),
1067       3 => ts('Subject Only'),
1068       6 => ts('Both'),
1069     ];
1070   }
1071
1072   /**
1073    * Relationship permissions
1074    *
1075    * @return array
1076    */
1077   public static function getPermissionedRelationshipOptions() {
1078     return [
1079       CRM_Contact_BAO_Relationship::NONE => ts('None'),
1080       CRM_Contact_BAO_Relationship::VIEW => ts('View only'),
1081       CRM_Contact_BAO_Relationship::EDIT => ts('View and update'),
1082     ];
1083   }
1084
1085   /**
1086    * Get option values for dashboard entries (used for 'how many events to display on dashboard').
1087    *
1088    * @return array
1089    *   Dashboard entries options - in practice [-1 => 'Show All', 10 => 10, 20 => 20, ... 100 => 100].
1090    */
1091   public static function getDashboardEntriesCount() {
1092     $optionValues = [];
1093     $optionValues[-1] = ts('show all');
1094     for ($i = 10; $i <= 100; $i += 10) {
1095       $optionValues[$i] = $i;
1096     }
1097     return $optionValues;
1098   }
1099
1100   /**
1101    * Dropdown options for quicksearch in the menu
1102    *
1103    * @return array
1104    * @throws \CiviCRM_API3_Exception
1105    */
1106   public static function quicksearchOptions() {
1107     $includeEmail = civicrm_api3('setting', 'getvalue', ['name' => 'includeEmailInName', 'group' => 'Search Preferences']);
1108     $options = [
1109       'sort_name' => $includeEmail ? ts('Name/Email') : ts('Name'),
1110       'contact_id' => ts('Contact ID'),
1111       'external_identifier' => ts('External ID'),
1112       'first_name' => ts('First Name'),
1113       'last_name' => ts('Last Name'),
1114       'email' => ts('Email'),
1115       'phone_numeric' => ts('Phone'),
1116       'street_address' => ts('Street Address'),
1117       'city' => ts('City'),
1118       'postal_code' => ts('Postal Code'),
1119       'job_title' => ts('Job Title'),
1120     ];
1121     $custom = civicrm_api3('CustomField', 'get', [
1122       'return' => ['name', 'label', 'custom_group_id.title'],
1123       'custom_group_id.extends' => ['IN' => ['Contact', 'Individual', 'Organization', 'Household']],
1124       'data_type' => ['NOT IN' => ['ContactReference', 'Date', 'File']],
1125       'custom_group_id.is_active' => 1,
1126       'is_active' => 1,
1127       'is_searchable' => 1,
1128       'options' => ['sort' => ['custom_group_id.weight', 'weight'], 'limit' => 0],
1129     ]);
1130     foreach ($custom['values'] as $field) {
1131       $options['custom_' . $field['name']] = $field['custom_group_id.title'] . ': ' . $field['label'];
1132     }
1133     return $options;
1134   }
1135
1136   /**
1137    * Get components (translated for display.
1138    *
1139    * @return array
1140    *
1141    * @throws \Exception
1142    */
1143   public static function getComponentSelectValues() {
1144     $ret = [];
1145     $components = CRM_Core_Component::getComponents();
1146     foreach ($components as $name => $object) {
1147       $ret[$name] = $object->info['translatedName'];
1148     }
1149
1150     return $ret;
1151   }
1152
1153   /**
1154    * @return string[]
1155    */
1156   public static function fieldSerialization() {
1157     return [
1158       CRM_Core_DAO::SERIALIZE_SEPARATOR_BOOKEND => 'separator_bookend',
1159       CRM_Core_DAO::SERIALIZE_SEPARATOR_TRIMMED => 'separator_trimmed',
1160       CRM_Core_DAO::SERIALIZE_JSON => 'json',
1161       CRM_Core_DAO::SERIALIZE_PHP => 'php',
1162       CRM_Core_DAO::SERIALIZE_COMMA => 'comma',
1163     ];
1164   }
1165
1166   /**
1167    * @return array
1168    */
1169   public static function navigationMenuSeparator() {
1170     return [
1171       ts('None'),
1172       ts('After menu element'),
1173       ts('Before menu element'),
1174     ];
1175   }
1176
1177   /**
1178    * @return array
1179    */
1180   public static function relationshipOrientation() {
1181     return [
1182       'a_b' => ts('A to B'),
1183       'b_a' => ts('B to A'),
1184     ];
1185   }
1186
1187 }