Merge remote-tracking branch 'upstream/4.5' into 4.5-master-2015-03-03-23-44-14

[civicrm-core.git] / CRM / Core / Config / Variables.php

diff --git a/CRM/Core/Config/Variables.php b/CRM/Core/Config/Variables.php
index c6da07606d161ef2e744e648bf39c7297e855a6d..8ea70b053eae360f1f6352733083b60902716147 100644 (file)
--- a/CRM/Core/Config/Variables.php
+++ b/CRM/Core/Config/Variables.php
@@ -23,7 +23,7 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  * Variables class contains definitions of all the core config settings that are allowed on
@@ -38,21 +38,21 @@
 class CRM_Core_Config_Variables extends CRM_Core_Config_Defaults {
 
   /**
-   * The debug level for civicrm
+   * The debug level for civicrm.
    * @var int
    */
   public $debug = 0;
   public $backtrace = 0;
 
   /**
-   * The directory where Smarty and plugins are installed
+   * The directory where Smarty and plugins are installed.
    * @var string
    */
   public $smartyDir = NULL;
   public $pluginsDir = NULL;
 
   /**
-   * The root directory of our template tree
+   * The root directory of our template tree.
    * @var string
    */
   public $templateDir = NULL;
@@ -253,7 +253,12 @@ class CRM_Core_Config_Variables extends CRM_Core_Config_Defaults {
   public $userFrameworkUsersTableName = 'users';
   public $userFrameworkClass = 'CRM_Utils_System_Drupal';
   public $userHookClass = 'CRM_Utils_Hook_Drupal';
+
+  /**
+   * @var string|CRM_Core_Permission_Base
+   */
   public $userPermissionClass = 'CRM_Core_Permission_Drupal';
+
   public $userFrameworkURLVar = 'q';
   public $userFrameworkDSN = NULL;
   public $userFrameworkBaseURL = NULL;
@@ -337,8 +342,12 @@ class CRM_Core_Config_Variables extends CRM_Core_Config_Defaults {
    * @var array
    */
   public $enableComponents = array(
-    'CiviContribute', 'CiviPledge', 'CiviMember',
-    'CiviEvent', 'CiviMail', 'CiviReport',
+    'CiviContribute',
+    'CiviPledge',
+    'CiviMember',
+    'CiviEvent',
+    'CiviMail',
+    'CiviReport',
   );
   public $enableComponentIDs = array(1, 6, 2, 3, 4, 8);
 
@@ -434,7 +443,7 @@ class CRM_Core_Config_Variables extends CRM_Core_Config_Defaults {
   public $formKeyDisable = FALSE;
 
   /**
-   * To determine whether the call is from cms or civicrm
+   * determine whether the call is from cms or civicrm
    */
   public $inCiviCRM = FALSE;
 
@@ -465,7 +474,7 @@ class CRM_Core_Config_Variables extends CRM_Core_Config_Defaults {
   public $wpBasePage = NULL;
 
   /**
-   * Provide addressSequence
+   * Provide addressSequence.
    *
    * @param
    *
@@ -480,7 +489,7 @@ class CRM_Core_Config_Variables extends CRM_Core_Config_Defaults {
   }
 
   /**
-   * Provide cached default currency symbol
+   * Provide cached default currency symbol.
    *
    * @param
    *
@@ -505,7 +514,7 @@ class CRM_Core_Config_Variables extends CRM_Core_Config_Defaults {
   }
 
   /**
-   * Provide cached default currency symbol
+   * Provide cached default currency symbol.
    *
    * @param
    *
@@ -526,7 +535,7 @@ class CRM_Core_Config_Variables extends CRM_Core_Config_Defaults {
   }
 
   /**
-   * Provide cached default country name
+   * Provide cached default country name.
    *
    * @param
    *
@@ -542,7 +551,7 @@ class CRM_Core_Config_Variables extends CRM_Core_Config_Defaults {
   }
 
   /**
-   * Provide cached country limit translated to names
+   * Provide cached country limit translated to names.
    *
    * @param
    *
@@ -572,7 +581,7 @@ class CRM_Core_Config_Variables extends CRM_Core_Config_Defaults {
   }
 
   /**
-   * Provide cached province limit translated to names
+   * Provide cached province limit translated to names.
    *
    * @param
    *
@@ -600,5 +609,6 @@ class CRM_Core_Config_Variables extends CRM_Core_Config_Defaults {
     }
     return $cachedProvinceLimit;
   }
+
 }
 // end CRM_Core_Config