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       'Select State/Province' => ts('Select State/Province'),
 178       'Select Country' => ts('Select Country'),
 179       'RichTextEditor' => ts('Rich Text Editor'),
 180       'Autocomplete-Select' => ts('Autocomplete-Select'),
 181       'Link' => ts('Link'),
 182       'ContactReference' => ts('Autocomplete-Select'),
 183     ];
 184   }
 185
 186   /**
 187    * Various pre defined extensions for dynamic properties and groups.
 188    *
 189    * @return array
 190    *
 191    */
 192   public static function customGroupExtends() {
 193     $customGroupExtends = [
 194       'Activity' => ts('Activities'),
 195       'Relationship' => ts('Relationships'),
 196       'Contribution' => ts('Contributions'),
 197       'ContributionRecur' => ts('Recurring Contributions'),
 198       'Group' => ts('Groups'),
 199       'Membership' => ts('Memberships'),
 200       'Event' => ts('Events'),
 201       'Participant' => ts('Participants'),
 202       'ParticipantRole' => ts('Participants (Role)'),
 203       'ParticipantEventName' => ts('Participants (Event Name)'),
 204       'ParticipantEventType' => ts('Participants (Event Type)'),
 205       'Pledge' => ts('Pledges'),
 206       'Grant' => ts('Grants'),
 207       'Address' => ts('Addresses'),
 208       'Campaign' => ts('Campaigns'),
 209     ];
 210     $contactTypes = self::contactType();
 211     $contactTypes = !empty($contactTypes) ? ['Contact' => 'Contacts'] + $contactTypes : [];
 212     $extendObjs = CRM_Core_OptionGroup::values('cg_extend_objects');
 213     $customGroupExtends = array_merge($contactTypes, $customGroupExtends, $extendObjs);
 214     return $customGroupExtends;
 215   }
 216
 217   /**
 218    * Styles for displaying the custom data group.
 219    *
 220    * @return array
 221    */
 222   public static function customGroupStyle() {
 223     return [
 224       'Tab' => ts('Tab'),
 225       'Inline' => ts('Inline'),
 226       'Tab with table' => ts('Tab with table'),
 227     ];
 228   }
 229
 230   /**
 231    * For displaying the uf group types.
 232    *
 233    * @return array
 234    */
 235   public static function ufGroupTypes() {
 236     $ufGroupType = [
 237       'Profile' => ts('Standalone Form or Directory'),
 238       'Search Profile' => ts('Search Views'),
 239     ];
 240
 241     if (CRM_Core_Config::singleton()->userSystem->supports_form_extensions) {
 242       $ufGroupType += [
 243         'User Registration' => ts('Drupal User Registration'),
 244         'User Account' => ts('View/Edit Drupal User Account'),
 245       ];
 246     }
 247     return $ufGroupType;
 248   }
 249
 250   /**
 251    * The status of a contact within a group.
 252    *
 253    * @return array
 254    */
 255   public static function groupContactStatus() {
 256     return [
 257       'Added' => ts('Added'),
 258       'Removed' => ts('Removed'),
 259       'Pending' => ts('Pending'),
 260     ];
 261   }
 262
 263   /**
 264    * List of Group Types.
 265    *
 266    * @return array
 267    */
 268   public static function groupType() {
 269     return [
 270       'query' => ts('Dynamic'),
 271       'static' => ts('Static'),
 272     ];
 273   }
 274
 275   /**
 276    * Compose the parameters for a date select object.
 277    *
 278    * @param string|null $type
 279    *   the type of date
 280    * @param string|null $format
 281    *   date format (QF format)
 282    * @param null $minOffset
 283    * @param null $maxOffset
 284    * @param string $context
 285    *
 286    * @return array
 287    *   the date array
 288    * @throws CRM_Core_Exception
 289    */
 290   public static function date($type = NULL, $format = NULL, $minOffset = NULL, $maxOffset = NULL, $context = 'display') {
 291     // These options are deprecated. Definitely not used in datepicker. Possibly not even in jcalendar+addDateTime.
 292     $date = [
 293       'addEmptyOption' => TRUE,
 294       'emptyOptionText' => ts('- select -'),
 295       'emptyOptionValue' => '',
 296     ];
 297
 298     if ($format) {
 299       $date['format'] = $format;
 300     }
 301     else {
 302       if ($type) {
 303         $dao = new CRM_Core_DAO_PreferencesDate();
 304         $dao->name = $type;
 305         if (!$dao->find(TRUE)) {
 306           throw new CRM_Core_Exception('Date preferences not configured.');
 307         }
 308         if (!$maxOffset) {
 309           $maxOffset = $dao->end;
 310         }
 311         if (!$minOffset) {
 312           $minOffset = $dao->start;
 313         }
 314
 315         $date['format'] = $dao->date_format;
 316         $date['time'] = (bool) $dao->time_format;
 317       }
 318
 319       if (empty($date['format'])) {
 320         if ($context === 'Input') {
 321           $date['format'] = Civi::settings()->get('dateInputFormat');
 322         }
 323         else {
 324           $date['format'] = 'M d';
 325         }
 326       }
 327     }
 328
 329     $date['smarty_view_format'] = CRM_Utils_Date::getDateFieldViewFormat($date['format']);
 330     if (!isset($date['time'])) {
 331       $date['time'] = FALSE;
 332     }
 333
 334     $year = date('Y');
 335     $date['minYear'] = $year - (int) $minOffset;
 336     $date['maxYear'] = $year + (int) $maxOffset;
 337     return $date;
 338   }
 339
 340   /**
 341    * Values for UF form visibility options.
 342    *
 343    * @return array
 344    */
 345   public static function ufVisibility() {
 346     return [
 347       'User and User Admin Only' => ts('User and User Admin Only'),
 348       'Public Pages' => ts('Expose Publicly'),
 349       'Public Pages and Listings' => ts('Expose Publicly and for Listings'),
 350     ];
 351   }
 352
 353   /**
 354    * Values for group form visibility options.
 355    *
 356    * @return array
 357    */
 358   public static function groupVisibility() {
 359     return [
 360       'User and User Admin Only' => ts('User and User Admin Only'),
 361       'Public Pages' => ts('Public Pages'),
 362     ];
 363   }
 364
 365   /**
 366    * Different type of Mailing Components.
 367    *
 368    * @return array
 369    */
 370   public static function mailingComponents() {
 371     return [
 372       'Header' => ts('Header'),
 373       'Footer' => ts('Footer'),
 374       'Reply' => ts('Reply Auto-responder'),
 375       'OptOut' => ts('Opt-out Message'),
 376       'Subscribe' => ts('Subscription Confirmation Request'),
 377       'Welcome' => ts('Welcome Message'),
 378       'Unsubscribe' => ts('Unsubscribe Message'),
 379       'Resubscribe' => ts('Resubscribe Message'),
 380     ];
 381   }
 382
 383   /**
 384    * Get hours.
 385    *
 386    * @return array
 387    */
 388   public function getHours() {
 389     $hours = [];
 390     for ($i = 0; $i <= 6; $i++) {
 391       $hours[$i] = $i;
 392     }
 393     return $hours;
 394   }
 395
 396   /**
 397    * Get minutes.
 398    *
 399    * @return array
 400    */
 401   public function getMinutes() {
 402     $minutes = [];
 403     for ($i = 0; $i < 60; $i = $i + 15) {
 404       $minutes[$i] = $i;
 405     }
 406     return $minutes;
 407   }
 408
 409   /**
 410    * Get the Map Provider.
 411    *
 412    * @return array
 413    *   array of map providers
 414    */
 415   public static function mapProvider() {
 416     static $map = NULL;
 417     if (!$map) {
 418       $map = ['' => '- select -'] + CRM_Utils_System::getPluginList('templates/CRM/Contact/Form/Task/Map', ".tpl");
 419     }
 420     return $map;
 421   }
 422
 423   /**
 424    * Get the Geocoding Providers from available plugins.
 425    *
 426    * @return array
 427    *   array of geocoder providers
 428    */
 429   public static function geoProvider() {
 430     static $geo = NULL;
 431     if (!$geo) {
 432       $geo = ['' => '- select -'] + CRM_Utils_System::getPluginList('CRM/Utils/Geocode');
 433     }
 434     return $geo;
 435   }
 436
 437   /**
 438    * Get options for displaying tax.
 439    *
 440    * @return array
 441    *
 442    * @throws \CRM_Core_Exception
 443    */
 444   public function taxDisplayOptions() {
 445     return [
 446       'Do_not_show' => ts('Do not show breakdown, only show total - i.e %1', [
 447         1 => CRM_Utils_Money::format(120),
 448       ]),
 449       'Inclusive' => ts('Show [tax term] inclusive price - i.e. %1', [
 450         1 => ts('%1 (includes [tax term] of %2)', [1 => CRM_Utils_Money::format(120), 2 => CRM_Utils_Money::format(20)]),
 451       ]),
 452       'Exclusive' => ts('Show [tax term] exclusive price - i.e. %1', [
 453         1 => ts('%1 + %2 [tax term]', [1 => CRM_Utils_Money::format(120), 2 => CRM_Utils_Money::format(20)]),
 454       ]),
 455     ];
 456   }
 457
 458   /**
 459    * Get the Address Standardization Providers from available plugins.
 460    *
 461    * @return array
 462    *   array of address standardization providers
 463    */
 464   public static function addressProvider() {
 465     static $addr = NULL;
 466     if (!$addr) {
 467       $addr = array_merge(['' => '- select -'], CRM_Utils_System::getPluginList('CRM/Utils/Address', '.php', ['BatchUpdate']));
 468     }
 469     return $addr;
 470   }
 471
 472   /**
 473    * Different type of Mailing Tokens.
 474    *
 475    * @return array
 476    */
 477   public static function mailingTokens() {
 478     return [
 479       '{action.unsubscribe}' => ts('Unsubscribe via email'),
 480       '{action.unsubscribeUrl}' => ts('Unsubscribe via web page'),
 481       '{action.resubscribe}' => ts('Resubscribe via email'),
 482       '{action.resubscribeUrl}' => ts('Resubscribe via web page'),
 483       '{action.optOut}' => ts('Opt out via email'),
 484       '{action.optOutUrl}' => ts('Opt out via web page'),
 485       '{action.forward}' => ts('Forward this email (link)'),
 486       '{action.reply}' => ts('Reply to this email (link)'),
 487       '{action.subscribeUrl}' => ts('Subscribe via web page'),
 488       '{mailing.key}' => ts('Mailing key'),
 489       '{mailing.name}' => ts('Mailing name'),
 490       '{mailing.group}' => ts('Mailing group'),
 491       '{mailing.viewUrl}' => ts('Mailing permalink'),
 492     ] + self::domainTokens();
 493   }
 494
 495   /**
 496    * Domain tokens
 497    *
 498    * @return array
 499    */
 500   public static function domainTokens() {
 501     return [
 502       '{domain.name}' => ts('Domain name'),
 503       '{domain.address}' => ts('Domain (organization) address'),
 504       '{domain.phone}' => ts('Domain (organization) phone'),
 505       '{domain.email}' => ts('Domain (organization) email'),
 506     ];
 507   }
 508
 509   /**
 510    * Different type of Activity Tokens.
 511    *
 512    * @return array
 513    */
 514   public static function activityTokens() {
 515     return [
 516       '{activity.activity_id}' => ts('Activity ID'),
 517       '{activity.subject}' => ts('Activity Subject'),
 518       '{activity.details}' => ts('Activity Details'),
 519       '{activity.activity_date_time}' => ts('Activity Date Time'),
 520     ];
 521   }
 522
 523   /**
 524    * Different type of Membership Tokens.
 525    *
 526    * @return array
 527    */
 528   public static function membershipTokens() {
 529     return [
 530       '{membership.id}' => ts('Membership ID'),
 531       '{membership.status}' => ts('Membership Status'),
 532       '{membership.type}' => ts('Membership Type'),
 533       '{membership.start_date}' => ts('Membership Start Date'),
 534       '{membership.join_date}' => ts('Membership Join Date'),
 535       '{membership.end_date}' => ts('Membership End Date'),
 536       '{membership.fee}' => ts('Membership Fee'),
 537     ];
 538   }
 539
 540   /**
 541    * Different type of Event Tokens.
 542    *
 543    * @return array
 544    */
 545   public static function eventTokens() {
 546     return [
 547       '{event.event_id}' => ts('Event ID'),
 548       '{event.title}' => ts('Event Title'),
 549       '{event.start_date}' => ts('Event Start Date'),
 550       '{event.end_date}' => ts('Event End Date'),
 551       '{event.event_type}' => ts('Event Type'),
 552       '{event.summary}' => ts('Event Summary'),
 553       '{event.contact_email}' => ts('Event Contact Email'),
 554       '{event.contact_phone}' => ts('Event Contact Phone'),
 555       '{event.description}' => ts('Event Description'),
 556       '{event.location}' => ts('Event Location'),
 557       '{event.fee_amount}' => ts('Event Fees'),
 558       '{event.info_url}' => ts('Event Info URL'),
 559       '{event.registration_url}' => ts('Event Registration URL'),
 560       '{event.balance}' => ts('Event Balance'),
 561     ];
 562   }
 563
 564   /**
 565    * Different type of Event Tokens.
 566    *
 567    * @return array
 568    */
 569   public static function contributionTokens() {
 570     return array_merge([
 571       '{contribution.contribution_id}' => ts('Contribution ID'),
 572       '{contribution.total_amount}' => ts('Total Amount'),
 573       '{contribution.fee_amount}' => ts('Fee Amount'),
 574       '{contribution.net_amount}' => ts('Net Amount'),
 575       '{contribution.non_deductible_amount}' => ts('Non-deductible Amount'),
 576       '{contribution.receive_date}' => ts('Contribution Date Received'),
 577       '{contribution.payment_instrument}' => ts('Payment Method'),
 578       '{contribution.trxn_id}' => ts('Transaction ID'),
 579       '{contribution.invoice_id}' => ts('Invoice ID'),
 580       '{contribution.currency}' => ts('Currency'),
 581       '{contribution.cancel_date}' => ts('Contribution Cancel Date'),
 582       '{contribution.cancel_reason}' => ts('Contribution Cancel Reason'),
 583       '{contribution.receipt_date}' => ts('Receipt Date'),
 584       '{contribution.thankyou_date}' => ts('Thank You Date'),
 585       '{contribution.contribution_source}' => ts('Contribution Source'),
 586       '{contribution.amount_level}' => ts('Amount Level'),
 587       //'{contribution.contribution_recur_id}' => ts('Contribution Recurring ID'),
 588       //'{contribution.honor_contact_id}' => ts('Honor Contact ID'),
 589       '{contribution.contribution_status_id}' => ts('Contribution Status'),
 590       //'{contribution.honor_type_id}' => ts('Honor Type ID'),
 591       //'{contribution.address_id}' => ts('Address ID'),
 592       '{contribution.check_number}' => ts('Check Number'),
 593       '{contribution.campaign}' => ts('Contribution Campaign'),
 594     ], CRM_Utils_Token::getCustomFieldTokens('contribution', TRUE));
 595   }
 596
 597   /**
 598    * Different type of Contact Tokens.
 599    *
 600    * @return array
 601    */
 602   public static function contactTokens() {
 603     static $tokens = NULL;
 604     if (!$tokens) {
 605       $additionalFields = [
 606         'checksum' => ['title' => ts('Checksum')],
 607         'contact_id' => ['title' => ts('Internal Contact ID')],
 608       ];
 609       $exportFields = array_merge(CRM_Contact_BAO_Contact::exportableFields(), $additionalFields);
 610
 611       $values = array_merge(array_keys($exportFields));
 612       unset($values[0]);
 613
 614       //FIXME:skipping some tokens for time being.
 615       $skipTokens = [
 616         'is_bulkmail',
 617         'group',
 618         'tag',
 619         'contact_sub_type',
 620         'note',
 621         'is_deceased',
 622         'deceased_date',
 623         'legal_identifier',
 624         'contact_sub_type',
 625         'user_unique_id',
 626       ];
 627
 628       $customFields = CRM_Core_BAO_CustomField::getFields(['Individual', 'Address']);
 629       $legacyTokenNames = array_flip(CRM_Utils_Token::legacyContactTokens());
 630
 631       foreach ($values as $val) {
 632         if (in_array($val, $skipTokens)) {
 633           continue;
 634         }
 635         //keys for $tokens should be constant. $token Values are changed for Custom Fields. CRM-3734
 636         $customFieldId = CRM_Core_BAO_CustomField::getKeyID($val);
 637         if ($customFieldId) {
 638           // CRM-15191 - if key is not in $customFields then the field is disabled and should be ignored
 639           if (!empty($customFields[$customFieldId])) {
 640             $tokens["{contact.$val}"] = $customFields[$customFieldId]['label'] . " :: " . $customFields[$customFieldId]['groupTitle'];
 641           }
 642         }
 643         else {
 644           // Support legacy token names
 645           $tokenName = CRM_Utils_Array::value($val, $legacyTokenNames, $val);
 646           $tokens["{contact.$tokenName}"] = $exportFields[$val]['title'];
 647         }
 648       }
 649
 650       // Get all the hook tokens too
 651       $hookTokens = [];
 652       CRM_Utils_Hook::tokens($hookTokens);
 653       foreach ($hookTokens as $tokenValues) {
 654         foreach ($tokenValues as $key => $value) {
 655           if (is_numeric($key)) {
 656             $key = $value;
 657           }
 658           if (!preg_match('/^\{[^\}]+\}$/', $key)) {
 659             $key = '{' . $key . '}';
 660           }
 661           if (preg_match('/^\{([^\}]+)\}$/', $value, $matches)) {
 662             $value = $matches[1];
 663           }
 664           $tokens[$key] = $value;
 665         }
 666       }
 667     }
 668
 669     return $tokens;
 670   }
 671
 672   /**
 673    * Different type of Participant Tokens.
 674    *
 675    * @return array
 676    */
 677   public static function participantTokens() {
 678     static $tokens = NULL;
 679     if (!$tokens) {
 680       $exportFields = CRM_Event_BAO_Participant::exportableFields();
 681
 682       $values = array_merge(array_keys($exportFields));
 683       unset($values[0]);
 684
 685       // skipping some tokens for time being.
 686       $skipTokens = [
 687         'event_id',
 688         'participant_is_pay_later',
 689         'participant_is_test',
 690         'participant_contact_id',
 691         'participant_fee_currency',
 692         'participant_campaign_id',
 693         'participant_status',
 694         'participant_discount_name',
 695       ];
 696
 697       $customFields = CRM_Core_BAO_CustomField::getFields('Participant');
 698
 699       foreach ($values as $key => $val) {
 700         if (in_array($val, $skipTokens)) {
 701           continue;
 702         }
 703         //keys for $tokens should be constant. $token Values are changed for Custom Fields. CRM-3734
 704         if ($customFieldId = CRM_Core_BAO_CustomField::getKeyID($val)) {
 705           $tokens["{participant.$val}"] = !empty($customFields[$customFieldId]) ? $customFields[$customFieldId]['label'] . " :: " . $customFields[$customFieldId]['groupTitle'] : '';
 706         }
 707         else {
 708           $tokens["{participant.$val}"] = $exportFields[$val]['title'];
 709         }
 710       }
 711     }
 712     return $tokens;
 713   }
 714
 715   /**
 716    * @param int $caseTypeId
 717    * @return array
 718    */
 719   public static function caseTokens($caseTypeId = NULL) {
 720     static $tokens = NULL;
 721     if (!$tokens) {
 722       foreach (CRM_Case_BAO_Case::fields() as $field) {
 723         $tokens["{case.{$field['name']}}"] = $field['title'];
 724       }
 725
 726       $customFields = CRM_Core_BAO_CustomField::getFields('Case', FALSE, FALSE, $caseTypeId);
 727       foreach ($customFields as $id => $field) {
 728         $tokens["{case.custom_$id}"] = "{$field['label']} :: {$field['groupTitle']}";
 729       }
 730     }
 731     return $tokens;
 732   }
 733
 734   /**
 735    * CiviCRM supported date input formats.
 736    *
 737    * @return array
 738    */
 739   public static function getDatePluginInputFormats() {
 740     return [
 741       'mm/dd/yy' => ts('mm/dd/yy (12/31/2009)'),
 742       'dd/mm/yy' => ts('dd/mm/yy (31/12/2009)'),
 743       'yy-mm-dd' => ts('yy-mm-dd (2009-12-31)'),
 744       'dd-mm-yy' => ts('dd-mm-yy (31-12-2009)'),
 745       'dd.mm.yy' => ts('dd.mm.yy (31.12.2009)'),
 746       'M d, yy' => ts('M d, yy (Dec 31, 2009)'),
 747       'd M yy' => ts('d M yy (31 Dec 2009)'),
 748       'MM d, yy' => ts('MM d, yy (December 31, 2009)'),
 749       'd MM yy' => ts('d MM yy (31 December 2009)'),
 750       'DD, d MM yy' => ts('DD, d MM yy (Thursday, 31 December 2009)'),
 751       'mm/dd' => ts('mm/dd (12/31)'),
 752       'dd-mm' => ts('dd-mm (31-12)'),
 753       'yy-mm' => ts('yy-mm (2009-12)'),
 754       'M yy' => ts('M yy (Dec 2009)'),
 755       'yy' => ts('yy (2009)'),
 756     ];
 757   }
 758
 759   /**
 760    * Time formats.
 761    *
 762    * @return array
 763    */
 764   public static function getTimeFormats() {
 765     return [
 766       '1' => ts('12 Hours'),
 767       '2' => ts('24 Hours'),
 768     ];
 769   }
 770
 771   /**
 772    * Get numeric options.
 773    *
 774    * @param int $start
 775    * @param int $end
 776    *
 777    * @return array
 778    */
 779   public static function getNumericOptions($start = 0, $end = 10) {
 780     $numericOptions = [];
 781     for ($i = $start; $i <= $end; $i++) {
 782       $numericOptions[$i] = $i;
 783     }
 784     return $numericOptions;
 785   }
 786
 787   /**
 788    * Barcode types.
 789    *
 790    * @return array
 791    */
 792   public static function getBarcodeTypes() {
 793     return [
 794       'barcode' => ts('Linear (1D)'),
 795       'qrcode' => ts('QR code'),
 796     ];
 797   }
 798
 799   /**
 800    * Dedupe rule types.
 801    *
 802    * @return array
 803    */
 804   public static function getDedupeRuleTypes() {
 805     return [
 806       'Unsupervised' => ts('Unsupervised'),
 807       'Supervised' => ts('Supervised'),
 808       'General' => ts('General'),
 809     ];
 810   }
 811
 812   /**
 813    * Campaign group types.
 814    *
 815    * @return array
 816    */
 817   public static function getCampaignGroupTypes() {
 818     return [
 819       'Include' => ts('Include'),
 820       'Exclude' => ts('Exclude'),
 821     ];
 822   }
 823
 824   /**
 825    * Subscription history method.
 826    *
 827    * @return array
 828    */
 829   public static function getSubscriptionHistoryMethods() {
 830     return [
 831       'Admin' => ts('Admin'),
 832       'Email' => ts('Email'),
 833       'Web' => ts('Web'),
 834       'API' => ts('API'),
 835     ];
 836   }
 837
 838   /**
 839    * Premium units.
 840    *
 841    * @return array
 842    */
 843   public static function getPremiumUnits() {
 844     return [
 845       'day' => ts('Day'),
 846       'week' => ts('Week'),
 847       'month' => ts('Month'),
 848       'year' => ts('Year'),
 849     ];
 850   }
 851
 852   /**
 853    * Extension types.
 854    *
 855    * @return array
 856    */
 857   public static function getExtensionTypes() {
 858     return [
 859       'payment' => ts('Payment'),
 860       'search' => ts('Search'),
 861       'report' => ts('Report'),
 862       'module' => ts('Module'),
 863       'sms' => ts('SMS'),
 864     ];
 865   }
 866
 867   /**
 868    * Job frequency.
 869    *
 870    * @return array
 871    */
 872   public static function getJobFrequency() {
 873     return [
 874       // CRM-17669
 875       'Yearly' => ts('Yearly'),
 876       'Quarter' => ts('Quarterly'),
 877       'Monthly' => ts('Monthly'),
 878       'Weekly' => ts('Weekly'),
 879
 880       'Daily' => ts('Daily'),
 881       'Hourly' => ts('Hourly'),
 882       'Always' => ts('Every time cron job is run'),
 883     ];
 884   }
 885
 886   /**
 887    * Search builder operators.
 888    *
 889    * @return array
 890    */
 891   public static function getSearchBuilderOperators() {
 892     return [
 893       '=' => '=',
 894       '!=' => '≠',
 895       '>' => '>',
 896       '<' => '<',
 897       '>=' => '≥',
 898       '<=' => '≤',
 899       'IN' => ts('In'),
 900       'NOT IN' => ts('Not In'),
 901       'LIKE' => ts('Like'),
 902       'NOT LIKE' => ts('Not Like'),
 903       'RLIKE' => ts('Regex'),
 904       'IS EMPTY' => ts('Is Empty'),
 905       'IS NOT EMPTY' => ts('Not Empty'),
 906       'IS NULL' => ts('Is Null'),
 907       'IS NOT NULL' => ts('Not Null'),
 908     ];
 909   }
 910
 911   /**
 912    * Profile group types.
 913    *
 914    * @return array
 915    */
 916   public static function getProfileGroupType() {
 917     $profileGroupType = [
 918       'Activity' => ts('Activities'),
 919       'Contribution' => ts('Contributions'),
 920       'Membership' => ts('Memberships'),
 921       'Participant' => ts('Participants'),
 922     ];
 923     $contactTypes = self::contactType();
 924     $contactTypes = !empty($contactTypes) ? ['Contact' => 'Contacts'] + $contactTypes : [];
 925     $profileGroupType = array_merge($contactTypes, $profileGroupType);
 926
 927     return $profileGroupType;
 928   }
 929
 930   /**
 931    * Word replacement match type.
 932    *
 933    * @return array
 934    */
 935   public static function getWordReplacementMatchType() {
 936     return [
 937       'exactMatch' => ts('Exact Match'),
 938       'wildcardMatch' => ts('Wildcard Match'),
 939     ];
 940   }
 941
 942   /**
 943    * Mailing group types.
 944    *
 945    * @return array
 946    */
 947   public static function getMailingGroupTypes() {
 948     return [
 949       'Include' => ts('Include'),
 950       'Exclude' => ts('Exclude'),
 951       'Base' => ts('Base'),
 952     ];
 953   }
 954
 955   /**
 956    * Mailing Job Status.
 957    *
 958    * @return array
 959    */
 960   public static function getMailingJobStatus() {
 961     return [
 962       'Scheduled' => ts('Scheduled'),
 963       'Running' => ts('Running'),
 964       'Complete' => ts('Complete'),
 965       'Paused' => ts('Paused'),
 966       'Canceled' => ts('Canceled'),
 967     ];
 968   }
 969
 970   /**
 971    * @return array
 972    */
 973   public static function billingMode() {
 974     return [
 975       CRM_Core_Payment::BILLING_MODE_FORM => 'form',
 976       CRM_Core_Payment::BILLING_MODE_BUTTON => 'button',
 977       CRM_Core_Payment::BILLING_MODE_NOTIFY => 'notify',
 978     ];
 979   }
 980
 981   /**
 982    * @return array
 983    */
 984   public static function contributeMode() {
 985     return [
 986       CRM_Core_Payment::BILLING_MODE_FORM => 'direct',
 987       CRM_Core_Payment::BILLING_MODE_BUTTON => 'directIPN',
 988       CRM_Core_Payment::BILLING_MODE_NOTIFY => 'notify',
 989     ];
 990   }
 991
 992   /**
 993    * Frequency unit for schedule reminders.
 994    *
 995    * @param int $count
 996    *   For pluralization
 997    * @return array
 998    */
 999   public static function getRecurringFrequencyUnits($count = 1) {
1000     // @todo this used to refer to the 'recur_frequency_unit' option_values which
1001     // is for recurring payments and probably not good to re-use for recurring entities.
1002     // If something other than a hard-coded list is desired, add a new option_group.
1003     return [
1004       'hour' => ts('hour', ['plural' => 'hours', 'count' => $count]),
1005       'day' => ts('day', ['plural' => 'days', 'count' => $count]),
1006       'week' => ts('week', ['plural' => 'weeks', 'count' => $count]),
1007       'month' => ts('month', ['plural' => 'months', 'count' => $count]),
1008       'year' => ts('year', ['plural' => 'years', 'count' => $count]),
1009     ];
1010   }
1011
1012   /**
1013    * Relative Date Terms.
1014    *
1015    * @return array
1016    */
1017   public static function getRelativeDateTerms() {
1018     return [
1019       'previous' => ts('Previous'),
1020       'previous_2' => ts('Previous 2'),
1021       'previous_before' => ts('Prior to Previous'),
1022       'before_previous' => ts('All Prior to Previous'),
1023       'earlier' => ts('To End of Previous'),
1024       'greater_previous' => ts('From End of Previous'),
1025       'greater' => ts('From Start Of Current'),
1026       'current' => ts('Current'),
1027       'ending_3' => ts('Last 3'),
1028       'ending_2' => ts('Last 2'),
1029       'ending' => ts('Last'),
1030       'this' => ts('This'),
1031       'starting' => ts('Upcoming'),
1032       'less' => ts('To End of'),
1033       'next' => ts('Next'),
1034     ];
1035   }
1036
1037   /**
1038    * Relative Date Units.
1039    *
1040    * @return array
1041    */
1042   public static function getRelativeDateUnits() {
1043     return [
1044       'year' => ts('Years'),
1045       'fiscal_year' => ts('Fiscal Years'),
1046       'quarter' => ts('Quarters'),
1047       'month' => ts('Months'),
1048       'week' => ts('Weeks'),
1049       'day' => ts('Days'),
1050     ];
1051   }
1052
1053   /**
1054    * Exportable document formats.
1055    *
1056    * @return array
1057    */
1058   public static function documentFormat() {
1059     return [
1060       'pdf' => ts('Portable Document Format (.pdf)'),
1061       'docx' => ts('MS Word (.docx)'),
1062       'odt' => ts('Open Office (.odt)'),
1063       'html' => ts('Webpage (.html)'),
1064     ];
1065   }
1066
1067   /**
1068    * Application type of document.
1069    *
1070    * @return array
1071    */
1072   public static function documentApplicationType() {
1073     return [
1074       'docx' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
1075       'odt' => 'application/vnd.oasis.opendocument.text',
1076     ];
1077   }
1078
1079   /**
1080    * Activity Text options.
1081    *
1082    * @return array
1083    */
1084   public static function activityTextOptions() {
1085     return [
1086       2 => ts('Details Only'),
1087       3 => ts('Subject Only'),
1088       6 => ts('Both'),
1089     ];
1090   }
1091
1092   /**
1093    * Relationship permissions
1094    *
1095    * @return array
1096    */
1097   public static function getPermissionedRelationshipOptions() {
1098     return [
1099       CRM_Contact_BAO_Relationship::NONE => ts('None'),
1100       CRM_Contact_BAO_Relationship::VIEW => ts('View only'),
1101       CRM_Contact_BAO_Relationship::EDIT => ts('View and update'),
1102     ];
1103   }
1104
1105   /**
1106    * Get option values for dashboard entries (used for 'how many events to display on dashboard').
1107    *
1108    * @return array
1109    *   Dashboard entries options - in practice [-1 => 'Show All', 10 => 10, 20 => 20, ... 100 => 100].
1110    */
1111   public static function getDashboardEntriesCount() {
1112     $optionValues = [];
1113     $optionValues[-1] = ts('show all');
1114     for ($i = 10; $i <= 100; $i += 10) {
1115       $optionValues[$i] = $i;
1116     }
1117     return $optionValues;
1118   }
1119
1120   /**
1121    * Dropdown options for quicksearch in the menu
1122    *
1123    * @return array
1124    * @throws \CiviCRM_API3_Exception
1125    */
1126   public static function quicksearchOptions() {
1127     $includeEmail = civicrm_api3('setting', 'getvalue', ['name' => 'includeEmailInName', 'group' => 'Search Preferences']);
1128     $options = [
1129       'sort_name' => $includeEmail ? ts('Name/Email') : ts('Name'),
1130       'contact_id' => ts('Contact ID'),
1131       'external_identifier' => ts('External ID'),
1132       'first_name' => ts('First Name'),
1133       'last_name' => ts('Last Name'),
1134       'email' => ts('Email'),
1135       'phone_numeric' => ts('Phone'),
1136       'street_address' => ts('Street Address'),
1137       'city' => ts('City'),
1138       'postal_code' => ts('Postal Code'),
1139       'job_title' => ts('Job Title'),
1140     ];
1141     $custom = civicrm_api3('CustomField', 'get', [
1142       'return' => ['name', 'label', 'custom_group_id.title'],
1143       'custom_group_id.extends' => ['IN' => ['Contact', 'Individual', 'Organization', 'Household']],
1144       'data_type' => ['NOT IN' => ['ContactReference', 'Date', 'File']],
1145       'custom_group_id.is_active' => 1,
1146       'is_active' => 1,
1147       'is_searchable' => 1,
1148       'options' => ['sort' => ['custom_group_id.weight', 'weight'], 'limit' => 0],
1149     ]);
1150     foreach ($custom['values'] as $field) {
1151       $options['custom_' . $field['name']] = $field['custom_group_id.title'] . ': ' . $field['label'];
1152     }
1153     return $options;
1154   }
1155
1156   /**
1157    * Get components (translated for display.
1158    *
1159    * @return array
1160    *
1161    * @throws \Exception
1162    */
1163   public static function getComponentSelectValues() {
1164     $ret = [];
1165     $components = CRM_Core_Component::getComponents();
1166     foreach ($components as $name => $object) {
1167       $ret[$name] = $object->info['translatedName'];
1168     }
1169
1170     return $ret;
1171   }
1172
1173   /**
1174    * @return string[]
1175    */
1176   public static function fieldSerialization() {
1177     return [
1178       CRM_Core_DAO::SERIALIZE_SEPARATOR_BOOKEND => 'separator_bookend',
1179       CRM_Core_DAO::SERIALIZE_SEPARATOR_TRIMMED => 'separator_trimmed',
1180       CRM_Core_DAO::SERIALIZE_JSON => 'json',
1181       CRM_Core_DAO::SERIALIZE_PHP => 'php',
1182       CRM_Core_DAO::SERIALIZE_COMMA => 'comma',
1183     ];
1184   }
1185
1186   /**
1187    * @return array
1188    */
1189   public static function navigationMenuSeparator() {
1190     return [
1191       ts('None'),
1192       ts('After menu element'),
1193       ts('Before menu element'),
1194     ];
1195   }
1196
1197   /**
1198    * @return array
1199    */
1200   public static function relationshipOrientation() {
1201     return [
1202       'a_b' => ts('A to B'),
1203       'b_a' => ts('B to A'),
1204     ];
1205   }
1206
1207 }