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 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() {
 566     return array_merge([
 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'),
 586       //'{contribution.honor_type_id}' => ts('Honor Type ID'),
 587       //'{contribution.address_id}' => ts('Address ID'),
 588       '{contribution.check_number}' => ts('Check Number'),
 589       '{contribution.campaign}' => ts('Contribution Campaign'),
 590     ], CRM_Utils_Token::getCustomFieldTokens('contribution', TRUE));
 591   }
 592
 593   /**
 594    * Different type of Contact Tokens.
 595    *
 596    * @return array
 597    */
 598   public static function contactTokens() {
 599     static $tokens = NULL;
 600     if (!$tokens) {
 601       $additionalFields = [
 602         'checksum' => ['title' => ts('Checksum')],
 603         'contact_id' => ['title' => ts('Internal Contact ID')],
 604       ];
 605       $exportFields = array_merge(CRM_Contact_BAO_Contact::exportableFields(), $additionalFields);
 606
 607       $values = array_merge(array_keys($exportFields));
 608       unset($values[0]);
 609
 610       //FIXME:skipping some tokens for time being.
 611       $skipTokens = [
 612         'is_bulkmail',
 613         'group',
 614         'tag',
 615         'contact_sub_type',
 616         'note',
 617         'is_deceased',
 618         'deceased_date',
 619         'legal_identifier',
 620         'contact_sub_type',
 621         'user_unique_id',
 622       ];
 623
 624       $customFields = CRM_Core_BAO_CustomField::getFields(['Individual', 'Address']);
 625       $legacyTokenNames = array_flip(CRM_Utils_Token::legacyContactTokens());
 626
 627       foreach ($values as $val) {
 628         if (in_array($val, $skipTokens)) {
 629           continue;
 630         }
 631         //keys for $tokens should be constant. $token Values are changed for Custom Fields. CRM-3734
 632         $customFieldId = CRM_Core_BAO_CustomField::getKeyID($val);
 633         if ($customFieldId) {
 634           // CRM-15191 - if key is not in $customFields then the field is disabled and should be ignored
 635           if (!empty($customFields[$customFieldId])) {
 636             $tokens["{contact.$val}"] = $customFields[$customFieldId]['label'] . " :: " . $customFields[$customFieldId]['groupTitle'];
 637           }
 638         }
 639         else {
 640           // Support legacy token names
 641           $tokenName = CRM_Utils_Array::value($val, $legacyTokenNames, $val);
 642           $tokens["{contact.$tokenName}"] = $exportFields[$val]['title'];
 643         }
 644       }
 645
 646       // Get all the hook tokens too
 647       $hookTokens = [];
 648       CRM_Utils_Hook::tokens($hookTokens);
 649       foreach ($hookTokens as $tokenValues) {
 650         foreach ($tokenValues as $key => $value) {
 651           if (is_numeric($key)) {
 652             $key = $value;
 653           }
 654           if (!preg_match('/^\{[^\}]+\}$/', $key)) {
 655             $key = '{' . $key . '}';
 656           }
 657           if (preg_match('/^\{([^\}]+)\}$/', $value, $matches)) {
 658             $value = $matches[1];
 659           }
 660           $tokens[$key] = $value;
 661         }
 662       }
 663     }
 664
 665     return $tokens;
 666   }
 667
 668   /**
 669    * Different type of Participant Tokens.
 670    *
 671    * @return array
 672    */
 673   public static function participantTokens() {
 674     static $tokens = NULL;
 675     if (!$tokens) {
 676       $exportFields = CRM_Event_BAO_Participant::exportableFields();
 677
 678       $values = array_merge(array_keys($exportFields));
 679       unset($values[0]);
 680
 681       // skipping some tokens for time being.
 682       $skipTokens = [
 683         'event_id',
 684         'participant_is_pay_later',
 685         'participant_is_test',
 686         'participant_contact_id',
 687         'participant_fee_currency',
 688         'participant_campaign_id',
 689         'participant_status',
 690         'participant_discount_name',
 691       ];
 692
 693       $customFields = CRM_Core_BAO_CustomField::getFields('Participant');
 694
 695       foreach ($values as $key => $val) {
 696         if (in_array($val, $skipTokens)) {
 697           continue;
 698         }
 699         //keys for $tokens should be constant. $token Values are changed for Custom Fields. CRM-3734
 700         if ($customFieldId = CRM_Core_BAO_CustomField::getKeyID($val)) {
 701           $tokens["{participant.$val}"] = !empty($customFields[$customFieldId]) ? $customFields[$customFieldId]['label'] . " :: " . $customFields[$customFieldId]['groupTitle'] : '';
 702         }
 703         else {
 704           $tokens["{participant.$val}"] = $exportFields[$val]['title'];
 705         }
 706       }
 707     }
 708     return $tokens;
 709   }
 710
 711   /**
 712    * @param int $caseTypeId
 713    * @return array
 714    */
 715   public static function caseTokens($caseTypeId = NULL) {
 716     static $tokens = NULL;
 717     if (!$tokens) {
 718       foreach (CRM_Case_BAO_Case::fields() as $field) {
 719         $tokens["{case.{$field['name']}}"] = $field['title'];
 720       }
 721
 722       $customFields = CRM_Core_BAO_CustomField::getFields('Case', FALSE, FALSE, $caseTypeId);
 723       foreach ($customFields as $id => $field) {
 724         $tokens["{case.custom_$id}"] = "{$field['label']} :: {$field['groupTitle']}";
 725       }
 726     }
 727     return $tokens;
 728   }
 729
 730   /**
 731    * CiviCRM supported date input formats.
 732    *
 733    * @return array
 734    */
 735   public static function getDatePluginInputFormats() {
 736     return [
 737       'mm/dd/yy' => ts('mm/dd/yy (12/31/2009)'),
 738       'dd/mm/yy' => ts('dd/mm/yy (31/12/2009)'),
 739       'yy-mm-dd' => ts('yy-mm-dd (2009-12-31)'),
 740       'dd-mm-yy' => ts('dd-mm-yy (31-12-2009)'),
 741       'dd.mm.yy' => ts('dd.mm.yy (31.12.2009)'),
 742       'M d, yy' => ts('M d, yy (Dec 31, 2009)'),
 743       'd M yy' => ts('d M yy (31 Dec 2009)'),
 744       'MM d, yy' => ts('MM d, yy (December 31, 2009)'),
 745       'd MM yy' => ts('d MM yy (31 December 2009)'),
 746       'DD, d MM yy' => ts('DD, d MM yy (Thursday, 31 December 2009)'),
 747       'mm/dd' => ts('mm/dd (12/31)'),
 748       'dd-mm' => ts('dd-mm (31-12)'),
 749       'yy-mm' => ts('yy-mm (2009-12)'),
 750       'M yy' => ts('M yy (Dec 2009)'),
 751       'yy' => ts('yy (2009)'),
 752     ];
 753   }
 754
 755   /**
 756    * Time formats.
 757    *
 758    * @return array
 759    */
 760   public static function getTimeFormats() {
 761     return [
 762       '1' => ts('12 Hours'),
 763       '2' => ts('24 Hours'),
 764     ];
 765   }
 766
 767   /**
 768    * Get numeric options.
 769    *
 770    * @param int $start
 771    * @param int $end
 772    *
 773    * @return array
 774    */
 775   public static function getNumericOptions($start = 0, $end = 10) {
 776     $numericOptions = [];
 777     for ($i = $start; $i <= $end; $i++) {
 778       $numericOptions[$i] = $i;
 779     }
 780     return $numericOptions;
 781   }
 782
 783   /**
 784    * Barcode types.
 785    *
 786    * @return array
 787    */
 788   public static function getBarcodeTypes() {
 789     return [
 790       'barcode' => ts('Linear (1D)'),
 791       'qrcode' => ts('QR code'),
 792     ];
 793   }
 794
 795   /**
 796    * Dedupe rule types.
 797    *
 798    * @return array
 799    */
 800   public static function getDedupeRuleTypes() {
 801     return [
 802       'Unsupervised' => ts('Unsupervised'),
 803       'Supervised' => ts('Supervised'),
 804       'General' => ts('General'),
 805     ];
 806   }
 807
 808   /**
 809    * Campaign group types.
 810    *
 811    * @return array
 812    */
 813   public static function getCampaignGroupTypes() {
 814     return [
 815       'Include' => ts('Include'),
 816       'Exclude' => ts('Exclude'),
 817     ];
 818   }
 819
 820   /**
 821    * Subscription history method.
 822    *
 823    * @return array
 824    */
 825   public static function getSubscriptionHistoryMethods() {
 826     return [
 827       'Admin' => ts('Admin'),
 828       'Email' => ts('Email'),
 829       'Web' => ts('Web'),
 830       'API' => ts('API'),
 831     ];
 832   }
 833
 834   /**
 835    * Premium units.
 836    *
 837    * @return array
 838    */
 839   public static function getPremiumUnits() {
 840     return [
 841       'day' => ts('Day'),
 842       'week' => ts('Week'),
 843       'month' => ts('Month'),
 844       'year' => ts('Year'),
 845     ];
 846   }
 847
 848   /**
 849    * Extension types.
 850    *
 851    * @return array
 852    */
 853   public static function getExtensionTypes() {
 854     return [
 855       'payment' => ts('Payment'),
 856       'search' => ts('Search'),
 857       'report' => ts('Report'),
 858       'module' => ts('Module'),
 859       'sms' => ts('SMS'),
 860     ];
 861   }
 862
 863   /**
 864    * Job frequency.
 865    *
 866    * @return array
 867    */
 868   public static function getJobFrequency() {
 869     return [
 870       // CRM-17669
 871       'Yearly' => ts('Yearly'),
 872       'Quarter' => ts('Quarterly'),
 873       'Monthly' => ts('Monthly'),
 874       'Weekly' => ts('Weekly'),
 875
 876       'Daily' => ts('Daily'),
 877       'Hourly' => ts('Hourly'),
 878       'Always' => ts('Every time cron job is run'),
 879     ];
 880   }
 881
 882   /**
 883    * Search builder operators.
 884    *
 885    * @return array
 886    */
 887   public static function getSearchBuilderOperators() {
 888     return [
 889       '=' => '=',
 890       '!=' => '≠',
 891       '>' => '>',
 892       '<' => '<',
 893       '>=' => '≥',
 894       '<=' => '≤',
 895       'IN' => ts('In'),
 896       'NOT IN' => ts('Not In'),
 897       'LIKE' => ts('Like'),
 898       'NOT LIKE' => ts('Not Like'),
 899       'RLIKE' => ts('Regex'),
 900       'IS EMPTY' => ts('Is Empty'),
 901       'IS NOT EMPTY' => ts('Not Empty'),
 902       'IS NULL' => ts('Is Null'),
 903       'IS NOT NULL' => ts('Not Null'),
 904     ];
 905   }
 906
 907   /**
 908    * Profile group types.
 909    *
 910    * @return array
 911    */
 912   public static function getProfileGroupType() {
 913     $profileGroupType = [
 914       'Activity' => ts('Activities'),
 915       'Contribution' => ts('Contributions'),
 916       'Membership' => ts('Memberships'),
 917       'Participant' => ts('Participants'),
 918     ];
 919     $contactTypes = self::contactType();
 920     $contactTypes = !empty($contactTypes) ? ['Contact' => 'Contacts'] + $contactTypes : [];
 921     $profileGroupType = array_merge($contactTypes, $profileGroupType);
 922
 923     return $profileGroupType;
 924   }
 925
 926   /**
 927    * Word replacement match type.
 928    *
 929    * @return array
 930    */
 931   public static function getWordReplacementMatchType() {
 932     return [
 933       'exactMatch' => ts('Exact Match'),
 934       'wildcardMatch' => ts('Wildcard Match'),
 935     ];
 936   }
 937
 938   /**
 939    * Mailing group types.
 940    *
 941    * @return array
 942    */
 943   public static function getMailingGroupTypes() {
 944     return [
 945       'Include' => ts('Include'),
 946       'Exclude' => ts('Exclude'),
 947       'Base' => ts('Base'),
 948     ];
 949   }
 950
 951   /**
 952    * Mailing Job Status.
 953    *
 954    * @return array
 955    */
 956   public static function getMailingJobStatus() {
 957     return [
 958       'Scheduled' => ts('Scheduled'),
 959       'Running' => ts('Running'),
 960       'Complete' => ts('Complete'),
 961       'Paused' => ts('Paused'),
 962       'Canceled' => ts('Canceled'),
 963     ];
 964   }
 965
 966   /**
 967    * @return array
 968    */
 969   public static function billingMode() {
 970     return [
 971       CRM_Core_Payment::BILLING_MODE_FORM => 'form',
 972       CRM_Core_Payment::BILLING_MODE_BUTTON => 'button',
 973       CRM_Core_Payment::BILLING_MODE_NOTIFY => 'notify',
 974     ];
 975   }
 976
 977   /**
 978    * @return array
 979    */
 980   public static function contributeMode() {
 981     return [
 982       CRM_Core_Payment::BILLING_MODE_FORM => 'direct',
 983       CRM_Core_Payment::BILLING_MODE_BUTTON => 'directIPN',
 984       CRM_Core_Payment::BILLING_MODE_NOTIFY => 'notify',
 985     ];
 986   }
 987
 988   /**
 989    * Frequency unit for schedule reminders.
 990    *
 991    * @param int $count
 992    *   For pluralization
 993    * @return array
 994    */
 995   public static function getRecurringFrequencyUnits($count = 1) {
 996     // @todo this used to refer to the 'recur_frequency_unit' option_values which
 997     // is for recurring payments and probably not good to re-use for recurring entities.
 998     // If something other than a hard-coded list is desired, add a new option_group.
 999     return [
1000       'hour' => ts('hour', ['plural' => 'hours', 'count' => $count]),
1001       'day' => ts('day', ['plural' => 'days', 'count' => $count]),
1002       'week' => ts('week', ['plural' => 'weeks', 'count' => $count]),
1003       'month' => ts('month', ['plural' => 'months', 'count' => $count]),
1004       'year' => ts('year', ['plural' => 'years', 'count' => $count]),
1005     ];
1006   }
1007
1008   /**
1009    * Relative Date Terms.
1010    *
1011    * @return array
1012    */
1013   public static function getRelativeDateTerms() {
1014     return [
1015       'previous' => ts('Previous'),
1016       'previous_2' => ts('Previous 2'),
1017       'previous_before' => ts('Prior to Previous'),
1018       'before_previous' => ts('All Prior to Previous'),
1019       'earlier' => ts('To End of Previous'),
1020       'greater_previous' => ts('From End of Previous'),
1021       'greater' => ts('From Start Of Current'),
1022       'current' => ts('Current'),
1023       'ending_3' => ts('Last 3'),
1024       'ending_2' => ts('Last 2'),
1025       'ending' => ts('Last'),
1026       'this' => ts('This'),
1027       'starting' => ts('Upcoming'),
1028       'less' => ts('To End of'),
1029       'next' => ts('Next'),
1030     ];
1031   }
1032
1033   /**
1034    * Relative Date Units.
1035    *
1036    * @return array
1037    */
1038   public static function getRelativeDateUnits() {
1039     return [
1040       'year' => ts('Years'),
1041       'fiscal_year' => ts('Fiscal Years'),
1042       'quarter' => ts('Quarters'),
1043       'month' => ts('Months'),
1044       'week' => ts('Weeks'),
1045       'day' => ts('Days'),
1046     ];
1047   }
1048
1049   /**
1050    * Exportable document formats.
1051    *
1052    * @return array
1053    */
1054   public static function documentFormat() {
1055     return [
1056       'pdf' => ts('Portable Document Format (.pdf)'),
1057       'docx' => ts('MS Word (.docx)'),
1058       'odt' => ts('Open Office (.odt)'),
1059       'html' => ts('Webpage (.html)'),
1060     ];
1061   }
1062
1063   /**
1064    * Application type of document.
1065    *
1066    * @return array
1067    */
1068   public static function documentApplicationType() {
1069     return [
1070       'docx' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
1071       'odt' => 'application/vnd.oasis.opendocument.text',
1072     ];
1073   }
1074
1075   /**
1076    * Activity Text options.
1077    *
1078    * @return array
1079    */
1080   public static function activityTextOptions() {
1081     return [
1082       2 => ts('Details Only'),
1083       3 => ts('Subject Only'),
1084       6 => ts('Both'),
1085     ];
1086   }
1087
1088   /**
1089    * Relationship permissions
1090    *
1091    * @return array
1092    */
1093   public static function getPermissionedRelationshipOptions() {
1094     return [
1095       CRM_Contact_BAO_Relationship::NONE => ts('None'),
1096       CRM_Contact_BAO_Relationship::VIEW => ts('View only'),
1097       CRM_Contact_BAO_Relationship::EDIT => ts('View and update'),
1098     ];
1099   }
1100
1101   /**
1102    * Get option values for dashboard entries (used for 'how many events to display on dashboard').
1103    *
1104    * @return array
1105    *   Dashboard entries options - in practice [-1 => 'Show All', 10 => 10, 20 => 20, ... 100 => 100].
1106    */
1107   public static function getDashboardEntriesCount() {
1108     $optionValues = [];
1109     $optionValues[-1] = ts('show all');
1110     for ($i = 10; $i <= 100; $i += 10) {
1111       $optionValues[$i] = $i;
1112     }
1113     return $optionValues;
1114   }
1115
1116   /**
1117    * Dropdown options for quicksearch in the menu
1118    *
1119    * @return array
1120    * @throws \CiviCRM_API3_Exception
1121    */
1122   public static function quicksearchOptions() {
1123     $includeEmail = civicrm_api3('setting', 'getvalue', ['name' => 'includeEmailInName', 'group' => 'Search Preferences']);
1124     $options = [
1125       'sort_name' => $includeEmail ? ts('Name/Email') : ts('Name'),
1126       'contact_id' => ts('Contact ID'),
1127       'external_identifier' => ts('External ID'),
1128       'first_name' => ts('First Name'),
1129       'last_name' => ts('Last Name'),
1130       'email' => ts('Email'),
1131       'phone_numeric' => ts('Phone'),
1132       'street_address' => ts('Street Address'),
1133       'city' => ts('City'),
1134       'postal_code' => ts('Postal Code'),
1135       'job_title' => ts('Job Title'),
1136     ];
1137     $custom = civicrm_api3('CustomField', 'get', [
1138       'return' => ['name', 'label', 'custom_group_id.title'],
1139       'custom_group_id.extends' => ['IN' => ['Contact', 'Individual', 'Organization', 'Household']],
1140       'data_type' => ['NOT IN' => ['ContactReference', 'Date', 'File']],
1141       'custom_group_id.is_active' => 1,
1142       'is_active' => 1,
1143       'is_searchable' => 1,
1144       'options' => ['sort' => ['custom_group_id.weight', 'weight'], 'limit' => 0],
1145     ]);
1146     foreach ($custom['values'] as $field) {
1147       $options['custom_' . $field['name']] = $field['custom_group_id.title'] . ': ' . $field['label'];
1148     }
1149     return $options;
1150   }
1151
1152   /**
1153    * Get components (translated for display.
1154    *
1155    * @return array
1156    *
1157    * @throws \Exception
1158    */
1159   public static function getComponentSelectValues() {
1160     $ret = [];
1161     $components = CRM_Core_Component::getComponents();
1162     foreach ($components as $name => $object) {
1163       $ret[$name] = $object->info['translatedName'];
1164     }
1165
1166     return $ret;
1167   }
1168
1169   /**
1170    * @return string[]
1171    */
1172   public static function fieldSerialization() {
1173     return [
1174       CRM_Core_DAO::SERIALIZE_SEPARATOR_BOOKEND => 'separator_bookend',
1175       CRM_Core_DAO::SERIALIZE_SEPARATOR_TRIMMED => 'separator_trimmed',
1176       CRM_Core_DAO::SERIALIZE_JSON => 'json',
1177       CRM_Core_DAO::SERIALIZE_PHP => 'php',
1178       CRM_Core_DAO::SERIALIZE_COMMA => 'comma',
1179     ];
1180   }
1181
1182   /**
1183    * @return array
1184    */
1185   public static function navigationMenuSeparator() {
1186     return [
1187       ts('None'),
1188       ts('After menu element'),
1189       ts('Before menu element'),
1190     ];
1191   }
1192
1193   /**
1194    * @return array
1195    */
1196   public static function relationshipOrientation() {
1197     return [
1198       'a_b' => ts('A to B'),
1199       'b_a' => ts('B to A'),
1200     ];
1201   }
1202
1203 }