INFRA-132 - Cleanup generated dao docblocks
[civicrm-core.git] / CRM / Core / PseudoConstant.php
index 2afe385da27c0fc83f1a3eb9bd85693af734eb08..7a5665f4525aabf039b2e8babd31a120071f8816 100644 (file)
@@ -52,7 +52,6 @@ class CRM_Core_PseudoConstant {
   /**
    * Static cache for pseudoconstant arrays
    * @var array
-   * @static
    */
   private static $cache;
 
@@ -61,42 +60,36 @@ class CRM_Core_PseudoConstant {
    *
    * activity type
    * @var array
-   * @static
    */
   private static $activityType;
 
   /**
    * States, provinces
    * @var array
-   * @static
    */
   private static $stateProvince;
 
   /**
    * Counties
    * @var array
-   * @static
    */
   private static $county;
 
   /**
    * States/provinces abbreviations
    * @var array
-   * @static
    */
   private static $stateProvinceAbbreviation;
 
   /**
    * Country
    * @var array
-   * @static
    */
   private static $country;
 
   /**
    * CountryIsoCode
    * @var array
-   * @static
    */
   private static $countryIsoCode;
 
@@ -105,56 +98,48 @@ class CRM_Core_PseudoConstant {
    *
    * group
    * @var array
-   * @static
    */
   private static $group;
 
   /**
    * GroupIterator
    * @var mixed
-   * @static
    */
   private static $groupIterator;
 
   /**
    * RelationshipType
    * @var array
-   * @static
    */
   private static $relationshipType;
 
   /**
    * Civicrm groups that are not smart groups
    * @var array
-   * @static
    */
   private static $staticGroup;
 
   /**
    * Currency codes
    * @var array
-   * @static
    */
   private static $currencyCode;
 
   /**
    * Payment processor
    * @var array
-   * @static
    */
   private static $paymentProcessor;
 
   /**
    * Payment processor types
    * @var array
-   * @static
    */
   private static $paymentProcessorType;
 
   /**
    * World Region
    * @var array
-   * @static
    */
   private static $worldRegions;
 
@@ -163,49 +148,42 @@ class CRM_Core_PseudoConstant {
    *
    * activity status
    * @var array
-   * @static
    */
   private static $activityStatus;
 
   /**
    * Visibility
    * @var array
-   * @static
    */
   private static $visibility;
 
   /**
    * Greetings
    * @var array
-   * @static
    */
   private static $greeting;
 
   /**
    * Default Greetings
    * @var array
-   * @static
    */
   private static $greetingDefaults;
 
   /**
    * Extensions of type module
    * @var array
-   * @static
    */
   private static $extensions;
 
   /**
    * Financial Account Type
    * @var array
-   * @static
    */
   private static $accountOptionValues;
 
   /**
    * Tax Rates
    * @var array
-   * @static
    */
   private static $taxRates;
 
@@ -228,11 +206,11 @@ class CRM_Core_PseudoConstant {
    * - orderColumn string the column to use for sorting, defaults to 'weight' column if one exists, else defaults to labelColumn
    * - onlyActive boolean return only the action option values
    * - fresh      boolean ignore cache entries and go back to DB
-   * @param string $context: Context string
+   * @param string $context : Context string
    *
-   * @return Array|bool - array on success, FALSE on error.
+   * @return Array|bool
+   *   array on success, FALSE on error.
    *
-   * @static
    */
   public static function get($daoName, $fieldName, $params = array(), $context = NULL) {
     CRM_Core_DAO::buildOptionsContext($context);
@@ -380,9 +358,9 @@ class CRM_Core_PseudoConstant {
             $wheres[] = 'domain_id = ' . CRM_Core_Config::domainID();
           }
           $queryParams = array(
-             1 => array($params['keyColumn'], 'String', CRM_Core_DAO::QUERY_FORMAT_NO_QUOTES),
-             2 => array($params['labelColumn'], 'String', CRM_Core_DAO::QUERY_FORMAT_NO_QUOTES),
-             3 => array($pseudoconstant['table'], 'String', CRM_Core_DAO::QUERY_FORMAT_NO_QUOTES),
+            1 => array($params['keyColumn'], 'String', CRM_Core_DAO::QUERY_FORMAT_NO_QUOTES),
+            2 => array($params['labelColumn'], 'String', CRM_Core_DAO::QUERY_FORMAT_NO_QUOTES),
+            3 => array($pseudoconstant['table'], 'String', CRM_Core_DAO::QUERY_FORMAT_NO_QUOTES),
           );
           // Add orderColumn param
           if (!empty($params['orderColumn'])) {
@@ -556,7 +534,6 @@ class CRM_Core_PseudoConstant {
    * @param null $force
    *
    * @return void
-   * @static
    */
   public static function populate(
     &$var,
@@ -570,8 +547,8 @@ class CRM_Core_PseudoConstant {
     $force = NULL
   ) {
     $cacheKey = "CRM_PC_{$name}_{$all}_{$key}_{$retrieve}_{$filter}_{$condition}_{$orderby}";
-    $cache    = CRM_Utils_Cache::singleton();
-    $var      = $cache->get($cacheKey);
+    $cache = CRM_Utils_Cache::singleton();
+    $var = $cache->get($cacheKey);
     if ($var && empty($force)) {
       return $var;
     }
@@ -608,7 +585,6 @@ class CRM_Core_PseudoConstant {
    * Flush given pseudoconstant so it can be reread from db
    * nex time it's requested.
    *
-   * @static
    *
    * @param bool|string $name pseudoconstant to be flushed
    */
@@ -628,7 +604,6 @@ class CRM_Core_PseudoConstant {
    *
    * The static array activityType is returned
    *
-   * @static
    *
    * @return array
    *   array reference of all activity types.
@@ -703,7 +678,6 @@ class CRM_Core_PseudoConstant {
    *
    * Note: any database errors will be trapped by the DAO.
    *
-   * @static
    *
    * @param bool|int $id - Optional id to return
    *
@@ -718,8 +692,8 @@ class CRM_Core_PseudoConstant {
       $config = CRM_Core_Config::singleton();
       if ($limit) {
         $countryIsoCodes = self::countryIsoCode();
-        $limitCodes      = $config->provinceLimit();
-        $limitIds        = array();
+        $limitCodes = $config->provinceLimit();
+        $limitIds = array();
         foreach ($limitCodes as $code) {
           $limitIds = array_merge($limitIds, array_keys($countryIsoCodes, $code));
         }
@@ -737,8 +711,8 @@ class CRM_Core_PseudoConstant {
       if ($tsLocale != '' and $tsLocale != 'en_US') {
         $i18n = CRM_Core_I18n::singleton();
         $i18n->localizeArray(self::$stateProvince, array(
-            'context' => 'province',
-          ));
+          'context' => 'province',
+        ));
         self::$stateProvince = CRM_Utils_Array::asort(self::$stateProvince);
       }
     }
@@ -759,7 +733,6 @@ class CRM_Core_PseudoConstant {
    *
    * Same as above, except gets the abbreviations instead of the names.
    *
-   * @static
    *
    * @param bool|int $id - Optional id to return
    *
@@ -788,10 +761,10 @@ WHERE  id = %1";
       $whereClause = FALSE;
 
       if ($limit) {
-        $config          = CRM_Core_Config::singleton();
+        $config = CRM_Core_Config::singleton();
         $countryIsoCodes = self::countryIsoCode();
-        $limitCodes      = $config->provinceLimit();
-        $limitIds        = array();
+        $limitCodes = $config->provinceLimit();
+        $limitIds = array();
         foreach ($limitCodes as $code) {
           $tmpArray = array_keys($countryIsoCodes, $code);
 
@@ -827,7 +800,6 @@ WHERE  id = %1";
    *
    * Note: any database errors will be trapped by the DAO.
    *
-   * @static
    *
    * @param bool|int $id - Optional id to return
    *
@@ -880,8 +852,8 @@ WHERE  id = %1";
       if ($tsLocale != '' and $tsLocale != 'en_US') {
         $i18n = CRM_Core_I18n::singleton();
         $i18n->localizeArray(self::$country, array(
-            'context' => 'country',
-          ));
+          'context' => 'country',
+        ));
         self::$country = CRM_Utils_Array::asort(self::$country);
       }
     }
@@ -905,7 +877,6 @@ WHERE  id = %1";
    *
    * Note: any database errors will be trapped by the DAO.
    *
-   * @static
    *
    * @param bool $id
    *
@@ -943,7 +914,6 @@ WHERE  id = %1";
    * @param bool $excludeHidden
    *   Exclude hidden groups.
    *
-   * @static
    *
    * @return array
    *   array reference of all groups.
@@ -972,18 +942,15 @@ WHERE  id = %1";
    * called for the first time
    *
    *
-   * @static
    *
    * @param bool $styledLabels
    *
-   * @return mixed - instance of CRM_Contact_BAO_GroupNesting
+   * @return CRM_Contact_BAO_GroupNesting
    */
   public static function &groupIterator($styledLabels = FALSE) {
     if (!self::$groupIterator) {
-      /*
-        When used as an object, GroupNesting implements Iterator
-        and iterates nested groups in a logical manner for us
-      */
+      // When used as an object, GroupNesting implements Iterator
+      // and iterates nested groups in a logical manner for us
       self::$groupIterator = new CRM_Contact_BAO_GroupNesting($styledLabels);
     }
     return self::$groupIterator;
@@ -1003,7 +970,6 @@ WHERE  id = %1";
    * @param bool $excludeHidden
    *   Exclude hidden groups.
    *
-   * @static
    *
    * @return array
    *   array reference of all groups.
@@ -1033,7 +999,6 @@ WHERE  id = %1";
    *
    * Note: any database errors will be trapped by the DAO.
    *
-   * @static
    *
    * @param bool $onlyPublic
    * @param null $groupType
@@ -1077,7 +1042,6 @@ WHERE  id = %1";
    * @param bool $reset
    *   Reset relationship types if true.
    *
-   * @static
    *
    * @return array
    *   array reference of all relationship types.
@@ -1120,7 +1084,6 @@ WHERE  id = %1";
    *
    * @return array
    *   array reference of all currency codes
-   * @static
    */
   public static function &currencyCode() {
     if (!self::$currencyCode) {
@@ -1406,7 +1369,6 @@ WHERE  id = %1";
    *
    * Note: any database errors will be trapped by the DAO.
    *
-   * @static
    *
    * @param bool|int $id - Optional id to return
    *
@@ -1437,7 +1399,6 @@ WHERE  id = %1";
    *
    * The static array paymentProcessor is returned
    *
-   * @static
    *
    * @param bool $all
    *   Get payment processors - default is to get only active ones.
@@ -1474,7 +1435,6 @@ WHERE  id = %1";
    *
    * The static array paymentProcessorType is returned
    *
-   * @static
    *
    * @param bool $all
    *   Get payment processors - default is to get only active ones.
@@ -1504,7 +1464,6 @@ WHERE  id = %1";
    *
    * @return array
    *   array reference of all World Regions
-   * @static
    */
   public static function &worldRegion($id = FALSE) {
     if (!self::$worldRegions) {
@@ -1530,7 +1489,6 @@ WHERE  id = %1";
    *
    * The static array activityStatus is returned
    *
-   * @static
    *
    * @param string $column
    *
@@ -1557,7 +1515,6 @@ WHERE  id = %1";
    *
    * The static array visibility is returned
    *
-   * @static
    *
    * @param string $column
    *
@@ -1697,7 +1654,6 @@ ORDER BY name";
    *
    * @return int
    *   the country id that the state belongs to
-   * @static
    */
   public static function countryIDForStateID($stateID) {
     if (empty($stateID)) {
@@ -1719,7 +1675,6 @@ WHERE  id = %1
    *
    * The static array of greeting is returned
    *
-   * @static
    *
    * @param $filter
    *   Get All Email Greetings - default is to get only active ones.
@@ -1771,7 +1726,6 @@ WHERE  id = %1
   /**
    * Construct array of default greeting values for contact type
    *
-   * @static
    *
    * @return array
    *   array reference of default greetings.
@@ -1779,7 +1733,10 @@ WHERE  id = %1
   public static function &greetingDefaults() {
     if (!self::$greetingDefaults) {
       $defaultGreetings = array();
-      $contactTypes = self::get('CRM_Contact_DAO_Contact', 'contact_type', array('keyColumn' => 'id', 'labelColumn' => 'name'));
+      $contactTypes = self::get('CRM_Contact_DAO_Contact', 'contact_type', array(
+          'keyColumn' => 'id',
+          'labelColumn' => 'name'
+        ));
 
       foreach ($contactTypes as $filter => $contactType) {
         $filterCondition = " AND (v.filter = 0 OR v.filter = $filter) AND v.is_default = 1 ";
@@ -1804,7 +1761,6 @@ WHERE  id = %1
    * FIXME: This is called by civix but not by any core code. We
    * should provide an API call which civix can use instead.
    *
-   * @static
    *
    * @return array
    *   array($fullyQualifiedName => $label) list of extensions
@@ -1831,7 +1787,6 @@ WHERE  id = %1
    *
    * The static array option values is returned
    *
-   * @static
    *
    * @param bool $optionGroupName
    *   Get All Option Group values- default is to get only active ones.
@@ -1859,7 +1814,6 @@ WHERE  id = %1
    *
    * @param bool $fresh
    *   Whether to forcibly reload extensions list from canonical store.
-   * @static
    *
    * @return array
    *   array(array('prefix' => $, 'file' => $))
@@ -1874,8 +1828,6 @@ WHERE  id = %1
    *
    * The static array tax rates is returned
    *
-   * @static
-   *
    * @return array
    *   array list of tax rates with the financial type
    */