* contribution object. the params array could contain additional unused name/value
* pairs
*
- * @param array $params (reference ) an assoc array of name/value pairs
- * @param array $ids the array that holds all the db ids
+ * @param array $params
+ * (reference ) an assoc array of name/value pairs.
+ * @param array $ids
+ * The array that holds all the db ids.
*
* @return CRM_Contribute_BAO_Contribution object
* @static
* Given the list of params in the params array, fetch the object
* and store the values in the values array
*
- * @param array $params input parameters to find object
- * @param array $values output values of the object
- * @param array $ids the array that holds all the db ids
+ * @param array $params
+ * Input parameters to find object.
+ * @param array $values
+ * Output values of the object.
+ * @param array $ids
+ * The array that holds all the db ids.
*
* @return CRM_Contribute_BAO_Contribution|null the found object or null
* @static
/**
* Takes an associative array and creates a contribution object
*
- * @param array $params (reference ) an assoc array of name/value pairs
- * @param array $ids the array that holds all the db ids
+ * @param array $params
+ * (reference ) an assoc array of name/value pairs.
+ * @param array $ids
+ * The array that holds all the db ids.
*
* @return CRM_Contribute_BAO_Contribution object
* @static
/**
* Get the values for pseudoconstants for name->value and reverse.
*
- * @param array $defaults (reference) the default values, some of which need to be resolved.
- * @param boolean $reverse true if we want to resolve the values in the reverse direction (value -> name)
+ * @param array $defaults
+ * (reference) the default values, some of which need to be resolved.
+ * @param bool $reverse
+ * True if we want to resolve the values in the reverse direction (value -> name).
*
* @return void
* @static
* full featured over a period of time. This is the inverse function of
* create. It also stores all the retrieved values in the default array
*
- * @param array $params (reference ) an assoc array of name/value pairs
- * @param array $defaults (reference ) an assoc array to hold the name / value pairs
+ * @param array $params
+ * (reference ) an assoc array of name/value pairs.
+ * @param array $defaults
+ * (reference ) an assoc array to hold the name / value pairs.
* in a hierarchical manner
- * @param array $ids (reference) the array that holds all the db ids
+ * @param array $ids
+ * (reference) the array that holds all the db ids.
*
* @return CRM_Contribute_BAO_Contribution object
* @static
/**
* Check if there is a contribution with the same trxn_id or invoice_id
*
- * @param array $input an assoc array of name/value pairs
- * @param array $duplicates (reference ) store ids of duplicate contribs
+ * @param array $input
+ * An assoc array of name/value pairs.
+ * @param array $duplicates
+ * (reference ) store ids of duplicate contribs.
*
* @param int $id
*
* contribution_product object. the params array could contain additional unused name/value
* pairs
*
- * @param array $params (reference ) an assoc array of name/value pairs
+ * @param array $params
+ * (reference ) an assoc array of name/value pairs.
*
* @return CRM_Contribute_BAO_ContributionProduct object
* @static
* For now we only allow custom contribution fields to be in
* profile
*
- * @param boolean $addExtraFields true if special fields needs to be added
+ * @param bool $addExtraFields
+ * True if special fields needs to be added.
*
* @return array the list of contribution fields
* @static
/**
* Get list of contribution In Honor of contact Ids
*
- * @param int $honorId In Honor of Contact ID
+ * @param int $honorId
+ * In Honor of Contact ID.
*
* @return return the list of contribution fields
*
/**
* Get the sort name of a contact for a particular contribution
*
- * @param int $id id of the contribution
+ * @param int $id
+ * Id of the contribution.
*
* @return null|string sort name of the contact if found
* @static
* Check if there is a contribution with the params passed in.
* Used for trxn_id,invoice_id and contribution_id
*
- * @param array $params an assoc array of name/value pairs
+ * @param array $params
+ * An assoc array of name/value pairs.
*
* @return array contribution id if success else NULL
* static
/**
* Get the contribution details for component export
*
- * @param int $exportMode export mode
- * @param string $componentIds component ids
+ * @param int $exportMode
+ * Export mode.
+ * @param string $componentIds
+ * Component ids.
*
* @return array associated array
*
/**
* Create address associated with contribution record.
*
- * @param array $params an associated array
+ * @param array $params
+ * An associated array.
* @param int $billingLocationTypeID
*
* @return address id
* This function check online pending contribution associated w/
* Online Event Registration or Online Membership signup.
*
- * @param int $componentId participant/membership id.
- * @param string $componentName Event/Membership.
+ * @param int $componentId
+ * Participant/membership id.
+ * @param string $componentName
+ * Event/Membership.
*
* @return $contributionId pending contribution id.
* @static
/**
* Get individual id for onbehalf contribution
*
- * @param int $contributionId contribution id
- * @param int $contributorId contributor id
+ * @param int $contributionId
+ * Contribution id.
+ * @param int $contributorId
+ * Contributor id.
*
* @return array $ids containing organization id and individual id
*/
* In the first instance we are just moving functionality from BASEIpn -
* see http://issues.civicrm.org/jira/browse/CRM-9996
*
- * @param array $input Input as delivered from Payment Processor
- * @param array $ids Ids as Loaded by Payment Processor
- * @param boolean $required Is Payment processor / contribution page required
- * @param boolean $loadAll - load all related objects - even where id not passed in? (allows API to call this)
+ * @param array $input
+ * Input as delivered from Payment Processor.
+ * @param array $ids
+ * Ids as Loaded by Payment Processor.
+ * @param bool $required
+ * Is Payment processor / contribution page required.
+ * @param bool $loadAll
+ * Load all related objects - even where id not passed in? (allows API to call this).
* Note that the unit test for the BaseIPN class tests this function
*/
/**
/*
* Create array of message information - ie. return html version, txt version, to field
*
- * @param array $input incoming information
+ * @param array $input
+ * Incoming information.
* - is_recur - should this be treated as recurring (not sure why you wouldn't
* just check presence of recur object but maintaining legacy approach
* to be careful)
- * @param array $ids IDs of related objects
- * @param array $values any values that may have already been compiled by calling process
+ * @param array $ids
+ * IDs of related objects.
+ * @param array $values
+ * Any values that may have already been compiled by calling process.
* This is augmented by values 'gathered' by gatherMessageValues
- * @param bool $returnMessageText distinguishes between whether to send message or return
+ * @param bool $returnMessageText
+ * Distinguishes between whether to send message or return.
* message text. We are working towards this function ALWAYS returning message text & calling
* function doing emails / pdfs with it
* @return array $messageArray - messages
* as part of CRM-9996 refactoring as a step towards simplifying the composeMessage function
* Values related to the contribution in question are gathered
*
- * @param array $input input into function (probably from payment processor)
- * @param array $ids the set of ids related to the inpurt
+ * @param array $input
+ * Input into function (probably from payment processor).
+ * @param array $ids
+ * The set of ids related to the inpurt.
*
* @return array $values
*
*
* @param $values
* @param $input
- * @param $template CRM_Core_SMARTY
+ * @param $template
+ * CRM_Core_SMARTY.
* @param bool $recur
* @param bool $returnMessageText
*
* Check whether payment processor supports
* cancellation of contribution subscription
*
- * @param int $contributionId contribution id
+ * @param int $contributionId
+ * Contribution id.
*
* @param bool $isNotCancelled
*
/**
* Check whether subscription is already cancelled
*
- * @param int $contributionId contribution id
+ * @param int $contributionId
+ * Contribution id.
*
* @return string $status contribution status
* @static
/**
* Create all financial accounts entry
*
- * @param array $params contribution object, line item array and params for trxn
+ * @param array $params
+ * Contribution object, line item array and params for trxn.
*
*
* @param array $financialTrxnValues
/**
* Update all financial accounts entry
*
- * @param array $params contribution object, line item array and params for trxn
+ * @param array $params
+ * Contribution object, line item array and params for trxn.
*
- * @param string $context update scenarios
+ * @param string $context
+ * Update scenarios.
*
* @param null $skipTrxn
*
/**
* Check status validation on update of a contribution
*
- * @param array $values previous form values before submit
+ * @param array $values
+ * Previous form values before submit.
*
- * @param array $fields the input form values
+ * @param array $fields
+ * The input form values.
*
- * @param array $errors list of errors
+ * @param array $errors
+ * List of errors.
*
* @return bool
* @static
*
* CRM-12155
*
- * @param integer $contactId contact id
+ * @param int $contactId
+ * Contact id.
*
* @static
*/
* Get options for a given contribution field.
* @see CRM_Core_DAO::buildOptions
*
- * @param String $fieldName
- * @param String $context : @see CRM_Core_DAO::buildOptionsContext
- * @param Array $props : whatever is known about this dao object
+ * @param string $fieldName
+ * @param string $context
+ * : @see CRM_Core_DAO::buildOptionsContext.
+ * @param array $props
+ * : whatever is known about this dao object.
*
* @return Array|bool
*/
*
* CRM-13231
*
- * @param integer $financialTypeId Financial Type id
+ * @param int $financialTypeId
+ * Financial Type id.
*
* @param string $relationName
*
/*
* Function to record additional payment for partial and refund contributions
*
- * @param integer $contributionId : is the invoice contribution id (got created after processing participant payment)
- * @param array $trxnData : to take user provided input of transaction details.
- * @param string $paymentType 'owed' for purpose of recording partial payments, 'refund' for purpose of recording refund payments
+ * @param int $contributionId
+ * : is the invoice contribution id (got created after processing participant payment).
+ * @param array $trxnData
+ * : to take user provided input of transaction details.
+ * @param string $paymentType
+ * 'owed' for purpose of recording partial payments, 'refund' for purpose of recording refund payments.
*/
/**
* @param int $contributionId
/**
* Process payment after confirmation
*
- * @param CRM_Core_Form $form form object
- * @param array $paymentParams array with payment related key
+ * @param CRM_Core_Form $form
+ * Form object.
+ * @param array $paymentParams
+ * Array with payment related key.
* value pairs
- * @param array $premiumParams array with premium related key
+ * @param array $premiumParams
+ * Array with premium related key.
* value pairs
- * @param int $contactID contact id
- * @param int $contributionTypeId financial type id
+ * @param int $contactID
+ * Contact id.
+ * @param int $contributionTypeId
+ * Financial type id.
* @param int|string $component component id
- * @param array $fieldTypes presumably relates to custom field types - used when building data for sendMail
+ * @param array $fieldTypes
+ * Presumably relates to custom field types - used when building data for sendMail.
* @param $isTest
* @param $isPayLater
*
* Get the contribution details by month
* of the year
*
- * @param int $param year
+ * @param int $param
+ * Year.
*
* @return array associated array
*
/**
* Calculate the tax amount based on given tax rate.
*
- * @param float $amount amount of field.
- * @param float $taxRate tax rate of selected financial account for field.
+ * @param float $amount
+ * Amount of field.
+ * @param float $taxRate
+ * Tax rate of selected financial account for field.
*
* @return array array of tax amount
*
/**
* Takes an associative array and creates a contribution page object
*
- * @param array $params (reference ) an assoc array of name/value pairs
+ * @param array $params
+ * (reference ) an assoc array of name/value pairs.
*
* @return CRM_Contribute_DAO_ContributionPage object
* @static
/**
* Update the is_active flag in the db
*
- * @param int $id id of the database record
- * @param boolean $is_active value we want to set the is_active field
+ * @param int $id
+ * Id of the database record.
+ * @param bool $is_active
+ * Value we want to set the is_active field.
*
* @return Object DAO object on success, null otherwise
* @static
/**
* Send the emails
*
- * @param int $contactID contact id
- * @param array $values associated array of fields
- * @param boolean $isTest if in test mode
- * @param boolean $returnMessageText return the message text instead of sending the mail
+ * @param int $contactID
+ * Contact id.
+ * @param array $values
+ * Associated array of fields.
+ * @param bool $isTest
+ * If in test mode.
+ * @param bool $returnMessageText
+ * Return the message text instead of sending the mail.
*
* @param null $fieldTypes
*
/**
* Send the emails for Recurring Contribution Notication
*
- * @param string $type txnType
- * @param int $contactID contact id for contributor
- * @param int $pageID contribution page id
- * @param object $recur object of recurring contribution table
+ * @param string $type
+ * TxnType.
+ * @param int $contactID
+ * Contact id for contributor.
+ * @param int $pageID
+ * Contribution page id.
+ * @param object $recur
+ * Object of recurring contribution table.
* @param bool|object $autoRenewMembership is it a auto renew membership.
*
* @return void
/**
* Add the custom fields for contribution page (ie profile)
*
- * @param int $gid uf group id
+ * @param int $gid
+ * Uf group id.
* @param string $name
- * @param int $cid contact id
+ * @param int $cid
+ * Contact id.
* @param $template
- * @param array $params params to build component whereclause
+ * @param array $params
+ * Params to build component whereclause.
*
* @param null $fieldTypes
*
* This function is to make a copy of a contribution page, including
* all the blocks in the page
*
- * @param int $id the contribution page id to copy
+ * @param int $id
+ * The contribution page id to copy.
*
* @return the copy object
* @static
* Check if contribution page contains payment
* processor that supports recurring payment
*
- * @param int $contributionPageId Contribution Page Id
+ * @param int $contributionPageId
+ * Contribution Page Id.
*
* @return boolean true if payment processor supports recurring
* else false
* Get options for a given field.
* @see CRM_Core_DAO::buildOptions
*
- * @param String $fieldName
- * @param String $context: @see CRM_Core_DAO::buildOptionsContext
- * @param Array $props: whatever is known about this dao object
+ * @param string $fieldName
+ * @param string $context: @see CRM_Core_DAO::buildOptionsContext
+ * @param array $props: whatever is known about this dao object
*
* @return array|bool
*/
/**
* Get or Set multilingually affected honor params for processing module_data or setting default values.
*
- * @param Array|String $params: Array when we need to format it according to language state or String as a json encode
- * @param Boolean $setDefault: If yes then returns array to used for setting default value afterward
+ * @param array|String $params: Array when we need to format it according to language state or String as a json encode
+ * @param bool $setDefault: If yes then returns array to used for setting default value afterward
*
* @return array|string
*/
/**
* Generate html for pdf in confirmation receipt email attachment
- * @param int $contributionId Contribution Page Id
- * @param int $userID contact id for contributor
+ * @param int $contributionId
+ * Contribution Page Id.
+ * @param int $userID
+ * Contact id for contributor.
* @return array $pdfHtml
*/
public static function addInvoicePdfToEmail($contributionId, $userID) {
/**
* Helper to determine if the page supports separate membership payments
- * @param integer id form id
+ * @param int id form id
*
* @return bool isSeparateMembershipPayment
*/
/**
* Create recurring contribution
*
- * @param array $params (reference ) an assoc array of name/value pairs
+ * @param array $params
+ * (reference ) an assoc array of name/value pairs.
*
* @return object activity contact object
*
* contribution object. the params array could contain additional unused name/value
* pairs
*
- * @param array $params (reference ) an assoc array of name/value pairs
+ * @param array $params
+ * (reference ) an assoc array of name/value pairs.
*
* @return CRM_Contribute_BAO_Contribution object
* @static
/**
* Check if there is a recurring contribution with the same trxn_id or invoice_id
*
- * @param array $params (reference ) an assoc array of name/value pairs
- * @param array $duplicates (reference ) store ids of duplicate contribs
+ * @param array $params
+ * (reference ) an assoc array of name/value pairs.
+ * @param array $duplicates
+ * (reference ) store ids of duplicate contribs.
*
* @return boolean true if duplicate, false otherwise
* static
/**
* Get the number of installment done/completed for each recurring contribution
*
- * @param array $ids (reference ) an array of recurring contribution ids
+ * @param array $ids
+ * (reference ) an array of recurring contribution ids.
*
* @return array $totalCount an array of recurring ids count
* static
/**
* Cancel Recurring contribution.
*
- * @param integer $recurId recur contribution id.
- * @param array $objects an array of objects that is to be cancelled like
+ * @param int $recurId
+ * Recur contribution id.
+ * @param array $objects
+ * An array of objects that is to be cancelled like.
* contribution, membership, event. At least contribution object is a must.
*
* @param array $activityParams
/**
* Get list of recurring contribution of contact Ids
*
- * @param int $contactId Contact ID
+ * @param int $contactId
+ * Contact ID.
*
* @return array list of recurring contribution fields
*
/**
* Add contribution soft credit record
*
- * @param array $params (reference ) an assoc array of name/value pairs
+ * @param array $params
+ * (reference ) an assoc array of name/value pairs.
*
* @return object soft contribution of object that is added
*
/**
* Fetch object based on array of properties
*
- * @param array $params (reference ) an assoc array of name/value pairs
- * @param array $defaults (reference ) an assoc array to hold the flattened values
+ * @param array $params
+ * (reference ) an assoc array of name/value pairs.
+ * @param array $defaults
+ * (reference ) an assoc array to hold the flattened values.
*
* @return CRM_Contribute_BAO_ContributionSoft object
* @static
* Retrieve soft contributions for contribution record.
*
* @param int $contributionID
- * @param boolean $all include PCP data
+ * @param bool $all
+ * Include PCP data.
*
* @return array of soft contribution ids, amounts, and associated contact ids
* @static
/**
* Function to retrieve the list of soft contributions for given contact.
*
- * @param int $contact_id contact id
- * @param int $isTest
- * @param string $filter additional filter criteria, later used in where clause
+ * @param int $contact_id
+ * Contact id.
+ * @param int $isTest
+ * @param string $filter
+ * Additional filter criteria, later used in where clause.
*
* @return array
* @static
/**
* Fetch object based on array of properties
*
- * @param array $params (reference ) an assoc array of name/value pairs
- * @param array $defaults (reference ) an assoc array to hold the flattened values
+ * @param array $params
+ * (reference ) an assoc array of name/value pairs.
+ * @param array $defaults
+ * (reference ) an assoc array to hold the flattened values.
*
* @return CRM_Contribute_BAO_ManagePremium object
* @static
/**
* Update the is_active flag in the db
*
- * @param int $id id of the database record
- * @param boolean $is_active value we want to set the is_active field
+ * @param int $id
+ * Id of the database record.
+ * @param bool $is_active
+ * Value we want to set the is_active field.
*
* @return Object DAO object on sucess, null otherwise
* @static
/**
* add the financial types
*
- * @param array $params reference array contains the values submitted by the form
- * @param array $ids reference array contains the id
+ * @param array $params
+ * Reference array contains the values submitted by the form.
+ * @param array $ids
+ * Reference array contains the id.
*
* @static
*
/**
* Fetch object based on array of properties
*
- * @param array $params (reference ) an assoc array of name/value pairs
- * @param array $defaults (reference ) an assoc array to hold the flattened values
+ * @param array $params
+ * (reference ) an assoc array of name/value pairs.
+ * @param array $defaults
+ * (reference ) an assoc array to hold the flattened values.
*
* @return CRM_Contribute_BAO_ManagePremium object
* @static
/**
* Update the is_active flag in the db
*
- * @param int $id id of the database record
- * @param boolean $is_active value we want to set the is_active field
+ * @param int $id
+ * Id of the database record.
+ * @param bool $is_active
+ * Value we want to set the is_active field.
*
* @return Object DAO object on sucess, null otherwise
* @static
/**
* Add the where for dates
*
- * @param array $values array of query values
- * @param object $query the query object
- * @param string $name query field that is set
- * @param string $field name of field to be set
- * @param string $title title of the field
+ * @param array $values
+ * Array of query values.
+ * @param object $query
+ * The query object.
+ * @param string $name
+ * Query field that is set.
+ * @param string $field
+ * Name of field to be set.
+ * @param string $title
+ * Title of the field.
*
* @return bool
*/
}
/**
- * @param string $type eg 'Contribution'
+ * @param string $type
+ * Eg 'Contribution'.
* @param string $subType
* @param int $entityId
*/
/**
* This function process contribution related objects.
*
- * @param integer $contributionId
- * @param integer $statusId
- * @param integer|null $previousStatusId
+ * @param int $contributionId
+ * @param int $statusId
+ * @param int|null $previousStatusId
*
* @return null|string
*/
* @form object of Contribution form.
*
* @param CRM_Core_Form $form
- * @param array $params (reference ) an assoc array of name/value pairs.
+ * @param array $params
+ * (reference ) an assoc array of name/value pairs.
* @$ccContribution boolen, is it credit card contribution.
* @param bool $ccContribution
*
/**
* Global form rule
*
- * @param array $fields the input form values
- * @param array $files the uploaded files if any
+ * @param array $fields
+ * The input form values.
+ * @param array $files
+ * The uploaded files if any.
* @param $self
*
*
/**
* @param $submittedValues
* @param $config
- * @param $session CRM_Core_Session
+ * @param $session
+ * CRM_Core_Session.
* @param $lineItem
*
* @throws CRM_Core_Exception
* Set the parameters to be passed to contribution create function
*
* @param array $params
- * @param integer $contactID
+ * @param int $contactID
* @param int $financialTypeID
* @param $online
* @param int $contributionPageId
* @param CRM_Core_Form $form
* @param array $params
* @param array $result
- * @param integer $contactID
+ * @param int $contactID
* @param CRM_Financial_DAO_FinancialType $financialType
* @param bool $pending
* @param bool $online
*
* @param CRM_Core_Form $form
* @param array $params
- * @param integer $contactID
+ * @param int $contactID
* @param string $contributionType
* @param bool $online
*
/**
* Add on behalf of organization and it's location
*
- * @param $behalfOrganization array array of organization info
- * @param $contactID int individual contact id. One
+ * @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 $values
+ * Array form values array.
* @param array $params
* @param null $fields
*
* Function used to save pcp / soft credit entry
* This is used by contribution and also event pcps
*
- * @param array $params associated array
- * @param object $contribution contribution object
+ * @param array $params
+ * Associated array.
+ * @param object $contribution
+ * Contribution object.
*
* @static
*/
* Function used to se pcp related defaults / params
* This is used by contribution and also event pcps
*
- * @param CRM_Core_Form $page form object
- * @param array $params associated array
+ * @param CRM_Core_Form $page
+ * Form object.
+ * @param array $params
+ * Associated array.
*
* @return array
* @static
/**
* @param array $membershipParams
- * @param integer $contactID
+ * @param int $contactID
* @param array $customFieldsFormatted
* @param array $fieldTypes
* @param array $premiumParams
- * @param array $membershipLineItems line items specifically relating to memberships
+ * @param array $membershipLineItems
+ * Line items specifically relating to memberships.
* @param $isPayLater
*/
public function processMembership($membershipParams, $contactID, $customFieldsFormatted, $fieldTypes, $premiumParams, $membershipLineItems, $isPayLater) {
* transaction AND a membership transaction AND the payment processor supports double financial transactions (ie. NOT doTransferPayment style)
*
*
- * @param integer $formID
+ * @param int $formID
* @param bool $amountBlockActiveOnForm
*
* @return bool
/**
* Global form rule
*
- * @param array $fields the input form values
- * @param array $files the uploaded files if any
+ * @param array $fields
+ * The input form values.
+ * @param array $files
+ * The uploaded files if any.
* @param $self
*
*
/**
* Global form rule
*
- * @param array $fields the input form values
- * @param array $files the uploaded files if any
+ * @param array $fields
+ * The input form values.
+ * @param array $files
+ * The uploaded files if any.
* @param $self
*
*
/**
* Global form rule
*
- * @param array $fields the input form values
+ * @param array $fields
+ * The input form values.
*
* @param $files
* @param int $contributionPageId
/**
* Validation
*
- * @param array $params (ref.) an assoc array of name/value pairs
+ * @param array $params
+ * (ref.) an assoc array of name/value pairs.
*
* @return mixed true or array of errors
* @static
/**
* Global validation rules for the form
*
- * @param array $values posted values of the form
+ * @param array $values
+ * Posted values of the form.
*
* @param $files
* @param $self
/**
* Global form rule
*
- * @param array $fields the input form values
- * @param array $files the uploaded files if any
- * @param array $options additional user data
+ * @param array $fields
+ * The input form values.
+ * @param array $files
+ * The uploaded files if any.
+ * @param array $options
+ * Additional user data.
*
* @return true if no errors, else array of errors
* @static
/**
* Validation
*
- * @param array $params (ref.) an assoc array of name/value pairs
+ * @param array $params
+ * (ref.) an assoc array of name/value pairs.
*
* @param $files
* @param $self
/**
* Function for validation
*
- * @param array $params (ref.) an assoc array of name/value pairs
+ * @param array $params
+ * (ref.) an assoc array of name/value pairs.
*
* @param $files
*
/**
* Global form rule
*
- * @param array $fields the input form values
+ * @param array $fields
+ * The input form values.
*
* @param $errors
* @param $self
* Simple shell that derived classes can call to add buttons to
* the form with a customized title for the main Submit
*
- * @param string $title title of the main button
- * @param string $nextType button type for the form after processing
+ * @param string $title
+ * Title of the main button.
+ * @param string $nextType
+ * Button type for the form after processing.
* @param string $backType
* @param bool $submitOnce
*
* process the PDf and email with activity and attachment
* on click of Print Invoices
*
- * @param array $contribIDs Contribution Id
- * @param array $params associated array of submitted values
- * @param array $contactIds Contact Id
- * @param CRM_Core_Form $form form object
+ * @param array $contribIDs
+ * Contribution Id.
+ * @param array $params
+ * Associated array of submitted values.
+ * @param array $contactIds
+ * Contact Id.
+ * @param CRM_Core_Form $form
+ * Form object.
* @static
*
*/
* This function is use for adding activity for
* Email Invoice and the PDF Invoice
*
- * @param string $subject Activity subject
- * @param array $contactIds Contact Id
- * @param string $fileName gives the location with name of the file
- * @param array $params for invoices
+ * @param string $subject
+ * Activity subject.
+ * @param array $contactIds
+ * Contact Id.
+ * @param string $fileName
+ * Gives the location with name of the file.
+ * @param array $params
+ * For invoices.
*
* @static
*/
* This function is use for creating the Invoice file in upload folder
* for attachment
*
- * @param $html content for pdf in html format
+ * @param $html
+ * Content for pdf in html format.
*
* return $fileName of file which is in pdf format
*
* Declaration of common variables for Invoice and PDF
*
*
- * @param array $contribIds Contribution Id
- * @param array $params parameter for pdf or email invoices
- * @param array $contactIds Contact Id
+ * @param array $contribIds
+ * Contribution Id.
+ * @param array $params
+ * Parameter for pdf or email invoices.
+ * @param array $contactIds
+ * Contact Id.
*
* @return array array of common elements
*
* @param array $contribution
* @param array $messageToken
* @param array $categories
- * @param bool $grouped Does this letter represent more than one contribution
- * @param string $separator What is the preferred letter separator
+ * @param bool $grouped
+ * Does this letter represent more than one contribution.
+ * @param string $separator
+ * What is the preferred letter separator.
* @return string
*/
private static function resolveTokens($html_message, $contact, $contribution, $messageToken, $categories, $grouped, $separator) {
* @param string $groupBy
* @param CRM_Contribute_Form_Task $form
* @param array $returnProperties
- * @param boolean $skipOnHold
- * @param boolean $skipDeceased
+ * @param bool $skipOnHold
+ * @param bool $skipDeceased
* @param array $messageToken
* @param string $task
* @param string $separator
/**
* Global validation rules for the form
*
- * @param array $fields posted values of the form
+ * @param array $fields
+ * Posted values of the form.
*
* @return array list of errors to be posted back to the form
* @static
/**
* Global validation rules for the form
*
- * @param array $fields posted values of the form
+ * @param array $fields
+ * Posted values of the form.
*
* @return array list of errors to be posted back to the form
* @static
/**
* Global form rule
*
- * @param array $fields the input form values
- * @param array $files the uploaded files if any
+ * @param array $fields
+ * The input form values.
+ * @param array $files
+ * The uploaded files if any.
* @param $self
*
*
/**
* Global validation rules for the form
*
- * @param array $fields posted values of the form
+ * @param array $fields
+ * Posted values of the form.
*
* @param $files
* @param $self
/**
* Determines the file extension based on error code
*
- * @param int $type error code constant
+ * @param int $type
+ * Error code constant.
*
* @return string
*/
/**
* Determines the file name based on error code
*
- * @param int $type error code constant
+ * @param int $type
+ * Error code constant.
*
* @return string
*/
/**
* Handle the values in mapField mode
*
- * @param array $values the array of values belonging to this line
+ * @param array $values
+ * The array of values belonging to this line.
*
* @return boolean
*/
/**
* Handle the values in preview mode
*
- * @param array $values the array of values belonging to this line
+ * @param array $values
+ * The array of values belonging to this line.
*
* @return boolean the result of this processing
*/
/**
* Handle the values in summary mode
*
- * @param array $values the array of values belonging to this line
+ * @param array $values
+ * The array of values belonging to this line.
*
* @return boolean the result of this processing
*/
/**
* Handle the values in import mode
*
- * @param int $onDuplicate the code for what action to take on duplicates
- * @param array $values the array of values belonging to this line
+ * @param int $onDuplicate
+ * The code for what action to take on duplicates.
+ * @param array $values
+ * The array of values belonging to this line.
*
* @return boolean the result of this processing
*/
*
* Get all the contribution pages
*
- * @param integer $id id of the contribution page
- * @param boolean $all do we want all pages or only active pages
+ * @param int $id
+ * Id of the contribution page.
+ * @param bool $all
+ * Do we want all pages or only active pages.
*
*
* @return array - array reference of all contribution pages if any
/**
* Class constructor
*
- * @param array $queryParams array of parameters for query
+ * @param array $queryParams
+ * Array of parameters for query.
* @param \const|int $action - action of search basic or advanced.
- * @param string $contributionClause if the caller wants to further restrict the search (used in contributions)
- * @param boolean $single are we dealing only with one contact?
- * @param int $limit how many contributions do we want returned
+ * @param string $contributionClause
+ * If the caller wants to further restrict the search (used in contributions).
+ * @param bool $single
+ * Are we dealing only with one contact?.
+ * @param int $limit
+ * How many contributions do we want returned.
*
* @param string $context
* @param null $compContext
/**
* Returns all the rows in the given offset and rowCount
*
- * @param enum $action the action being performed
- * @param int $offset the row number to start from
- * @param int $rowCount the number of rows to return
- * @param string $sort the sql string that describes the sort order
- * @param enum $output what should the result set include (web/email/csv)
+ * @param enum $action
+ * The action being performed.
+ * @param int $offset
+ * The row number to start from.
+ * @param int $rowCount
+ * The number of rows to return.
+ * @param string $sort
+ * The sql string that describes the sort order.
+ * @param enum $output
+ * What should the result set include (web/email/csv).
*
* @return int the total number of rows for this action
*/
* Returns the column headers as an array of tuples:
* (name, sortName (key to the sort array))
*
- * @param string $action the action being performed
- * @param enum $output what should the result set include (web/email/csv)
+ * @param string $action
+ * The action being performed.
+ * @param enum $output
+ * What should the result set include (web/email/csv).
*
* @return array the column headers that need to be displayed
*/
/**
* Name of export file.
*
- * @param string $output type of output
+ * @param string $output
+ * Type of output.
*
* @return string name of the file
*/
* to avoid using conditional state machine, much more efficient
* and simpler
*
- * @param CRM_Core_Controller $controller the controller object
+ * @param CRM_Core_Controller $controller
+ * The controller object.
*
* @param string $formName
*
projects / civicrm-core.git / commitdiff