From: Tim Otten Date: Tue, 6 Jan 2015 19:41:09 +0000 (-0800) Subject: INFRA-132 - CRM/Member - Convert single-line @param to multi-line X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=b2363ea8930aa47347ce41d5bd8c234773c57c6d;p=civicrm-core.git INFRA-132 - CRM/Member - Convert single-line @param to multi-line --- diff --git a/CRM/Member/BAO/Membership.php b/CRM/Member/BAO/Membership.php index f971de8cc8..703a108baf 100644 --- a/CRM/Member/BAO/Membership.php +++ b/CRM/Member/BAO/Membership.php @@ -65,8 +65,10 @@ class CRM_Member_BAO_Membership extends CRM_Member_DAO_Membership { * membership 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_Member_BAO_Membership object * @static @@ -188,9 +190,12 @@ class CRM_Member_BAO_Membership extends CRM_Member_DAO_Membership { * 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 boolean $active do you want only active memberships to + * @param array $params + * Input parameters to find object. + * @param array $values + * Output values of the object. + * @param bool $active + * Do you want only active memberships to. * be returned * * @return CRM_Member_BAO_Membership|null the found object or null @@ -225,8 +230,10 @@ class CRM_Member_BAO_Membership extends CRM_Member_DAO_Membership { /** * Takes an associative array and creates a membership 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. * @param bool $skipRedirect * @param string $activityType * @@ -432,10 +439,12 @@ class CRM_Member_BAO_Membership extends CRM_Member_DAO_Membership { /** * Check the membership extended through relationship * - * @param int $membershipId membership id - * @param int $contactId contact id + * @param int $membershipId + * Membership id. + * @param int $contactId + * Contact id. * - * @param integer $action + * @param int $action * * @return Array array of contact_id of all related contacts. * @static @@ -499,8 +508,10 @@ class CRM_Member_BAO_Membership extends CRM_Member_DAO_Membership { * 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 * * @return CRM_Member_BAO_Membership object @@ -536,7 +547,8 @@ class CRM_Member_BAO_Membership extends CRM_Member_DAO_Membership { * * get membership status and membership type values * - * @param int $membershipId membership id of values to return + * @param int $membershipId + * Membership id of values to return. * * @return array of key value pairs */ @@ -572,7 +584,8 @@ INNER JOIN civicrm_membership_type type ON ( type.id = membership.membership_ty * Delete membership. * Wrapper for most delete calls. Use this unless you JUST want to delete related memberships w/o deleting the parent. * - * @param int $membershipId membership id that needs to be deleted + * @param int $membershipId + * Membership id that needs to be deleted. * * @static * @@ -587,7 +600,8 @@ INNER JOIN civicrm_membership_type type ON ( type.id = membership.membership_ty /** * Delete membership. * - * @param int $membershipId membership id that needs to be deleted + * @param int $membershipId + * Membership id that needs to be deleted. * * @static * @@ -679,8 +693,10 @@ INNER JOIN civicrm_membership_type type ON ( type.id = membership.membership_ty /** * Obtain active/inactive memberships from the list of memberships passed to it. * - * @param array $memberships membership records - * @param string $status active or inactive + * @param array $memberships + * Membership records. + * @param string $status + * Active or inactive. * * @return array $actives array of memberships based on status * @static @@ -709,12 +725,17 @@ INNER JOIN civicrm_membership_type type ON ( type.id = membership.membership_ty /** * Build Membership Block in Contribution Pages * - * @param CRM_Core_Form $form form object - * @param int $pageID - unused? - * @param int $cid - contact checked for having a current membership for a particular membership - * @param boolean $formItems - * @param int $selectedMembershipTypeID selected membership id - * @param boolean $thankPage thank you page + * @param CRM_Core_Form $form + * Form object. + * @param int $pageID + * Unused?. + * @param int $cid + * Contact checked for having a current membership for a particular membership. + * @param bool $formItems + * @param int $selectedMembershipTypeID + * Selected membership id. + * @param bool $thankPage + * Thank you page. * @param null $isTest * * @return bool Is this a separate membership payment @@ -908,7 +929,8 @@ INNER JOIN civicrm_membership_type type ON ( type.id = membership.membership_ty /** * Return Membership Block info in Contribution Pages * - * @param int $pageID contribution page id + * @param int $pageID + * Contribution page id. * * @return array|null * @@ -947,11 +969,15 @@ INNER JOIN civicrm_membership_type type ON ( type.id = membership.membership_ty * Return a current membership of given contact * NB: if more than one membership meets criteria, a randomly selected one is returned. * - * @param int $contactID contact id - * @param int $memType membership type, null to retrieve all types + * @param int $contactID + * Contact id. + * @param int $memType + * Membership type, null to retrieve all types. * @param int $isTest - * @param int $membershipId if provided, then determine if it is current - * @param boolean $onlySameParentOrg true if only Memberships with same parent org as the $memType wanted, false otherwise + * @param int $membershipId + * If provided, then determine if it is current. + * @param bool $onlySameParentOrg + * True if only Memberships with same parent org as the $memType wanted, false otherwise. * * @return array|bool * @static @@ -1042,8 +1068,9 @@ INNER JOIN civicrm_membership_type type ON ( type.id = membership.membership_ty /** * Combine all the importable fields from the lower levels object * - * @param string $contactType contact type - * @param boolean $status + * @param string $contactType + * Contact type. + * @param bool $status * * @return array array of importable Fields * @static @@ -1132,9 +1159,12 @@ INNER JOIN civicrm_membership_type type ON ( type.id = membership.membership_ty * Signup" or "Membership Renewal" activity falls in the given date range. * Dates match the pattern "yyyy-mm-dd". * - * @param int $membershipTypeId membership type id - * @param int $startDate date on which to start counting - * @param int $endDate date on which to end counting + * @param int $membershipTypeId + * Membership type id. + * @param int $startDate + * Date on which to start counting. + * @param int $endDate + * Date on which to end counting. * @param bool|int $isTest if true, membership is for a test site * @param bool|int $isOwner if true, only retrieve membership records for owners //LCD * @@ -1192,8 +1222,10 @@ INNER JOIN civicrm_contact contact ON ( contact.id = membership.contact_id AND * The second condition takes care of records that have no end_date. These * are assumed to be lifetime memberships. * - * @param int $membershipTypeId membership type id - * @param string $date the date for which to retrieve the count + * @param int $membershipTypeId + * Membership type id. + * @param string $date + * The date for which to retrieve the count. * @param bool|int $isTest if true, membership is for a test site * @param bool|int $isOwner if true, only retrieve membership records for owners //LCD * @@ -1228,7 +1260,8 @@ AND civicrm_membership.is_test = %2"; /** * Function check the status of the membership before adding membership for a contact * - * @param int $contactId contact id + * @param int $contactId + * Contact id. * * @return int */ @@ -1241,9 +1274,12 @@ AND civicrm_membership.is_test = %2"; /** * Process the Memberships * - * @param array $membershipParams array of membership fields - * @param int $contactID contact id - * @param CRM_Contribute_Form_Contribution_Confirm $form Confirmation form object + * @param array $membershipParams + * Array of membership fields. + * @param int $contactID + * Contact id. + * @param CRM_Contribute_Form_Contribution_Confirm $form + * Confirmation form object. * * @param array $premiumParams * @param null $customFieldsFormatted @@ -1259,7 +1295,8 @@ AND civicrm_membership.is_test = %2"; * @param $isProcessSeparateMembershipTransaction * * @param int $defaultContributionTypeID - * @param array $membershipLineItems Line items specific to membership payment that is separate to contribution + * @param array $membershipLineItems + * Line items specific to membership payment that is separate to contribution. * @throws CRM_Core_Exception * * @return void @@ -1454,15 +1491,22 @@ AND civicrm_membership.is_test = %2"; * whether the given contact has a membership or not. And will add * the modified dates for membership and in the log table. * - * @param int $contactID id of the contact - * @param int $membershipTypeID id of the new membership type - * @param boolean $is_test if this is test contribution or live contribution - * @param CRM_Core_Form $form form object + * @param int $contactID + * Id of the contact. + * @param int $membershipTypeID + * Id of the new membership type. + * @param bool $is_test + * If this is test contribution or live contribution. + * @param CRM_Core_Form $form + * Form object. * @param null $changeToday - * @param int $modifiedID individual contact id in case of On Behalf signup (CRM-4027 ) + * @param int $modifiedID + * Individual contact id in case of On Behalf signup (CRM-4027 ). * @param null $customFieldsFormatted - * @param int $numRenewTerms how many membership terms are being added to end date (default is 1) - * @param integer $membershipID Membership ID, this should always be passed in & optionality should be removed + * @param int $numRenewTerms + * How many membership terms are being added to end date (default is 1). + * @param int $membershipID + * Membership ID, this should always be passed in & optionality should be removed. * * @throws CRM_Core_Exception * @@ -1515,10 +1559,12 @@ AND civicrm_membership.is_test = %2"; * then status will be updated based on existing start and end * dates and log will be added for the status change. * - * @param array $currentMembership reference to the array + * @param array $currentMembership + * Reference to the array. * containing all values of * the current membership - * @param array $changeToday array of month, day, year + * @param array $changeToday + * Array of month, day, year. * values in case today needs * to be customised, null otherwise * @@ -1625,8 +1671,10 @@ SELECT c.contribution_page_id as pageID /** * Updated related memberships * - * @param int $ownerMembershipId owner Membership Id - * @param array $params formatted array of key => value.. + * @param int $ownerMembershipId + * Owner Membership Id. + * @param array $params + * Formatted array of key => value. * @static */ public static function updateRelatedMemberships($ownerMembershipId, $params) { @@ -1673,7 +1721,8 @@ SELECT c.contribution_page_id as pageID /** * Get the sort name of a contact for a particular membership * - * @param int $id id of the membership + * @param int $id + * Id of the membership. * * @return null|string sort name of the contact if found * @static @@ -1694,8 +1743,10 @@ WHERE civicrm_membership.contact_id = civicrm_contact.id * Create memberships for related contacts * takes into account the maximum related memberships * - * @param array $params array of key - value pairs - * @param CRM_Core_DAO $dao membership object + * @param array $params + * Array of key - value pairs. + * @param CRM_Core_DAO $dao + * Membership object. * * @return null|array array of memberships if created * @static @@ -1860,7 +1911,8 @@ WHERE civicrm_membership.contact_id = civicrm_contact.id /** * Delete the record that are associated with this Membership Payment * - * @param int $membershipId membsership id. + * @param int $membershipId + * Membsership id. * * @return boolean true if deleted false otherwise */ @@ -1936,7 +1988,7 @@ FROM civicrm_membership_type * Get membership record count for a Contact * * @param int $contactID - * @param boolean $activeOnly + * @param bool $activeOnly * * @return null|string * @static @@ -1959,7 +2011,8 @@ FROM civicrm_membership_type * Check whether payment processor supports * cancellation of membership subscription * - * @param int $mid membership id + * @param int $mid + * Membership id. * * @param bool $isNotCancelled * @@ -1991,7 +2044,8 @@ FROM civicrm_membership_type /** * Check whether subscription is already cancelled * - * @param int $mid membership id + * @param int $mid + * Membership id. * * @return string $status contribution status * @static @@ -2017,9 +2071,12 @@ LEFT JOIN civicrm_membership mem ON ( cr.id = mem.contribution_recur_id ) * join_date and start_date are within a specified date range. Dates match * the pattern "yyyy-mm-dd". * - * @param int $membershipTypeId membership type id - * @param int $startDate date on which to start counting - * @param int $endDate date on which to end counting + * @param int $membershipTypeId + * Membership type id. + * @param int $startDate + * Date on which to start counting. + * @param int $endDate + * Date on which to end counting. * @param bool|int $isTest if true, membership is for a test site * * @return returns the number of members of type $membershipTypeId @@ -2065,9 +2122,12 @@ INNER JOIN civicrm_contact contact ON ( contact.id = membership.contact_id AND * whose join_date is before and start_date is within a specified date * range. Dates match the pattern "yyyy-mm-dd". * - * @param int $membershipTypeId membership type id - * @param int $startDate date on which to start counting - * @param int $endDate date on which to end counting + * @param int $membershipTypeId + * Membership type id. + * @param int $startDate + * Date on which to start counting. + * @param int $endDate + * Date on which to end counting. * @param bool|int $isTest if true, membership is for a test site * * @return integer returns the number of members of type $membershipTypeId @@ -2304,24 +2364,24 @@ INNER JOIN civicrm_contact contact ON ( contact.id = membership.contact_id AND } /** - * @param integer $contactID + * @param int $contactID * @param int $membershipTypeID * @param bool $is_test * @param $changeToday - * @param integer $modifiedID + * @param int $modifiedID * @param $customFieldsFormatted * @param $numRenewTerms * @param int $membershipID * @param $pending * @param $allStatus * @param array $membershipTypeDetails - * @param integer $contributionRecurID + * @param int $contributionRecurID * @param $format * @param $membershipSource * @param $ids * @param $statusFormat * @param $isPayLater - * @param integer $campaignId + * @param int $campaignId * * @throws CRM_Core_Exception * @return array @@ -2587,7 +2647,8 @@ INNER JOIN civicrm_contact contact ON ( contact.id = membership.contact_id AND * Retrieve the contribution id for the associated Membership id * @todo we should get this off the line item * - * @param int $membershipId membership id. + * @param int $membershipId + * Membership id. * * @return integer contribution id */ @@ -2810,8 +2871,10 @@ WHERE civicrm_membership.is_test = 0"; /** * Record contribution record associated with membership * - * @param array $params array of submitted params - * @param array $ids (param in process of being removed - try to use params) array of ids + * @param array $params + * Array of submitted params. + * @param array $ids + * (param in process of being removed - try to use params) array of ids. * * @return CRM_Contribute_BAO_Contribution * @static @@ -2886,7 +2949,8 @@ WHERE civicrm_membership.is_test = 0"; * Record line items for default membership * * @param CRM_Core_Form $qf - * @param array $membershipType array with membership type and organization + * @param array $membershipType + * Array with membership type and organization. * @param int $priceSetId * * @static @@ -2936,8 +3000,10 @@ WHERE civicrm_membership.is_test = 0"; /** * Get all Cancelled Membership(s) for a contact * - * @param int $contactID contact id - * @param boolean $isTest mode of payment + * @param int $contactID + * Contact id. + * @param bool $isTest + * Mode of payment. * * @return array of membership type * @static diff --git a/CRM/Member/BAO/MembershipBlock.php b/CRM/Member/BAO/MembershipBlock.php index decc5fd520..1cd7d85002 100644 --- a/CRM/Member/BAO/MembershipBlock.php +++ b/CRM/Member/BAO/MembershipBlock.php @@ -42,7 +42,8 @@ class CRM_Member_BAO_MembershipBlock extends CRM_Member_DAO_MembershipBlock { /** * Add the membership Blocks * - * @param array $params reference array contains the values submitted by the form + * @param array $params + * Reference array contains the values submitted by the form. * * @static * diff --git a/CRM/Member/BAO/MembershipLog.php b/CRM/Member/BAO/MembershipLog.php index 174fa3b7bf..9a03c93b76 100644 --- a/CRM/Member/BAO/MembershipLog.php +++ b/CRM/Member/BAO/MembershipLog.php @@ -37,8 +37,10 @@ class CRM_Member_BAO_MembershipLog extends CRM_Member_DAO_MembershipLog { /** * Add the membership log record * - * @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 * diff --git a/CRM/Member/BAO/MembershipPayment.php b/CRM/Member/BAO/MembershipPayment.php index 1a585dce88..10010872b7 100644 --- a/CRM/Member/BAO/MembershipPayment.php +++ b/CRM/Member/BAO/MembershipPayment.php @@ -44,7 +44,8 @@ class CRM_Member_BAO_MembershipPayment extends CRM_Member_DAO_MembershipPayment /** * Add the membership Payments * - * @param array $params reference array contains the values submitted by the form + * @param array $params + * Reference array contains the values submitted by the form. * * @static * diff --git a/CRM/Member/BAO/MembershipStatus.php b/CRM/Member/BAO/MembershipStatus.php index 4e4d30a52a..93f2f91c01 100644 --- a/CRM/Member/BAO/MembershipStatus.php +++ b/CRM/Member/BAO/MembershipStatus.php @@ -49,8 +49,10 @@ class CRM_Member_BAO_MembershipStatus extends CRM_Member_DAO_MembershipStatus { /** * 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_Member_BAO_MembershipStatus object * @static @@ -68,8 +70,10 @@ class CRM_Member_BAO_MembershipStatus extends CRM_Member_DAO_MembershipStatus { /** * 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 @@ -82,7 +86,8 @@ class CRM_Member_BAO_MembershipStatus extends CRM_Member_DAO_MembershipStatus { * Takes an associative array and creates a membership Status object * See http://wiki.civicrm.org/confluence/display/CRM/Database+layer * - * @param array $params (reference ) an assoc array of name/value pairs + * @param array $params + * (reference ) an assoc array of name/value pairs. * * @throws Exception * @return CRM_Member_BAO_MembershipStatus object @@ -107,8 +112,10 @@ class CRM_Member_BAO_MembershipStatus extends CRM_Member_DAO_MembershipStatus { /** * Add the membership types * - * @param array $params reference array contains the values submitted by the form - * @param array $ids array contains the id - this param is deprecated + * @param array $params + * Reference array contains the values submitted by the form. + * @param array $ids + * Array contains the id - this param is deprecated. * * @static * @@ -212,13 +219,18 @@ class CRM_Member_BAO_MembershipStatus extends CRM_Member_DAO_MembershipStatus { /** * Find the membership status based on start date, end date, join date & status date. * - * @param string $startDate start date of the member whose membership status is to be calculated. - * @param string $endDate end date of the member whose membership status is to be calculated. - * @param string $joinDate join date of the member whose membership status is to be calculated. + * @param string $startDate + * Start date of the member whose membership status is to be calculated. + * @param string $endDate + * End date of the member whose membership status is to be calculated. + * @param string $joinDate + * Join date of the member whose membership status is to be calculated. * @param \date|string $statusDate status date of the member whose membership status is to be calculated. - * @param boolean $excludeIsAdmin exclude the statuses those having is_admin = 1 + * @param boolean $excludeIsAdmin + * Exclude the statuses those having is_admin = 1. * @param int $membershipTypeID - * @param array $membership membership params as available to calling function - passed to the hook + * @param array $membership + * Membership params as available to calling function - passed to the hook. * * @return array @static diff --git a/CRM/Member/BAO/MembershipType.php b/CRM/Member/BAO/MembershipType.php index 530b28927d..4867781bd8 100644 --- a/CRM/Member/BAO/MembershipType.php +++ b/CRM/Member/BAO/MembershipType.php @@ -51,8 +51,10 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType { /** * 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_Member_BAO_MembershipType object * @static @@ -70,8 +72,10 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType { /** * 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 @@ -83,8 +87,10 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType { /** * Add the membership types * - * @param array $params reference array contains the values submitted by the form - * @param array $ids array contains the id (deprecated) + * @param array $params + * Reference array contains the values submitted by the form. + * @param array $ids + * Array contains the id (deprecated). * * @static * @@ -188,7 +194,8 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType { /** * Convert membership Type's 'start day' & 'rollover day' to human readable formats. * - * @param array $membershipType an array of membershipType-details. + * @param array $membershipType + * An array of membershipType-details. * @static */ public static function convertDayFormat(&$membershipType) { @@ -277,11 +284,15 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType { /** * Calculate start date and end date for new membership * - * @param int $membershipTypeId membership type id - * @param date $joinDate member since ( in mysql date format ) - * @param date $startDate start date ( in mysql date format ) + * @param int $membershipTypeId + * Membership type id. + * @param date $joinDate + * Member since ( in mysql date format ). + * @param date $startDate + * Start date ( in mysql date format ). * @param null $endDate - * @param int $numRenewTerms how many membership terms are being added to end date (default is 1) + * @param int $numRenewTerms + * How many membership terms are being added to end date (default is 1). * * @return array associated array with start date, end date and join date for the membership * @static @@ -456,8 +467,10 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType { * * @param int $membershipId * @param $changeToday - * @param int $membershipTypeID - if provided, overrides the membership type of the $membershipID membership - * @param int $numRenewTerms how many membership terms are being added to end date (default is 1) + * @param int $membershipTypeID + * If provided, overrides the membership type of the $membershipID membership. + * @param int $numRenewTerms + * How many membership terms are being added to end date (default is 1). * * CRM-7297 Membership Upsell - Added $membershipTypeID param to facilitate calculations of dates when membership type changes * @@ -564,7 +577,8 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType { * Retrieve all Membership Types associated * with an Organization * - * @param int $orgID Id of Organization + * @param int $orgID + * Id of Organization. * * @return Array array of the details of membership types * @static diff --git a/CRM/Member/Form.php b/CRM/Member/Form.php index 6413df3141..3b79251379 100644 --- a/CRM/Member/Form.php +++ b/CRM/Member/Form.php @@ -193,7 +193,8 @@ class CRM_Member_Form extends CRM_Contribute_Form_AbstractEditPayment { * If the member & contributor are the same then the values will be the same. But if different people paid * then they weill differ * - * @param $formValues array values from form. The important values we are looking for are + * @param $formValues + * Array values from form. The important values we are looking for are. * - contact_id * - soft_credit_contact_id */ diff --git a/CRM/Member/Form/Membership.php b/CRM/Member/Form/Membership.php index dcc8c1de35..504c870b6f 100644 --- a/CRM/Member/Form/Membership.php +++ b/CRM/Member/Form/Membership.php @@ -739,7 +739,8 @@ WHERE id IN ( ' . implode(' , ', array_keys($membershipType)) . ' )'; /** * 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 @@ -1698,9 +1699,11 @@ WHERE id IN ( ' . implode(' , ', array_keys($membershipType)) . ' )'; /** * Send email receipt * - * @param CRM_Core_Form $form form object + * @param CRM_Core_Form $form + * Form object. * @param array $formValues - * @param object $membership object + * @param object $membership + * Object. * * @return boolean true if mail was sent successfully * @static diff --git a/CRM/Member/Form/MembershipBlock.php b/CRM/Member/Form/MembershipBlock.php index c9cf10c289..7c21b99c24 100644 --- a/CRM/Member/Form/MembershipBlock.php +++ b/CRM/Member/Form/MembershipBlock.php @@ -212,7 +212,8 @@ class CRM_Member_Form_MembershipBlock extends CRM_Contribute_Form_ContributionPa /** * 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 int $contributionPageId diff --git a/CRM/Member/Form/MembershipRenewal.php b/CRM/Member/Form/MembershipRenewal.php index 5537c55b39..fc6721f5f4 100644 --- a/CRM/Member/Form/MembershipRenewal.php +++ b/CRM/Member/Form/MembershipRenewal.php @@ -452,7 +452,8 @@ WHERE id IN ( ' . implode(' , ', array_keys($membershipType)) . ' )'; /** * 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 diff --git a/CRM/Member/Form/MembershipType.php b/CRM/Member/Form/MembershipType.php index 97ff8248d6..9d7423c1a6 100644 --- a/CRM/Member/Form/MembershipType.php +++ b/CRM/Member/Form/MembershipType.php @@ -212,7 +212,8 @@ class CRM_Member_Form_MembershipType extends CRM_Member_Form_MembershipConfig { /** * 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 diff --git a/CRM/Member/Form/MembershipView.php b/CRM/Member/Form/MembershipView.php index 9a77fd1962..474d691c1f 100644 --- a/CRM/Member/Form/MembershipView.php +++ b/CRM/Member/Form/MembershipView.php @@ -90,8 +90,10 @@ class CRM_Member_Form_MembershipView extends CRM_Core_Form { /** * Perform create or delete action on related memberships * - * @param string $action create or delete - * @param array $owner primary membership info (membership_id, contact_id, membership_type ...) + * @param string $action + * Create or delete. + * @param array $owner + * Primary membership info (membership_id, contact_id, membership_type ...). * */ public function relAction($action, $owner) { diff --git a/CRM/Member/Form/Task.php b/CRM/Member/Form/Task.php index 154fba1686..837031b8c8 100644 --- a/CRM/Member/Form/Task.php +++ b/CRM/Member/Form/Task.php @@ -165,7 +165,8 @@ class CRM_Member_Form_Task extends CRM_Core_Form { * 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 $title + * Title of the main button. * @param string $nextType * @param string $backType * @param bool $submitOnce diff --git a/CRM/Member/Form/Task/PickProfile.php b/CRM/Member/Form/Task/PickProfile.php index a42dac4ca4..9c95dd9533 100644 --- a/CRM/Member/Form/Task/PickProfile.php +++ b/CRM/Member/Form/Task/PickProfile.php @@ -118,7 +118,8 @@ class CRM_Member_Form_Task_PickProfile extends CRM_Member_Form_Task { /** * 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 diff --git a/CRM/Member/Import/Form/MapField.php b/CRM/Member/Import/Form/MapField.php index 6c6c788d21..4345b09973 100644 --- a/CRM/Member/Import/Form/MapField.php +++ b/CRM/Member/Import/Form/MapField.php @@ -298,7 +298,8 @@ class CRM_Member_Import_Form_MapField extends CRM_Import_Form_MapField { /** * 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 diff --git a/CRM/Member/Import/Parser/Membership.php b/CRM/Member/Import/Parser/Membership.php index 18be57331b..a49e880189 100644 --- a/CRM/Member/Import/Parser/Membership.php +++ b/CRM/Member/Import/Parser/Membership.php @@ -109,7 +109,8 @@ class CRM_Member_Import_Parser_Membership extends CRM_Member_Import_Parser { /** * 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 */ @@ -120,7 +121,8 @@ class CRM_Member_Import_Parser_Membership extends CRM_Member_Import_Parser { /** * 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 */ @@ -131,7 +133,8 @@ class CRM_Member_Import_Parser_Membership extends CRM_Member_Import_Parser { /** * 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 */ @@ -244,8 +247,10 @@ class CRM_Member_Import_Parser_Membership extends CRM_Member_Import_Parser { /** * 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 */ @@ -579,7 +584,8 @@ class CRM_Member_Import_Parser_Membership extends CRM_Member_Import_Parser { /** * to calculate join, start and end dates * - * @param Array $calcDates array of dates returned by getDatesForMembershipType() + * @param array $calcDates + * Array of dates returned by getDatesForMembershipType(). * * @param $formatted * @@ -611,9 +617,11 @@ class CRM_Member_Import_Parser_Membership extends CRM_Member_Import_Parser { * take the input parameter list as specified in the data model and * convert it into the same format that we use in QF and BAO object * - * @param array $params Associative array of property name/value + * @param array $params + * Associative array of property name/value. * pairs to insert in new contact. - * @param array $values The reformatted properties that we can use internally + * @param array $values + * The reformatted properties that we can use internally. * * @param array|bool $create Is the formatted Values array going to * be used for CRM_Member_BAO_Membership:create() diff --git a/CRM/Member/Selector/Search.php b/CRM/Member/Selector/Search.php index f109e9ce1e..632f8730cc 100644 --- a/CRM/Member/Selector/Search.php +++ b/CRM/Member/Selector/Search.php @@ -132,11 +132,15 @@ class CRM_Member_Selector_Search extends CRM_Core_Selector_Base implements CRM_C /** * 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 $memberClause if the caller wants to further restrict the search (used in memberships) - * @param boolean $single are we dealing only with one contact? - * @param int $limit how many memberships do we want returned + * @param string $memberClause + * If the caller wants to further restrict the search (used in memberships). + * @param bool $single + * Are we dealing only with one contact?. + * @param int $limit + * How many memberships do we want returned. * * @param string $context * @@ -305,11 +309,16 @@ 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 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 */ @@ -452,8 +461,10 @@ class CRM_Member_Selector_Search extends CRM_Core_Selector_Base implements CRM_C * 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 */ @@ -527,7 +538,8 @@ class CRM_Member_Selector_Search extends CRM_Core_Selector_Base implements CRM_C /** * Name of export file. * - * @param string $output type of output + * @param string $output + * Type of output. * * @return string name of the file */ diff --git a/CRM/Member/StateMachine/Search.php b/CRM/Member/StateMachine/Search.php index acd917b0c4..700a1d4173 100644 --- a/CRM/Member/StateMachine/Search.php +++ b/CRM/Member/StateMachine/Search.php @@ -72,7 +72,8 @@ class CRM_Member_StateMachine_Search extends CRM_Core_StateMachine { * 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 *