CRM/Core/Config/Variables.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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-2014
  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 encoding of strings returned by gettext
 233    * @var string
 234    */
 235   public $gettextCodeset = 'utf-8';
 236
 237   /**
 238    * Default name for gettext domain.
 239    * @var string
 240    */
 241   public $gettextDomain = 'civicrm';
 242
 243   /**
 244    * Default location of gettext resource files.
 245    */
 246   public $gettextResourceDir = './l10n/';
 247
 248   /**
 249    * Default user framework. This basically makes Drupal 7 the default
 250    */
 251   public $userFramework = 'Drupal';
 252   public $userFrameworkVersion = 'Unknown';
 253   public $userFrameworkUsersTableName = 'users';
 254   public $userFrameworkClass = 'CRM_Utils_System_Drupal';
 255   public $userHookClass = 'CRM_Utils_Hook_Drupal';
 256
 257   /**
 258    * @var string|CRM_Core_Permission_Base
 259    */
 260   public $userPermissionClass = 'CRM_Core_Permission_Drupal';
 261
 262   public $userFrameworkURLVar = 'q';
 263   public $userFrameworkDSN = NULL;
 264   public $userFrameworkBaseURL = NULL;
 265   public $userFrameworkResourceURL = NULL;
 266   public $userFrameworkFrontend = FALSE;
 267   public $userFrameworkLogging = FALSE;
 268
 269   /**
 270    * The handle for import file size
 271    * @var int
 272    */
 273   public $maxImportFileSize = 1048576;
 274   public $maxFileSize = 2;
 275
 276   /**
 277    * The custom locale strings. Note that these locale strings are stored
 278    * in a separate column in civicrm_domain
 279    * @var array
 280    */
 281   public $localeCustomStrings = NULL;
 282
 283   /**
 284    * Map Provider
 285    *
 286    * @var string
 287    */
 288   public $mapProvider = NULL;
 289
 290   /**
 291    * Map API Key
 292    *
 293    * @var string
 294    */
 295   public $mapAPIKey = NULL;
 296
 297   /**
 298    * Geocoding Provider
 299    *
 300    * @var string
 301    */
 302   public $geoProvider = NULL;
 303
 304   /**
 305    * Geocoding API Key
 306    *
 307    * @var string
 308    */
 309   public $geoAPIKey = NULL;
 310
 311   /**
 312    * How should we get geo code information if google map support needed
 313    *
 314    * @var string
 315    */
 316   public $geocodeMethod = '';
 317
 318   /**
 319    *
 320    *
 321    * @var boolean
 322    */
 323   public $mapGeoCoding = 1;
 324
 325
 326   /**
 327    * Whether database-level logging should be performed
 328    * @var boolean
 329    */
 330   public $logging = FALSE;
 331
 332   /**
 333    * Whether public pages should display "empowered by CiviCRM"
 334    *
 335    * @var boolean
 336    */
 337   public $empoweredBy = TRUE;
 338
 339   /**
 340    * Array of enabled add-on components (e.g. CiviContribute, CiviMail...)
 341    *
 342    * @var array
 343    */
 344   public $enableComponents = array(
 345     'CiviContribute', 'CiviPledge', 'CiviMember',
 346     'CiviEvent', 'CiviMail', 'CiviReport',
 347   );
 348   public $enableComponentIDs = array(1, 6, 2, 3, 4, 8);
 349
 350   /**
 351    * Should payments be accepted only via SSL?
 352    *
 353    * @var boolean
 354    */
 355   public $enableSSL = FALSE;
 356
 357   /**
 358    * Error template to use for fatal errors
 359    *
 360    * @var string
 361    */
 362   public $fatalErrorTemplate = 'CRM/common/fatal.tpl';
 363
 364   /**
 365    * Fatal error handler
 366    *
 367    * @var string
 368    */
 369   public $fatalErrorHandler = NULL;
 370
 371   /**
 372    * Legacy encoding for file encoding conversion
 373    *
 374    * @var string
 375    */
 376   public $legacyEncoding = 'Windows-1252';
 377
 378   /**
 379    * Field separator for import/export csv file
 380    *
 381    * @var string
 382    */
 383   public $fieldSeparator = ',';
 384
 385   /**
 386    * Max location blocks in address
 387    *
 388    * @var integer
 389    */
 390   public $maxLocationBlocks = 2;
 391
 392   /**
 393    * The font path where captcha fonts are stored
 394    *
 395    * @var string
 396    */
 397   public $captchaFontPath = '/usr/X11R6/lib/X11/fonts/';
 398
 399   /**
 400    * The font to use for captcha
 401    *
 402    * @var string
 403    */
 404   public $captchaFont = 'HelveticaBold.ttf';
 405
 406   /**
 407    * Some search settings
 408    */
 409   public $includeWildCardInName = 1;
 410   public $includeEmailInName = 1;
 411   public $includeNickNameInName = 0;
 412
 413   public $smartGroupCacheTimeout = 5;
 414
 415   public $defaultSearchProfileID = NULL;
 416
 417   /**
 418    * Dashboard timeout
 419    */
 420   public $dashboardCacheTimeout = 1440;
 421
 422   /**
 423    * Flag to indicate if acl cache is NOT to be reset
 424    */
 425   public $doNotResetCache = 0;
 426
 427   /**
 428    * Optimization related variables
 429    */
 430   public $includeAlphabeticalPager = 1;
 431   public $includeOrderByClause = 1;
 432   public $oldInputStyle = 1;
 433
 434   /**
 435    * Should we disable key generation for forms
 436    *
 437    * @var boolean
 438    */
 439   public $formKeyDisable = FALSE;
 440
 441   /**
 442    * To determine whether the call is from cms or civicrm
 443    */
 444   public $inCiviCRM = FALSE;
 445
 446   /**
 447    * Component registry object (of CRM_Core_Component type)
 448    */
 449   public $componentRegistry = NULL;
 450
 451   /**
 452    * PDF receipt as attachment is disabled by default (CRM-8350)
 453    */
 454   public $doNotAttachPDFReceipt = FALSE;
 455
 456   /**
 457    * Path to wkhtmltopdf if available
 458    */
 459   public $wkhtmltopdfPath = FALSE;
 460
 461   /**
 462    * Allow second-degree relations permission to edit contacts
 463    */
 464   public $secondDegRelPermissions = FALSE;
 465
 466
 467   /**
 468    * Allow second-degree relations permission to edit contacts
 469    */
 470   public $wpBasePage = NULL;
 471
 472   /**
 473    * Provide addressSequence
 474    *
 475    * @param
 476    *
 477    * @return string
 478    */
 479   public function addressSequence() {
 480     $addressFormat = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
 481       'address_format'
 482     );
 483
 484     return CRM_Utils_Address::sequence($addressFormat);
 485   }
 486
 487   /**
 488    * Provide cached default currency symbol
 489    *
 490    * @param
 491    *
 492    * @return string
 493    */
 494   public function defaultCurrencySymbol($defaultCurrency = NULL) {
 495     static $cachedSymbol = NULL;
 496     if (!$cachedSymbol || $defaultCurrency) {
 497       if ($this->defaultCurrency || $defaultCurrency) {
 498         $this->currencySymbols = CRM_Core_PseudoConstant::get('CRM_Contribute_DAO_Contribution', 'currency', array(
 499           'labelColumn' => 'symbol',
 500           'orderColumn' => TRUE,
 501         ));
 502         $currency = $defaultCurrency ? $defaultCurrency : $this->defaultCurrency;
 503         $cachedSymbol = CRM_Utils_Array::value($currency, $this->currencySymbols, '');
 504       }
 505       else {
 506         $cachedSymbol = '$';
 507       }
 508     }
 509     return $cachedSymbol;
 510   }
 511
 512   /**
 513    * Provide cached default currency symbol
 514    *
 515    * @param
 516    *
 517    * @return string
 518    */
 519   public function defaultContactCountry() {
 520     static $cachedContactCountry = NULL;
 521
 522     if (!empty($this->defaultContactCountry) &&
 523       !$cachedContactCountry
 524     ) {
 525       $countryIsoCodes = CRM_Core_PseudoConstant::countryIsoCode();
 526       $cachedContactCountry = CRM_Utils_Array::value($this->defaultContactCountry,
 527         $countryIsoCodes
 528       );
 529     }
 530     return $cachedContactCountry;
 531   }
 532
 533   /**
 534    * Provide cached default country name
 535    *
 536    * @param
 537    *
 538    * @return string
 539    */
 540   public function defaultContactCountryName() {
 541     static $cachedContactCountryName = NULL;
 542     if (!$cachedContactCountryName && $this->defaultContactCountry) {
 543       $countryCodes = CRM_Core_PseudoConstant::country();
 544       $cachedContactCountryName = $countryCodes[$this->defaultContactCountry];
 545     }
 546     return $cachedContactCountryName;
 547   }
 548
 549   /**
 550    * Provide cached country limit translated to names
 551    *
 552    * @param
 553    *
 554    * @return array
 555    */
 556   public function countryLimit() {
 557     static $cachedCountryLimit = NULL;
 558     if (!$cachedCountryLimit) {
 559       $countryIsoCodes = CRM_Core_PseudoConstant::countryIsoCode();
 560       $country = array();
 561       if (is_array($this->countryLimit)) {
 562         foreach ($this->countryLimit as $val) {
 563           // CRM-12007
 564           // some countries have disappeared and hence they might be in country limit
 565           // but not in the country table
 566           if (isset($countryIsoCodes[$val])) {
 567             $country[] = $countryIsoCodes[$val];
 568           }
 569         }
 570       }
 571       else {
 572         $country[] = $countryIsoCodes[$this->countryLimit];
 573       }
 574       $cachedCountryLimit = $country;
 575     }
 576     return $cachedCountryLimit;
 577   }
 578
 579   /**
 580    * Provide cached province limit translated to names
 581    *
 582    * @param
 583    *
 584    * @return array
 585    */
 586   public function provinceLimit() {
 587     static $cachedProvinceLimit = NULL;
 588     if (!$cachedProvinceLimit) {
 589       $countryIsoCodes = CRM_Core_PseudoConstant::countryIsoCode();
 590       $country = array();
 591       if (is_array($this->provinceLimit)) {
 592         foreach ($this->provinceLimit as $val) {
 593           // CRM-12007
 594           // some countries have disappeared and hence they might be in country limit
 595           // but not in the country table
 596           if (isset($countryIsoCodes[$val])) {
 597             $country[] = $countryIsoCodes[$val];
 598           }
 599         }
 600       }
 601       else {
 602         $country[] = $countryIsoCodes[$this->provinceLimit];
 603       }
 604       $cachedProvinceLimit = $country;
 605     }
 606     return $cachedProvinceLimit;
 607   }
 608 }
 609 // end CRM_Core_Config