From 9899723569e7925289bb4f1c0010b6335b044662 Mon Sep 17 00:00:00 2001 From: Tim Otten Date: Tue, 6 Jan 2015 11:41:08 -0800 Subject: [PATCH] INFRA-132 - CRM/Dedupe - Convert single-line @param to multi-line --- CRM/Dedupe/BAO/RuleGroup.php | 6 ++-- CRM/Dedupe/Finder.php | 42 +++++++++++++++++--------- CRM/Dedupe/Merger.php | 57 ++++++++++++++++++++++++------------ 3 files changed, 70 insertions(+), 35 deletions(-) diff --git a/CRM/Dedupe/BAO/RuleGroup.php b/CRM/Dedupe/BAO/RuleGroup.php index e569230916..d0baaca500 100644 --- a/CRM/Dedupe/BAO/RuleGroup.php +++ b/CRM/Dedupe/BAO/RuleGroup.php @@ -57,7 +57,8 @@ class CRM_Dedupe_BAO_RuleGroup extends CRM_Dedupe_DAO_RuleGroup { /** * Return a structure holding the supported tables, fields and their titles * - * @param string $requestedType the requested contact type + * @param string $requestedType + * The requested contact type. * * @return array a table-keyed array of field-keyed arrays holding supported fields' titles */ @@ -428,7 +429,8 @@ class CRM_Dedupe_BAO_RuleGroup extends CRM_Dedupe_DAO_RuleGroup { * for all th groups for that contactType. If contactType * not specified, do it for all * - * @param string $contactType Individual, Household or Organization + * @param string $contactType + * Individual, Household or Organization. * * @static * diff --git a/CRM/Dedupe/Finder.php b/CRM/Dedupe/Finder.php index f3cff170aa..2e123ebd80 100644 --- a/CRM/Dedupe/Finder.php +++ b/CRM/Dedupe/Finder.php @@ -43,8 +43,10 @@ class CRM_Dedupe_Finder { * Return a contact_id-keyed array of arrays of possible dupes * (of the key contact_id) - limited to dupes of $cids if provided. * - * @param int $rgid rule group id - * @param array $cids contact ids to limit the search to + * @param int $rgid + * Rule group id. + * @param array $cids + * Contact ids to limit the search to. * * @return array array of (cid1, cid2, weight) dupe triples */ @@ -78,11 +80,16 @@ class CRM_Dedupe_Finder { * permission to be checked for anonymous users. Refer CRM-6211. We might be beaking * Multi-Site dedupe for public pages. * - * @param array $params array of params of the form $params[$table][$field] == $value - * @param string $ctype contact type to match against - * @param string $used dedupe rule group usage ('Unsupervised' or 'Supervised' or 'General') - * @param array $except array of contacts that shouldn't be considered dupes - * @param int $ruleGroupID the id of the dedupe rule we should be using + * @param array $params + * Array of params of the form $params[$table][$field] == $value. + * @param string $ctype + * Contact type to match against. + * @param string $used + * Dedupe rule group usage ('Unsupervised' or 'Supervised' or 'General'). + * @param array $except + * Array of contacts that shouldn't be considered dupes. + * @param int $ruleGroupID + * The id of the dedupe rule we should be using. * * @return array matching contact ids */ @@ -134,8 +141,10 @@ class CRM_Dedupe_Finder { /** * Return a contact_id-keyed array of arrays of possible dupes in the given group. * - * @param int $rgid rule group id - * @param int $gid contact group id (currently, works only with non-smart groups) + * @param int $rgid + * Rule group id. + * @param int $gid + * Contact group id (currently, works only with non-smart groups). * * @return array array of (cid1, cid2, weight) dupe triples */ @@ -150,9 +159,12 @@ class CRM_Dedupe_Finder { /** * Return dupes of a given contact, using the default rule group (of a provided usage). * - * @param int $cid contact id of the given contact - * @param string $used dedupe rule group usage ('Unsupervised' or 'Supervised' or 'General') - * @param string $ctype contact type of the given contact + * @param int $cid + * Contact id of the given contact. + * @param string $used + * Dedupe rule group usage ('Unsupervised' or 'Supervised' or 'General'). + * @param string $ctype + * Contact type of the given contact. * * @return array array of dupe contact_ids */ @@ -191,8 +203,10 @@ class CRM_Dedupe_Finder { * A hackish function needed to massage CRM_Contact_Form_$ctype::formRule() * object into a valid $params array for dedupe * - * @param array $fields contact structure from formRule() - * @param string $ctype contact type of the given contact + * @param array $fields + * Contact structure from formRule(). + * @param string $ctype + * Contact type of the given contact. * * @return array valid $params array for dedupe */ diff --git a/CRM/Dedupe/Merger.php b/CRM/Dedupe/Merger.php index d6df141918..d94127d5b0 100644 --- a/CRM/Dedupe/Merger.php +++ b/CRM/Dedupe/Merger.php @@ -258,7 +258,8 @@ WHERE /** * We treat multi-valued custom sets as "related tables" similar to activities, contributions, etc. - * @param string $request 'relTables' or 'cidRefs' + * @param string $request + * 'relTables' or 'cidRefs'. * @see CRM-13836 */ public static function getMultiValueCustomSets($request) { @@ -517,8 +518,10 @@ INNER JOIN civicrm_membership membership2 ON membership1.membership_type_id = m /** * Find differences between contacts. * - * @param array $main contact details - * @param array $other contact details + * @param array $main + * Contact details. + * @param array $other + * Contact details. * * @return array * @static @@ -554,12 +557,16 @@ INNER JOIN civicrm_membership membership2 ON membership1.membership_type_id = m /** * Batch merge a set of contacts based on rule-group and group. * - * @param int $rgid rule group id - * @param int $gid group id - * @param string $mode helps decide how to behave when there are conflicts. + * @param int $rgid + * Rule group id. + * @param int $gid + * Group id. + * @param string $mode + * Helps decide how to behave when there are conflicts. * A 'safe' value skips the merge if there are any un-resolved conflicts. * Does a force merge otherwise. - * @param boolean $autoFlip wether to let api decide which contact to retain and which to delete. + * @param boolean $autoFlip + * Wether to let api decide which contact to retain and which to delete. * @param bool $redirectForPerformance * * @return array|bool @@ -595,13 +602,17 @@ INNER JOIN civicrm_membership membership2 ON membership1.membership_type_id = m /** * Merge given set of contacts. Performs core operation. * - * @param array $dupePairs set of pair of contacts for whom merge is to be done. - * @param array $cacheParams prev-next-cache params based on which next pair of contacts are computed. + * @param array $dupePairs + * Set of pair of contacts for whom merge is to be done. + * @param array $cacheParams + * Prev-next-cache params based on which next pair of contacts are computed. * Generally used with batch-merge. - * @param string $mode helps decide how to behave when there are conflicts. + * @param string $mode + * Helps decide how to behave when there are conflicts. * A 'safe' value skips the merge if there are any un-resolved conflicts. * Does a force merge otherwise (aggressive mode). - * @param boolean $autoFlip wether to let api decide which contact to retain and which to delete. + * @param boolean $autoFlip + * Wether to let api decide which contact to retain and which to delete. * * * @param bool $redirectForPerformance @@ -685,10 +696,14 @@ INNER JOIN civicrm_membership membership2 ON membership1.membership_type_id = m * A function which uses various rules / algorithms for choosing which contact to bias to * when there's a conflict (to handle "gotchas"). Plus the safest route to merge. * - * @param int $mainId main contact with whom merge has to happen - * @param int $otherId duplicate contact which would be deleted after merge operation - * @param array $migrationInfo array of information about which elements to merge. - * @param string $mode helps decide how to behave when there are conflicts. + * @param int $mainId + * Main contact with whom merge has to happen. + * @param int $otherId + * Duplicate contact which would be deleted after merge operation. + * @param array $migrationInfo + * Array of information about which elements to merge. + * @param string $mode + * Helps decide how to behave when there are conflicts. * A 'safe' value skips the merge if there are any un-resolved conflicts. * Does a force merge otherwise (aggressive mode). * @@ -796,8 +811,10 @@ INNER JOIN civicrm_membership membership2 ON membership1.membership_type_id = m /** * A function to build an array of information required by merge function and the merge UI. * - * @param int $mainId main contact with whom merge has to happen - * @param int $otherId duplicate contact which would be deleted after merge operation + * @param int $mainId + * Main contact with whom merge has to happen. + * @param int $otherId + * Duplicate contact which would be deleted after merge operation. * * @return array|bool|int * @static @@ -1191,8 +1208,10 @@ INNER JOIN civicrm_membership membership2 ON membership1.membership_type_id = m * other contact to the main one - be it Location / CustomFields or Contact .. related info. * A superset of moveContactBelongings() function. * - * @param int $mainId main contact with whom merge has to happen - * @param int $otherId duplicate contact which would be deleted after merge operation + * @param int $mainId + * Main contact with whom merge has to happen. + * @param int $otherId + * Duplicate contact which would be deleted after merge operation. * * @param $migrationInfo * -- 2.25.1