From: Coleman Watts <coleman@civicrm.org>
Date: Mon, 12 Jan 2015 03:02:49 +0000 (-0500)
Subject: INFRA-132 - Fix incorrect param types
X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=3f8d286263ca1acbea9a5cd29f923b82b731f6ca;p=civicrm-core.git

INFRA-132 - Fix incorrect param types
---

diff --git a/CRM/Activity/Selector/Activity.php b/CRM/Activity/Selector/Activity.php
index 37172af2af..02606caacb 100644
--- a/CRM/Activity/Selector/Activity.php
+++ b/CRM/Activity/Selector/Activity.php
@@ -314,7 +314,7 @@ class CRM_Activity_Selector_Activity extends CRM_Core_Selector_Base implements C
    *
    * @param string $action
    *   The action being performed.
-   * @param enum $output
+   * @param string $output
    *   What should the result set include (web/email/csv).
    *
    * @return array
@@ -363,7 +363,7 @@ class CRM_Activity_Selector_Activity extends CRM_Core_Selector_Base implements C
   /**
    * Returns all the rows in the given offset and rowCount
    *
-   * @param enum $action
+   * @param string $action
    *   The action being performed.
    * @param int $offset
    *   The row number to start from.
@@ -371,7 +371,7 @@ class CRM_Activity_Selector_Activity extends CRM_Core_Selector_Base implements C
    *   The number of rows to return.
    * @param string $sort
    *   The sql string that describes the sort order.
-   * @param enum $output
+   * @param string $output
    *   What should the result set include (web/email/csv).
    *
    * @param null $case
diff --git a/CRM/Activity/Selector/Search.php b/CRM/Activity/Selector/Search.php
index bd06e3bff6..cd71340535 100644
--- a/CRM/Activity/Selector/Search.php
+++ b/CRM/Activity/Selector/Search.php
@@ -223,7 +223,7 @@ class CRM_Activity_Selector_Search extends CRM_Core_Selector_Base implements CRM
   /**
    * Returns all the rows in the given offset and rowCount
    *
-   * @param enum $action
+   * @param string $action
    *   The action being performed.
    * @param int $offset
    *   The row number to start from.
@@ -231,7 +231,7 @@ class CRM_Activity_Selector_Search extends CRM_Core_Selector_Base implements CRM
    *   The number of rows to return.
    * @param string $sort
    *   The sql string that describes the sort order.
-   * @param enum $output
+   * @param string $output
    *   What should the result set include (web/email/csv).
    *
    * @return array
@@ -373,7 +373,7 @@ class CRM_Activity_Selector_Search extends CRM_Core_Selector_Base implements CRM
    *
    * @param string $action
    *   The action being performed.
-   * @param enum $output
+   * @param string $output
    *   What should the result set include (web/email/csv).
    *
    * @return array
diff --git a/CRM/Campaign/Selector/Search.php b/CRM/Campaign/Selector/Search.php
index 4460958edf..d18176eb9c 100755
--- a/CRM/Campaign/Selector/Search.php
+++ b/CRM/Campaign/Selector/Search.php
@@ -227,7 +227,7 @@ class CRM_Campaign_Selector_Search extends CRM_Core_Selector_Base implements CRM
   /**
    * Returns all the rows in the given offset and rowCount
    *
-   * @param enum $action
+   * @param string $action
    *   The action being performed.
    * @param int $offset
    *   The row number to start from.
@@ -235,7 +235,7 @@ class CRM_Campaign_Selector_Search extends CRM_Core_Selector_Base implements CRM
    *   The number of rows to return.
    * @param string $sort
    *   The sql string that describes the sort order.
-   * @param enum $output
+   * @param string $output
    *   What should the result set include (web/email/csv).
    *
    * @return int
@@ -322,7 +322,7 @@ FROM {$from}
    *
    * @param string $action
    *   The action being performed.
-   * @param enum $output
+   * @param string $output
    *   What should the result set include (web/email/csv).
    *
    * @return array
diff --git a/CRM/Case/Selector/Search.php b/CRM/Case/Selector/Search.php
index 8efdef6aa3..78b5e75f21 100644
--- a/CRM/Case/Selector/Search.php
+++ b/CRM/Case/Selector/Search.php
@@ -285,7 +285,7 @@ class CRM_Case_Selector_Search extends CRM_Core_Selector_Base {
   /**
    * Returns all the rows in the given offset and rowCount
    *
-   * @param enum $action
+   * @param string $action
    *   The action being performed.
    * @param int $offset
    *   The row number to start from.
@@ -293,7 +293,7 @@ class CRM_Case_Selector_Search extends CRM_Core_Selector_Base {
    *   The number of rows to return.
    * @param string $sort
    *   The sql string that describes the sort order.
-   * @param enum $output
+   * @param string $output
    *   What should the result set include (web/email/csv).
    *
    * @return int
@@ -428,7 +428,7 @@ class CRM_Case_Selector_Search extends CRM_Core_Selector_Base {
    *
    * @param string $action
    *   The action being performed.
-   * @param enum $output
+   * @param string $output
    *   What should the result set include (web/email/csv).
    *
    * @return array
diff --git a/CRM/Contact/BAO/Group.php b/CRM/Contact/BAO/Group.php
index bc008a1d09..0ff3c40a6b 100644
--- a/CRM/Contact/BAO/Group.php
+++ b/CRM/Contact/BAO/Group.php
@@ -156,8 +156,8 @@ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group {
    *
    * @param int $id
    *   Group id.
-   * @param enum|string $status status of members in group
-   *
+   * @param string $status
+   *   status of members in group
    * @param bool $countChildGroups
    *
    * @return int
@@ -229,11 +229,10 @@ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group {
    *   Limits the set of groups returned.
    * @param array $returnProperties
    *   Which properties should be included in the returned group objects.
-   *                                       (member_count should be last element.)
-   *
-   * @param NULL $sort
-   * @param NULL $offset
-   * @param NULL $rowCount
+   *   (member_count should be last element.)
+   * @param string $sort
+   * @param int $offset
+   * @param int $rowCount
    *
    * @return array
    *   Array of group objects.
@@ -349,7 +348,6 @@ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group {
    * Create a new group
    *
    * @param array $params
-   *   Associative array of parameters.
    *
    * @return CRM_Contact_BAO_Group|NULL
    *   The new group BAO (if created)
@@ -566,7 +564,7 @@ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group {
    *   Value we want to set the is_active field.
    *
    * @return CRM_Core_DAO|null
-   *   DAO object on sucess, NULL otherwise
+   *   DAO object on success, NULL otherwise
    * @static
    */
   public static function setIsActive($id, $isActive) {
@@ -578,7 +576,7 @@ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group {
    *
    * @param string $groupType
    *   Type of group(Access/Mailing) OR the key of the group.
-   * @param bool|\boolen $excludeHidden exclude hidden groups.
+   * @param bool $excludeHidden exclude hidden groups.
    *
    * @return string
    * @static
diff --git a/CRM/Contact/Selector.php b/CRM/Contact/Selector.php
index 3c37792145..b870948a18 100644
--- a/CRM/Contact/Selector.php
+++ b/CRM/Contact/Selector.php
@@ -338,7 +338,7 @@ class CRM_Contact_Selector extends CRM_Core_Selector_Base implements CRM_Core_Se
    *
    * @param string $action
    *   The action being performed.
-   * @param enum $output
+   * @param string $output
    *   What should the result set include (web/email/csv).
    *
    * @return array
@@ -516,7 +516,7 @@ class CRM_Contact_Selector extends CRM_Core_Selector_Base implements CRM_Core_Se
   /**
    * Returns all the rows in the given offset and rowCount
    *
-   * @param enum $action
+   * @param string $action
    *   The action being performed.
    * @param int $offset
    *   The row number to start from.
@@ -524,7 +524,7 @@ class CRM_Contact_Selector extends CRM_Core_Selector_Base implements CRM_Core_Se
    *   The number of rows to return.
    * @param string $sort
    *   The sql string that describes the sort order.
-   * @param enum $output
+   * @param string $output
    *   What should the result set include (web/email/csv).
    *
    * @return int
diff --git a/CRM/Contact/Selector/Custom.php b/CRM/Contact/Selector/Custom.php
index b4ad66c504..726d747e7d 100644
--- a/CRM/Contact/Selector/Custom.php
+++ b/CRM/Contact/Selector/Custom.php
@@ -223,7 +223,7 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector {
    *
    * @param string $action
    *   The action being performed.
-   * @param enum $output
+   * @param string $output
    *   What should the result set include (web/email/csv).
    *
    * @return array
@@ -267,7 +267,7 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector {
   /**
    * Returns all the rows in the given offset and rowCount
    *
-   * @param enum $action
+   * @param string $action
    *   The action being performed.
    * @param int $offset
    *   The row number to start from.
@@ -275,7 +275,7 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector {
    *   The number of rows to return.
    * @param string $sort
    *   The sql string that describes the sort order.
-   * @param enum $output
+   * @param string $output
    *   What should the result set include (web/email/csv).
    *
    * @return int
diff --git a/CRM/Contribute/Selector/Search.php b/CRM/Contribute/Selector/Search.php
index 38f877bb64..2a0a97d92a 100644
--- a/CRM/Contribute/Selector/Search.php
+++ b/CRM/Contribute/Selector/Search.php
@@ -301,7 +301,7 @@ class CRM_Contribute_Selector_Search extends CRM_Core_Selector_Base implements C
   /**
    * Returns all the rows in the given offset and rowCount
    *
-   * @param enum $action
+   * @param string $action
    *   The action being performed.
    * @param int $offset
    *   The row number to start from.
@@ -309,7 +309,7 @@ class CRM_Contribute_Selector_Search extends CRM_Core_Selector_Base implements C
    *   The number of rows to return.
    * @param string $sort
    *   The sql string that describes the sort order.
-   * @param enum $output
+   * @param string $output
    *   What should the result set include (web/email/csv).
    *
    * @return int
@@ -444,7 +444,7 @@ class CRM_Contribute_Selector_Search extends CRM_Core_Selector_Base implements C
    *
    * @param string $action
    *   The action being performed.
-   * @param enum $output
+   * @param string $output
    *   What should the result set include (web/email/csv).
    *
    * @return array
diff --git a/CRM/Core/Config/Defaults.php b/CRM/Core/Config/Defaults.php
index 212ec85ee7..3bfa82a5ee 100644
--- a/CRM/Core/Config/Defaults.php
+++ b/CRM/Core/Config/Defaults.php
@@ -112,13 +112,13 @@ class CRM_Core_Config_Defaults {
 
   /**
    * Set the default values
+   * in an empty db, also called when setting component using GUI
    *
    * @param array $defaults
    *   Associated array of form elements.
-   * @param bool|\boolena $formMode this funtion is called to set default
-   *                           values in an empty db, also called when setting component using GUI
-   *                           this variable is set true for GUI
-   *                           mode (eg: Global setting >> Components)
+   * @param bool $formMode
+   *   this variable is set true for GUI
+   *   mode (eg: Global setting >> Components)
    *
    * @static
    */
@@ -233,10 +233,9 @@ class CRM_Core_Config_Defaults {
       $defaults['customFileUploadDir'] = $customDir;
     }
 
-    /* FIXME: hack to bypass the step for generating defaults for components,
-                  while running upgrade, to avoid any serious non-recoverable error
-                  which might hinder the upgrade process. */
-
+    // FIXME: hack to bypass the step for generating defaults for components,
+    // while running upgrade, to avoid any serious non-recoverable error
+    // which might hinder the upgrade process.
     $args = array();
     if (isset($_GET[$config->userFrameworkURLVar])) {
       $args = explode('/', $_GET[$config->userFrameworkURLVar]);
diff --git a/CRM/Core/Permission.php b/CRM/Core/Permission.php
index 0218a5bc06..2fbb94e9cd 100644
--- a/CRM/Core/Permission.php
+++ b/CRM/Core/Permission.php
@@ -196,7 +196,8 @@ class CRM_Core_Permission {
    *
    * @param string $groupType
    *   Type of group(Access/Mailing).
-   * @param bool|\boolen $excludeHidden exclude hidden groups.
+   * @param bool $excludeHidden
+   *   exclude hidden groups.
    *
    * @static
    *
diff --git a/CRM/Core/Permission/Base.php b/CRM/Core/Permission/Base.php
index 515a8992df..5e4f239161 100644
--- a/CRM/Core/Permission/Base.php
+++ b/CRM/Core/Permission/Base.php
@@ -122,7 +122,8 @@ class CRM_Core_Permission_Base {
    *
    * @param string $groupType
    *   Type of group(Access/Mailing).
-   * @param bool|\boolen $excludeHidden exclude hidden groups.
+   * @param bool $excludeHidden
+   *   exclude hidden groups.
    *
    *
    * @return array
diff --git a/CRM/Core/Selector/API.php b/CRM/Core/Selector/API.php
index 0d48abc5f5..b4bb661cf4 100644
--- a/CRM/Core/Selector/API.php
+++ b/CRM/Core/Selector/API.php
@@ -74,7 +74,7 @@ interface CRM_Core_Selector_API {
    *
    * @param string $action
    *   The action being performed.
-   * @param enum $type
+   * @param string $type
    *   What should the result set include (web/email/csv).
    *
    * @return array
@@ -95,7 +95,7 @@ interface CRM_Core_Selector_API {
   /**
    * Returns all the rows in the given offset and rowCount
    *
-   * @param enum $action
+   * @param string $action
    *   The action being performed.
    * @param int $offset
    *   The row number to start from.
@@ -103,7 +103,7 @@ interface CRM_Core_Selector_API {
    *   The number of rows to return.
    * @param string $sort
    *   The sql string that describes the sort order.
-   * @param enum $type
+   * @param string $type
    *   What should the result set include (web/email/csv).
    *
    * @return int
diff --git a/CRM/Event/Selector/Search.php b/CRM/Event/Selector/Search.php
index c5ffb4b783..0f05141ec3 100644
--- a/CRM/Event/Selector/Search.php
+++ b/CRM/Event/Selector/Search.php
@@ -295,7 +295,7 @@ class CRM_Event_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co
   /**
    * Returns all the rows in the given offset and rowCount
    *
-   * @param enum $action
+   * @param string $action
    *   The action being performed.
    * @param int $offset
    *   The row number to start from.
@@ -303,7 +303,7 @@ class CRM_Event_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co
    *   The number of rows to return.
    * @param string $sort
    *   The sql string that describes the sort order.
-   * @param enum $output
+   * @param string $output
    *   What should the result set include (web/email/csv).
    *
    * @return array
@@ -444,7 +444,7 @@ class CRM_Event_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co
    *
    * @param string $action
    *   The action being performed.
-   * @param enum $output
+   * @param string $output
    *   What should the result set include (web/email/csv).
    *
    * @return array
diff --git a/CRM/Grant/Selector/Search.php b/CRM/Grant/Selector/Search.php
index 3bd0595360..234e81c688 100644
--- a/CRM/Grant/Selector/Search.php
+++ b/CRM/Grant/Selector/Search.php
@@ -260,7 +260,7 @@ class CRM_Grant_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co
   /**
    * Returns all the rows in the given offset and rowCount     *
    *
-   * @param enum $action
+   * @param string $action
    *   The action being performed.
    * @param int $offset
    *   The row number to start from.
@@ -268,7 +268,7 @@ class CRM_Grant_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co
    *   The number of rows to return.
    * @param string $sort
    *   The sql string that describes the sort order.
-   * @param enum $output
+   * @param string $output
    *   What should the result set include (web/email/csv).
    *
    * @return int
@@ -348,7 +348,7 @@ class CRM_Grant_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co
    *
    * @param string $action
    *   The action being performed.
-   * @param enum $output
+   * @param string $output
    *   What should the result set include (web/email/csv).
    *
    * @return array
diff --git a/CRM/Mailing/Selector/Browse.php b/CRM/Mailing/Selector/Browse.php
index c5a9b3a707..6bf6d31990 100644
--- a/CRM/Mailing/Selector/Browse.php
+++ b/CRM/Mailing/Selector/Browse.php
@@ -95,7 +95,7 @@ class CRM_Mailing_Selector_Browse extends CRM_Core_Selector_Base implements CRM_
    *
    * @param string $action
    *   The action being performed.
-   * @param enum $output
+   * @param string $output
    *   What should the result set include (web/email/csv).
    *
    * @return array
@@ -211,7 +211,7 @@ LEFT JOIN  civicrm_contact scheduledContact ON ( $mailing.scheduled_id = schedul
   /**
    * Returns all the rows in the given offset and rowCount
    *
-   * @param enum $action
+   * @param string $action
    *   The action being performed.
    * @param int $offset
    *   The row number to start from.
@@ -219,7 +219,7 @@ LEFT JOIN  civicrm_contact scheduledContact ON ( $mailing.scheduled_id = schedul
    *   The number of rows to return.
    * @param string $sort
    *   The sql string that describes the sort order.
-   * @param enum $output
+   * @param string $output
    *   What should the result set include (web/email/csv).
    *
    * @return int
diff --git a/CRM/Mailing/Selector/Event.php b/CRM/Mailing/Selector/Event.php
index e63925d0f6..c28b955e54 100644
--- a/CRM/Mailing/Selector/Event.php
+++ b/CRM/Mailing/Selector/Event.php
@@ -136,7 +136,7 @@ class CRM_Mailing_Selector_Event extends CRM_Core_Selector_Base implements CRM_C
    *
    * @param string $action
    *   The action being performed.
-   * @param enum $output
+   * @param string $output
    *   What should the result set include (web/email/csv).
    *
    * @return array
@@ -334,7 +334,7 @@ class CRM_Mailing_Selector_Event extends CRM_Core_Selector_Base implements CRM_C
   /**
    * Returns all the rows in the given offset and rowCount
    *
-   * @param enum $action
+   * @param string $action
    *   The action being performed.
    * @param int $offset
    *   The row number to start from.
@@ -342,7 +342,7 @@ class CRM_Mailing_Selector_Event extends CRM_Core_Selector_Base implements CRM_C
    *   The number of rows to return.
    * @param string $sort
    *   The sql string that describes the sort order.
-   * @param enum $output
+   * @param string $output
    *   What should the result set include (web/email/csv).
    *
    * @return int
diff --git a/CRM/Mailing/Selector/Search.php b/CRM/Mailing/Selector/Search.php
index 14c6eb8574..7df1476831 100644
--- a/CRM/Mailing/Selector/Search.php
+++ b/CRM/Mailing/Selector/Search.php
@@ -262,7 +262,7 @@ class CRM_Mailing_Selector_Search extends CRM_Core_Selector_Base implements CRM_
   /**
    * Returns all the rows in the given offset and rowCount
    *
-   * @param enum $action
+   * @param string $action
    *   The action being performed.
    * @param int $offset
    *   The row number to start from.
@@ -270,7 +270,7 @@ class CRM_Mailing_Selector_Search extends CRM_Core_Selector_Base implements CRM_
    *   The number of rows to return.
    * @param string $sort
    *   The sql string that describes the sort order.
-   * @param enum $output
+   * @param string $output
    *   What should the result set include (web/email/csv).
    *
    * @return int
@@ -344,7 +344,7 @@ class CRM_Mailing_Selector_Search extends CRM_Core_Selector_Base implements CRM_
    *
    * @param string $action
    *   The action being performed.
-   * @param enum $output
+   * @param string $output
    *   What should the result set include (web/email/csv).
    *
    * @return array
diff --git a/CRM/Member/Selector/Search.php b/CRM/Member/Selector/Search.php
index 063d12eefe..03daae4bcb 100644
--- a/CRM/Member/Selector/Search.php
+++ b/CRM/Member/Selector/Search.php
@@ -312,7 +312,7 @@ class CRM_Member_Selector_Search extends CRM_Core_Selector_Base implements CRM_C
   /**
    * Returns all the rows in the given offset and rowCount
    *
-   * @param enum $action
+   * @param string $action
    *   The action being performed.
    * @param int $offset
    *   The row number to start from.
@@ -320,7 +320,7 @@ class CRM_Member_Selector_Search extends CRM_Core_Selector_Base implements CRM_C
    *   The number of rows to return.
    * @param string $sort
    *   The sql string that describes the sort order.
-   * @param enum $output
+   * @param string $output
    *   What should the result set include (web/email/csv).
    *
    * @return int
@@ -467,7 +467,7 @@ class CRM_Member_Selector_Search extends CRM_Core_Selector_Base implements CRM_C
    *
    * @param string $action
    *   The action being performed.
-   * @param enum $output
+   * @param string $output
    *   What should the result set include (web/email/csv).
    *
    * @return array
diff --git a/CRM/Pledge/Selector/Search.php b/CRM/Pledge/Selector/Search.php
index 7fe1428f1b..133d2c260e 100644
--- a/CRM/Pledge/Selector/Search.php
+++ b/CRM/Pledge/Selector/Search.php
@@ -270,7 +270,7 @@ class CRM_Pledge_Selector_Search extends CRM_Core_Selector_Base {
   /**
    * Returns all the rows in the given offset and rowCount
    *
-   * @param enum $action
+   * @param string $action
    *   The action being performed.
    * @param int $offset
    *   The row number to start from.
@@ -278,7 +278,7 @@ class CRM_Pledge_Selector_Search extends CRM_Core_Selector_Base {
    *   The number of rows to return.
    * @param string $sort
    *   The sql string that describes the sort order.
-   * @param enum $output
+   * @param string $output
    *   What should the result set include (web/email/csv).
    *
    * @return int
@@ -382,7 +382,7 @@ class CRM_Pledge_Selector_Search extends CRM_Core_Selector_Base {
    *
    * @param string $action
    *   The action being performed.
-   * @param enum $output
+   * @param string $output
    *   What should the result set include (web/email/csv).
    *
    * @return array
diff --git a/CRM/Profile/Selector/Listings.php b/CRM/Profile/Selector/Listings.php
index f0855eb91b..e46149dd3c 100644
--- a/CRM/Profile/Selector/Listings.php
+++ b/CRM/Profile/Selector/Listings.php
@@ -293,7 +293,7 @@ class CRM_Profile_Selector_Listings extends CRM_Core_Selector_Base implements CR
    *
    * @param string $action
    *   The action being performed.
-   * @param enum $output
+   * @param string $output
    *   What should the result set include (web/email/csv).
    *
    * @return array
@@ -432,7 +432,7 @@ class CRM_Profile_Selector_Listings extends CRM_Core_Selector_Base implements CR
   /**
    * Returns all the rows in the given offset and rowCount
    *
-   * @param enum $action
+   * @param string $action
    *   The action being performed.
    * @param int $offset
    *   The row number to start from.
@@ -440,7 +440,7 @@ class CRM_Profile_Selector_Listings extends CRM_Core_Selector_Base implements CR
    *   The number of rows to return.
    * @param string $sort
    *   The sql string that describes the sort order.
-   * @param enum $output
+   * @param string $output
    *   What should the result set include (web/email/csv).
    *
    * @return int