class CRM_Contribute_Form_Contribution_Confirm extends CRM_Contribute_Form_ContributionBase {
/**
- * the id of the contact associated with this contribution
+ * The id of the contact associated with this contribution
*
* @var int
* @public
*
* @param array $params
* @param integer $contactID
- * @param $financialTypeID
+ * @param int $financialTypeID
* @param $online
- * @param $contributionPageId
+ * @param int $contributionPageId
* @param $nonDeductibleAmount
- * @param $campaignId
- *
+ * @param int $campaignId
* @param $isMonetary
- *
* @param $pending
* @param $paymentProcessorOutcome
* @param $receiptDate
- *
- * @param $recurringContributionID
+ * @param int $recurringContributionID
* @param $isTest
+ * @param int $addressID
+ * @param int $softCreditToID
+ * @param array $lineItems
*
- * @param $addressID
- *
- * @param $softCreditToID
- *
- * @param $lineItems
- *
- * @internal param $financialType
* @return array
*/
public static function getContributionParams($params, $contactID, $financialTypeID, $online, $contributionPageId, $nonDeductibleAmount, $campaignId, $isMonetary, $pending,
}
/**
- * Function to set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
}
/**
- * Function to actually build the form
+ * Build the form object
*
* @return void
* @access public
}
/**
- * overwrite action, since we are only showing elements in frozen mode
+ * Overwrite action, since we are only showing elements in frozen mode
* no help display needed
*
* @return int
}
/**
- * This function sets the default values for the form. Note that in edit/view mode
+ * Set default values for the form. Note that in edit/view mode
* the default values are retrieved from the database
*
* @access public
* Pledges are not relevant to the membership code so that portion will not go onto the membership form.
*
* Comments from previous refactor indicate doubt as to what was going on
- * @param $contributionTypeId
+ * @param int $contributionTypeId
*
* @return null|string
*/
/**
* Process the form
*
- * @param $premiumParams
+ * @param array $premiumParams
* @param $contribution
*
* @return void
/**
* Process the contribution
*
- * @param $form
+ * @param CRM_Core_Form $form
* @param array $params
* @param array $result
* @param integer $contactID
}
/**
- * Function to add on behalf of organization and it's location
+ * Add on behalf of organization and it's location
*
* @param $behalfOrganization array array of organization info
* @param $contactID int individual contact id. One
* who is doing the process of signup / contribution.
*
* @param $values array form values array
- * @param $params
+ * @param array $params
* @param null $fields
*
* @return void
* Function used to se pcp related defaults / params
* This is used by contribution and also event pcps
*
- * @param object $page form object
+ * @param CRM_Core_Form $page form object
* @param array $params associated array
*
* @return array
* And under certain circumstances sets
* $this->_params['amount'] = null;
*
- * @param $priceSetID
+ * @param int $priceSetID
*
- * @internal param $isQuickConfig
- * @internal param $priceField
*/
public function setFormAmountFields($priceSetID) {
$isQuickConfig = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', $this->_params['priceSetId'], 'is_quick_config');
/**
* Helper function for static submit function - set relevant params - help us to build up an array that we can pass in
- * @param $id
+ * @param int $id
* @param array $params
*
* @return array