CRM/Core/Config/Variables.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   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  * Variables class contains definitions of all the core config settings that are allowed on
  30  * CRM_Core_Config. If you want a config variable to be present in run time config object,
  31  * it need to be defined here first.
  32  *
  33  * @package CRM
  34  * @copyright CiviCRM LLC (c) 2004-2015
  35  * $Id$
  36  *
  37  */
  38 class CRM_Core_Config_Variables extends CRM_Core_Config_Defaults {
  39
  40   /**
  41    * The debug level for civicrm.
  42    * @var int
  43    */
  44   public $debug = 0;
  45   public $backtrace = 0;
  46
  47   /**
  48    * The directory where Smarty and plugins are installed.
  49    * @var string
  50    */
  51   public $smartyDir = NULL;
  52   public $pluginsDir = NULL;
  53
  54   /**
  55    * The root directory of our template tree.
  56    * @var string
  57    */
  58   public $templateDir = NULL;
  59
  60   /**
  61    * The resourceBase of our application. Used when we want to compose
  62    * url's for things like js/images/css
  63    * @var string
  64    */
  65   public $resourceBase = NULL;
  66
  67   /**
  68    * The directory to store uploaded files
  69    */
  70   public $uploadDir = NULL;
  71
  72   /**
  73    * The directory to store uploaded image files
  74    */
  75   public $imageUploadDir = NULL;
  76
  77   /**
  78    * The directory to store uploaded  files in custom data
  79    */
  80   public $customFileUploadDir = NULL;
  81
  82   /**
  83    * The url that we can use to display the uploaded images
  84    */
  85   public $imageUploadURL = NULL;
  86
  87   /**
  88    * The local path to the default extension container
  89    */
  90   public $extensionsDir;
  91
  92   /**
  93    * The url for resources defined by extensions
  94    */
  95   public $extensionsURL = NULL;
  96
  97   /**
  98    * Are we generating clean url's and using mod_rewrite
  99    * @var string
 100    */
 101   public $cleanURL = FALSE;
 102
 103   /**
 104    * List of country codes limiting the country list.
 105    * 1228 is an id for United States.
 106    * @var string
 107    */
 108   public $countryLimit = array('1228');
 109
 110   /**
 111    * Id of default state/province for contact.
 112    * 1046 is an id for Washington(country:United States).
 113    * @var int
 114    */
 115   public $defaultContactStateProvince;
 116
 117   /**
 118    * List of country codes limiting the province list.
 119    * 1228 is an id for United States.
 120    * @var string
 121    */
 122   public $provinceLimit = array('1228');
 123
 124   /**
 125    * ISO code of default country for contact.
 126    * 1228 is an id for United States.
 127    * @var int
 128    */
 129   public $defaultContactCountry = '1228';
 130
 131   /**
 132    * ISO code of default currency.
 133    * @var int
 134    */
 135   public $defaultCurrency = 'USD';
 136
 137   /**
 138    * Locale for the application to run with.
 139    * @var string
 140    */
 141   public $lcMessages = 'en_US';
 142
 143   /**
 144    * String format for date+time
 145    * @var string
 146    */
 147   public $dateformatDatetime = '%B %E%f, %Y %l:%M %P';
 148
 149   /**
 150    * String format for a full date (one with day, month and year)
 151    * @var string
 152    */
 153   public $dateformatFull = '%B %E%f, %Y';
 154
 155   /**
 156    * String format for a partial date (one with month and year)
 157    * @var string
 158    */
 159   public $dateformatPartial = '%B %Y';
 160
 161   /**
 162    * String format for a year-only date
 163    * @var string
 164    */
 165   public $dateformatYear = '%Y';
 166
 167   /**
 168    * Display format for time
 169    * @var string
 170    */
 171   public $dateformatTime = '%l:%M %P';
 172
 173   /**
 174    * Input format for time
 175    * @var string
 176    */
 177   public $timeInputFormat = 1;
 178
 179   /**
 180    * Input format for date plugin
 181    * @var string
 182    */
 183   public $dateInputFormat = 'mm/dd/yy';
 184
 185   /**
 186    * Month and day on which fiscal year starts.
 187    *
 188    * @var array
 189    */
 190   public $fiscalYearStart = array(
 191     'M' => 01,
 192     'd' => 01,
 193   );
 194
 195   /**
 196    * String format for monetary amounts
 197    * @var string
 198    */
 199   public $moneyformat = '%c %a';
 200
 201   /**
 202    * String format for monetary values
 203    * @var string
 204    */
 205   public $moneyvalueformat = '%!i';
 206
 207   /**
 208    * Format for monetary amounts
 209    * @var string
 210    */
 211   public $currencySymbols = '';
 212
 213   /**
 214    * Format for monetary amounts
 215    * @var string
 216    */
 217   public $defaultCurrencySymbol = '$';
 218
 219   /**
 220    * Monetary decimal point character
 221    * @var string
 222    */
 223   public $monetaryDecimalPoint = '.';
 224
 225   /**
 226    * Monetary thousands separator
 227    * @var string
 228    */
 229   public $monetaryThousandSeparator = ',';
 230
 231   /**
 232    * Default location of gettext resource files.
 233    */
 234   public $gettextResourceDir = './l10n/';
 235
 236   /**
 237    * Default user framework. This basically makes Drupal 7 the default
 238    */
 239   public $userFramework = 'Drupal';
 240   public $userFrameworkVersion = 'Unknown';
 241   public $userFrameworkUsersTableName = 'users';
 242   public $userFrameworkClass = 'CRM_Utils_System_Drupal';
 243   public $userHookClass = 'CRM_Utils_Hook_Drupal';
 244
 245   /**
 246    * @var string|CRM_Core_Permission_Base
 247    */
 248   public $userPermissionClass = 'CRM_Core_Permission_Drupal';
 249
 250   /**
 251    * @var NULL|CRM_Core_Permission_Temp
 252    */
 253   public $userPermissionTemp = NULL;
 254
 255   public $userFrameworkURLVar = 'q';
 256   public $userFrameworkDSN = NULL;
 257   public $userFrameworkBaseURL = NULL;
 258   public $userFrameworkResourceURL = NULL;
 259   public $userFrameworkFrontend = FALSE;
 260   public $userFrameworkLogging = FALSE;
 261
 262   /**
 263    * The handle for import file size
 264    * @var int
 265    */
 266   public $maxImportFileSize = 1048576;
 267   public $maxFileSize = 2;
 268
 269   /**
 270    * The custom locale strings. Note that these locale strings are stored
 271    * in a separate column in civicrm_domain
 272    * @var array
 273    */
 274   public $localeCustomStrings = NULL;
 275
 276   /**
 277    * Map Provider
 278    *
 279    * @var string
 280    */
 281   public $mapProvider = NULL;
 282
 283   /**
 284    * Map API Key
 285    *
 286    * @var string
 287    */
 288   public $mapAPIKey = NULL;
 289
 290   /**
 291    * Geocoding Provider
 292    *
 293    * @var string
 294    */
 295   public $geoProvider = NULL;
 296
 297   /**
 298    * Geocoding API Key
 299    *
 300    * @var string
 301    */
 302   public $geoAPIKey = NULL;
 303
 304   /**
 305    * How should we get geo code information if google map support needed
 306    *
 307    * @var string
 308    */
 309   public $geocodeMethod = '';
 310
 311   /**
 312    *
 313    *
 314    * @var boolean
 315    */
 316   public $mapGeoCoding = 1;
 317
 318
 319   /**
 320    * Whether database-level logging should be performed
 321    * @var boolean
 322    */
 323   public $logging = FALSE;
 324
 325   /**
 326    * Whether public pages should display "empowered by CiviCRM"
 327    *
 328    * @var boolean
 329    */
 330   public $empoweredBy = TRUE;
 331
 332   /**
 333    * Array of enabled add-on components (e.g. CiviContribute, CiviMail...)
 334    *
 335    * @var array
 336    */
 337   public $enableComponents = array(
 338     'CiviContribute',
 339     'CiviPledge',
 340     'CiviMember',
 341     'CiviEvent',
 342     'CiviMail',
 343     'CiviReport',
 344   );
 345   public $enableComponentIDs = array(1, 6, 2, 3, 4, 8);
 346
 347   /**
 348    * Should payments be accepted only via SSL?
 349    *
 350    * @var boolean
 351    */
 352   public $enableSSL = FALSE;
 353
 354   /**
 355    * Fatal error handler
 356    *
 357    * @var string
 358    */
 359   public $fatalErrorHandler = NULL;
 360
 361   /**
 362    * Legacy encoding for file encoding conversion
 363    *
 364    * @var string
 365    */
 366   public $legacyEncoding = 'Windows-1252';
 367
 368   /**
 369    * Field separator for import/export csv file
 370    *
 371    * @var string
 372    */
 373   public $fieldSeparator = ',';
 374
 375   /**
 376    * Max location blocks in address
 377    *
 378    * @var integer
 379    */
 380   public $maxLocationBlocks = 2;
 381
 382   /**
 383    * The font path where captcha fonts are stored
 384    *
 385    * @var string
 386    */
 387   public $captchaFontPath = '/usr/X11R6/lib/X11/fonts/';
 388
 389   /**
 390    * The font to use for captcha
 391    *
 392    * @var string
 393    */
 394   public $captchaFont = 'HelveticaBold.ttf';
 395
 396   /**
 397    * Some search settings
 398    */
 399   public $includeWildCardInName = 1;
 400   public $includeEmailInName = 1;
 401   public $includeNickNameInName = 0;
 402
 403   public $smartGroupCacheTimeout = 5;
 404
 405   public $defaultSearchProfileID = NULL;
 406
 407   /**
 408    * Dashboard timeout
 409    */
 410   public $dashboardCacheTimeout = 1440;
 411
 412   /**
 413    * Flag to indicate if acl cache is NOT to be reset
 414    */
 415   public $doNotResetCache = 0;
 416
 417   /**
 418    * Optimization related variables
 419    */
 420   public $includeAlphabeticalPager = 1;
 421   public $includeOrderByClause = 1;
 422   public $oldInputStyle = 1;
 423
 424   /**
 425    * Should we disable key generation for forms
 426    *
 427    * @var boolean
 428    */
 429   public $formKeyDisable = FALSE;
 430
 431   /**
 432    * determine whether the call is from cms or civicrm
 433    */
 434   public $inCiviCRM = FALSE;
 435
 436   /**
 437    * Component registry object (of CRM_Core_Component type)
 438    */
 439   public $componentRegistry = NULL;
 440
 441   /**
 442    * PDF receipt as attachment is disabled by default (CRM-8350)
 443    */
 444   public $doNotAttachPDFReceipt = FALSE;
 445
 446   /**
 447    * Path to wkhtmltopdf if available
 448    */
 449   public $wkhtmltopdfPath = FALSE;
 450
 451   /**
 452    * Allow second-degree relations permission to edit contacts
 453    */
 454   public $secondDegRelPermissions = FALSE;
 455
 456
 457   /**
 458    * Allow second-degree relations permission to edit contacts
 459    */
 460   public $wpBasePage = NULL;
 461
 462   /**
 463    * Provide addressSequence.
 464    *
 465    * @param
 466    *
 467    * @return string
 468    */
 469   public function addressSequence() {
 470     $addressFormat = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
 471       'address_format'
 472     );
 473
 474     return CRM_Utils_Address::sequence($addressFormat);
 475   }
 476
 477   /**
 478    * Provide cached default currency symbol.
 479    *
 480    * @param
 481    *
 482    * @return string
 483    */
 484   public function defaultCurrencySymbol($defaultCurrency = NULL) {
 485     static $cachedSymbol = NULL;
 486     if (!$cachedSymbol || $defaultCurrency) {
 487       if ($this->defaultCurrency || $defaultCurrency) {
 488         $this->currencySymbols = CRM_Core_PseudoConstant::get('CRM_Contribute_DAO_Contribution', 'currency', array(
 489           'labelColumn' => 'symbol',
 490           'orderColumn' => TRUE,
 491         ));
 492         $currency = $defaultCurrency ? $defaultCurrency : $this->defaultCurrency;
 493         $cachedSymbol = CRM_Utils_Array::value($currency, $this->currencySymbols, '');
 494       }
 495       else {
 496         $cachedSymbol = '$';
 497       }
 498     }
 499     return $cachedSymbol;
 500   }
 501
 502   /**
 503    * Provide cached default currency symbol.
 504    *
 505    * @param
 506    *
 507    * @return string
 508    */
 509   public function defaultContactCountry() {
 510     static $cachedContactCountry = NULL;
 511
 512     if (!empty($this->defaultContactCountry) &&
 513       !$cachedContactCountry
 514     ) {
 515       $countryIsoCodes = CRM_Core_PseudoConstant::countryIsoCode();
 516       $cachedContactCountry = CRM_Utils_Array::value($this->defaultContactCountry,
 517         $countryIsoCodes
 518       );
 519     }
 520     return $cachedContactCountry;
 521   }
 522
 523   /**
 524    * Provide cached default country name.
 525    *
 526    * @param
 527    *
 528    * @return string
 529    */
 530   public function defaultContactCountryName() {
 531     static $cachedContactCountryName = NULL;
 532     if (!$cachedContactCountryName && $this->defaultContactCountry) {
 533       $countryCodes = CRM_Core_PseudoConstant::country();
 534       $cachedContactCountryName = $countryCodes[$this->defaultContactCountry];
 535     }
 536     return $cachedContactCountryName;
 537   }
 538
 539   /**
 540    * Provide cached country limit translated to names.
 541    *
 542    * @param
 543    *
 544    * @return array
 545    */
 546   public function countryLimit() {
 547     static $cachedCountryLimit = NULL;
 548     if (!$cachedCountryLimit) {
 549       $countryIsoCodes = CRM_Core_PseudoConstant::countryIsoCode();
 550       $country = array();
 551       if (is_array($this->countryLimit)) {
 552         foreach ($this->countryLimit as $val) {
 553           // CRM-12007
 554           // some countries have disappeared and hence they might be in country limit
 555           // but not in the country table
 556           if (isset($countryIsoCodes[$val])) {
 557             $country[] = $countryIsoCodes[$val];
 558           }
 559         }
 560       }
 561       else {
 562         $country[] = $countryIsoCodes[$this->countryLimit];
 563       }
 564       $cachedCountryLimit = $country;
 565     }
 566     return $cachedCountryLimit;
 567   }
 568
 569   /**
 570    * Provide cached province limit translated to names.
 571    *
 572    * @param
 573    *
 574    * @return array
 575    */
 576   public function provinceLimit() {
 577     static $cachedProvinceLimit = NULL;
 578     if (!$cachedProvinceLimit) {
 579       $countryIsoCodes = CRM_Core_PseudoConstant::countryIsoCode();
 580       $country = array();
 581       if (is_array($this->provinceLimit)) {
 582         foreach ($this->provinceLimit as $val) {
 583           // CRM-12007
 584           // some countries have disappeared and hence they might be in country limit
 585           // but not in the country table
 586           if (isset($countryIsoCodes[$val])) {
 587             $country[] = $countryIsoCodes[$val];
 588           }
 589         }
 590       }
 591       else {
 592         $country[] = $countryIsoCodes[$this->provinceLimit];
 593       }
 594       $cachedProvinceLimit = $country;
 595     }
 596     return $cachedProvinceLimit;
 597   }
 598
 599 }
 600 // end CRM_Core_Config