fix a few comment blocks, minor tidy ups

diff --git a/CRM/Contribute/Form/AbstractEditPayment.php b/CRM/Contribute/Form/AbstractEditPayment.php
index e81dc5047941e9e222f11cead4032f4b2499bf83..21dee704ab3588a717a253fe5d2f38bd3f93c1df 100644 (file)
--- a/CRM/Contribute/Form/AbstractEditPayment.php
+++ b/CRM/Contribute/Form/AbstractEditPayment.php
@@ -246,6 +246,12 @@ WHERE  contribution_id = {$id}
 
   /**
    * This function process contribution related objects.
+   *
+   * @param integer $contributionId
+   * @param integer $statusId
+   * @param integer|null $previousStatusId
+   *
+   * @return null|string
    */
   protected function updateRelatedComponent($contributionId, $statusId, $previousStatusId = NULL) {
     $statusMsg = NULL;
@@ -406,6 +412,7 @@ LEFT JOIN  civicrm_contribution on (civicrm_contribution.contact_id = civicrm_co
     );
 
     // this required to show billing block
+    // @todo remove this assignment the billing block is now designed to be always included but will not show fieldsets unless those sets of fields are assigned
     $this->assign_by_ref('paymentProcessor', $paymentProcessor);
   }
 

diff --git a/CRM/Contribute/Form/Contribution/Confirm.php b/CRM/Contribute/Form/Contribution/Confirm.php
index 1b6648408934aa068b8944809e38b46e01d3c05c..4f19a937534b2df009e63795ed2f16485be4c052 100644 (file)
--- a/CRM/Contribute/Form/Contribution/Confirm.php
+++ b/CRM/Contribute/Form/Contribution/Confirm.php
@@ -1486,6 +1486,13 @@ class CRM_Contribute_Form_Contribution_Confirm extends CRM_Contribute_Form_Contr
   /**
    * Create the recurring contribution record
    *
+   * @param CRM_Core_Form $form
+   * @param array $params
+   * @param integer $contactID
+   * @param string $contributionType
+   * @param bool $online
+   *
+   * @return mixed
    */
   static function processRecurringContribution(&$form, &$params, $contactID, $contributionType, $online = TRUE) {
     // return if this page is not set for recurring
@@ -1870,6 +1877,11 @@ class CRM_Contribute_Form_Contribution_Confirm extends CRM_Contribute_Form_Contr
     }
   }
 
+  /**
+   * @param array $params
+   *
+   * @throws CiviCRM_API3_Exception
+   */
   static function submit($params) {
     $form = new CRM_Contribute_Form_Contribution_Confirm();
     $form->_id = $params['id'];

diff --git a/CRM/Contribute/Form/Contribution/Main.php b/CRM/Contribute/Form/Contribution/Main.php
index a8df7954ce5779d587002418189ce2844ab65175..e92d239e77de88567efaca35f7086ae2d0e8a1b1 100644 (file)
--- a/CRM/Contribute/Form/Contribution/Main.php
+++ b/CRM/Contribute/Form/Contribution/Main.php
@@ -304,9 +304,7 @@ class CRM_Contribute_Form_Contribution_Main extends CRM_Contribute_Form_Contribu
 
     // to process Custom data that are appended to URL
     $getDefaults = CRM_Core_BAO_CustomGroup::extractGetParams($this, "'Contact', 'Individual', 'Contribution'");
-    if (!empty($getDefaults)) {
-      $this->_defaults = array_merge($this->_defaults, $getDefaults);
-    }
+    $this->_defaults = array_merge($this->_defaults, $getDefaults);
 
     $config = CRM_Core_Config::singleton();
     // set default country from config if no country set
@@ -648,6 +646,8 @@ class CRM_Contribute_Form_Contribution_Main extends CRM_Contribute_Form_Contribu
    * build elements to collect information for recurring contributions
    *
    * @access public
+   *
+   * @param CRM_Core_Form $form
    */
   public static function buildRecur(&$form) {
     $attributes = CRM_Core_DAO::getAttribute('CRM_Contribute_DAO_ContributionRecur');
@@ -1380,6 +1380,8 @@ class CRM_Contribute_Form_Contribution_Main extends CRM_Contribute_Form_Contribu
   /**
    * Handle Payment Processor switching
    * For contribution and event registration forms
+   * @param CRM_Core_Form $form
+   * @param bool $noFees
    */
   static function preProcessPaymentOptions(&$form, $noFees = FALSE) {
     $form->_snippet = CRM_Utils_Array::value('snippet', $_GET);

diff --git a/CRM/Contribute/Form/ContributionCharts.php b/CRM/Contribute/Form/ContributionCharts.php
index 538ad1e7ffbe5cfe813bdd06d189c294a3529fb5..3d40231bce2a5a42e0d2e4476c625996be1deb73 100644 (file)
--- a/CRM/Contribute/Form/ContributionCharts.php
+++ b/CRM/Contribute/Form/ContributionCharts.php
@@ -202,7 +202,7 @@ class CRM_Contribute_Form_ContributionCharts extends CRM_Core_Form {
         elseif ($chartKey == 'by_year') {
           if (!empty($config->fiscalYearStart) && ($config->fiscalYearStart['M'] != 1 || $config->fiscalYearStart['d'] != 1)) {
             $startDate = date('Ymd', mktime(0, 0, 0, $config->fiscalYearStart['M'], $config->fiscalYearStart['d'], substr($index,0,4)));
-            $endDate   = date('Ymd', mktime(0, 0, 0, $config->fiscalYearStart['M'], $config->fiscalYearStart['d'], substr($index,0,4)+1));
+            $endDate   = date('Ymd', mktime(0, 0, 0, $config->fiscalYearStart['M'], $config->fiscalYearStart['d'], (substr($index,0,4)) + 1));
           }
           else {
             $startDate = CRM_Utils_Date::format(array('Y' => substr($index,0,4)));

diff --git a/CRM/Contribute/Form/ContributionPage.php b/CRM/Contribute/Form/ContributionPage.php
index 0b3fdd6329f9e4d55b654d569b5f4bd3e0c9cf30..ee47a51890adbef3db15aba809396c9a2a5adf7e 100644 (file)
--- a/CRM/Contribute/Form/ContributionPage.php
+++ b/CRM/Contribute/Form/ContributionPage.php
@@ -245,7 +245,7 @@ class CRM_Contribute_Form_ContributionPage extends CRM_Core_Form {
    *
    * @access public
    *
-   * @return void
+   * @return array defaults
    */
   function setDefaultValues() {
     //some child classes calling setdefaults directly w/o preprocess.

diff --git a/CRM/Contribute/Form/ContributionPage/Amount.php b/CRM/Contribute/Form/ContributionPage/Amount.php
index 3a403f4be07b8431e4740d86894804031ae1b796..366004c917b737b872be52ff34169b49ac2079e1 100644 (file)
--- a/CRM/Contribute/Form/ContributionPage/Amount.php
+++ b/CRM/Contribute/Form/ContributionPage/Amount.php
@@ -190,7 +190,7 @@ SELECT id
    *
    * @access public
    *
-   * @return void
+   * @return array
    */
   function setDefaultValues() {
     $defaults = parent::setDefaultValues();
@@ -361,7 +361,7 @@ SELECT id
       }
 
       // If Contribution amount section is enabled, then
-      // Allow other amounts must be enabeld OR the Fixed Contribution
+      // Allow other amounts must be enabled OR the Fixed Contribution
       // Contribution options must contain at least one set of values.
       if (!empty($fields['amount_block_is_active'])) {
         if (empty($fields['is_allow_other_amount']) &&

diff --git a/CRM/Contribute/Form/SoftCredit.php b/CRM/Contribute/Form/SoftCredit.php
index b8145f7898ea4cbb1cb80bfb88c582052f73e04b..962f613e244969c3c914513397a414793a0e2e08 100644 (file)
--- a/CRM/Contribute/Form/SoftCredit.php
+++ b/CRM/Contribute/Form/SoftCredit.php
@@ -159,6 +159,9 @@ class CRM_Contribute_Form_SoftCredit {
 
   /**
    * Function used to set defaults for soft credit block
+   *
+   * @param $defaults
+   * @param $form
    */
   static function setDefaultValues(&$defaults, &$form) {
     //Used to hide/unhide PCP and/or Soft-credit Panes

diff --git a/CRM/Contribute/Form/Task/Invoice.php b/CRM/Contribute/Form/Task/Invoice.php
index e0a413841f99008072549905d4e32c77036d4af7..43cbaa9f28adfc39fc522849a56acc24c53c7828 100644 (file)
--- a/CRM/Contribute/Form/Task/Invoice.php
+++ b/CRM/Contribute/Form/Task/Invoice.php
@@ -655,6 +655,7 @@ class CRM_Contribute_Form_Task_Invoice extends CRM_Contribute_Form_Task {
    *
    * return $fileName of file which is in pdf format
    *
+   * @return string
    */
   static public function putFile($html) {
     require_once("packages/dompdf/dompdf_config.inc.php");

diff --git a/CRM/Core/BAO/CustomGroup.php b/CRM/Core/BAO/CustomGroup.php
index a3c4b4995e2ae8153a43670b40a4bbc06eaead19..3ebde84affc281436122054c9cf008b197e9090b 100644 (file)
--- a/CRM/Core/BAO/CustomGroup.php
+++ b/CRM/Core/BAO/CustomGroup.php
@@ -1531,14 +1531,13 @@ ORDER BY civicrm_custom_group.weight,
    * @param CRM_Core_Form $form the form object
    * @param string        $type the type of custom group we are using
    *
-   * @return void
+   * @return array
    * @access public
    * @static
    */
   static function extractGetParams(&$form, $type) {
-    // if not GET params return
     if (empty($_GET)) {
-      return;
+      return array();
     }
 
     $groupTree   = CRM_Core_BAO_CustomGroup::getTree($type, $form);

diff --git a/CRM/Core/BAO/Setting.php b/CRM/Core/BAO/Setting.php
index 45ecdf2ff5d5df55a572db73d3ccbb166075521a..dd8fac106981da44d9ffa0189101062f50d7908e 100644 (file)
--- a/CRM/Core/BAO/Setting.php
+++ b/CRM/Core/BAO/Setting.php
@@ -205,7 +205,7 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting {
    *
    * @param null $domainID
    *
-   * @return object The data if present in the setting table, else null
+   * @return mixed The data if present in the setting table, else null
    * @static
    * @access public
    */

diff --git a/CRM/Utils/Request.php b/CRM/Utils/Request.php
index eea57653e1d1168c4175d6cb529482e3a8780515..216cf9c324cc98aa10eb256f1c5baa09c5649b2c 100644 (file)
--- a/CRM/Utils/Request.php
+++ b/CRM/Utils/Request.php
@@ -59,7 +59,7 @@ class CRM_Utils_Request {
    *
    * @param string $name name of the variable to be retrieved
    * @param string $type  type of the variable (see CRM_Utils_Type for details)
-   * @param stdClass $store session scope where variable is stored
+   * @param object $store session scope where variable is stored
    * @param bool $abort is this variable required
    * @param mixed $default default value of the variable if not present
    * @param string $method where should we look for the variable