CRM/Core/SelectValues.php

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