From 64bd5a0ee19cb03c9e23ffeb4eefbf764b440d3e Mon Sep 17 00:00:00 2001 From: Tim Otten Date: Tue, 6 Jan 2015 11:41:07 -0800 Subject: [PATCH] INFRA-132 - CRM/Case - Convert single-line @param to multi-line --- CRM/Case/BAO/Case.php | 191 ++++++++++++------ CRM/Case/BAO/CaseType.php | 24 ++- CRM/Case/Form/Activity.php | 6 +- .../Form/Activity/ChangeCaseStartDate.php | 3 +- CRM/Case/Form/Activity/ChangeCaseStatus.php | 3 +- CRM/Case/Form/Activity/ChangeCaseType.php | 3 +- CRM/Case/Form/Activity/LinkCases.php | 3 +- CRM/Case/Form/Case.php | 3 +- CRM/Case/Form/CaseView.php | 3 +- CRM/Case/Form/Search.php | 3 +- CRM/Case/Form/Task.php | 6 +- CRM/Case/Info.php | 9 +- CRM/Case/PseudoConstant.php | 3 +- CRM/Case/Selector/Search.php | 36 ++-- CRM/Case/StateMachine/Search.php | 3 +- CRM/Case/XMLRepository.php | 6 +- 16 files changed, 202 insertions(+), 103 deletions(-) diff --git a/CRM/Case/BAO/Case.php b/CRM/Case/BAO/Case.php index 61cd49329c..5dcc48913b 100644 --- a/CRM/Case/BAO/Case.php +++ b/CRM/Case/BAO/Case.php @@ -71,7 +71,8 @@ class CRM_Case_BAO_Case extends CRM_Case_DAO_Case { * case 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_Case_BAO_Case object * @static @@ -86,9 +87,12 @@ class CRM_Case_BAO_Case extends CRM_Case_DAO_Case { * 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_Case_BAO_Case|null the found object or null * @static @@ -109,7 +113,8 @@ class CRM_Case_BAO_Case extends CRM_Case_DAO_Case { /** * Takes an associative array and creates a case 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_Case_BAO_Case object * @static @@ -153,7 +158,7 @@ class CRM_Case_BAO_Case extends CRM_Case_DAO_Case { /** * Create case contact record * - * @param array case_id, contact_id + * @param array case_id, contact_id * * @return object */ @@ -195,7 +200,7 @@ class CRM_Case_BAO_Case extends CRM_Case_DAO_Case { /** * Delet case contact record * - * @param int case_id + * @param int case_id * * @return Void */ @@ -247,10 +252,13 @@ class CRM_Case_BAO_Case extends CRM_Case_DAO_Case { * 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_Case_BAO_Case object * @static @@ -264,7 +272,8 @@ class CRM_Case_BAO_Case extends CRM_Case_DAO_Case { * Process case activity add/delete * takes an associative array and * - * @param array $params (reference ) an assoc array of name/value pairs + * @param array $params + * (reference ) an assoc array of name/value pairs. * * @static */ @@ -280,7 +289,8 @@ class CRM_Case_BAO_Case extends CRM_Case_DAO_Case { /** * Get the case subject for Activity * - * @param int $activityId activity id + * @param int $activityId + * Activity id. * * @return case subject or null * @static @@ -320,7 +330,8 @@ WHERE civicrm_case.id = %1"; * Delete the record that are associated with this case * record are deleted from case * - * @param int $caseId id of the case to delete + * @param int $caseId + * Id of the case to delete. * * @param bool $moveToTrash * @@ -373,8 +384,10 @@ WHERE civicrm_case.id = %1"; /** * Enable disable case related relationships * - * @param int $caseId case id - * @param boolean $enable action + * @param int $caseId + * Case id. + * @param bool $enable + * Action. * * @return void * @static @@ -398,7 +411,8 @@ WHERE civicrm_case.id = %1"; /** * Delete the activities related to case * - * @param int $activityId id of the activity + * @param int $activityId + * Id of the activity. * * @return void * @static @@ -412,7 +426,8 @@ WHERE civicrm_case.id = %1"; /** * Retrieve contact_id by case_id * - * @param int $caseId ID of the case + * @param int $caseId + * ID of the case. * * @param int $contactID * @@ -459,7 +474,8 @@ WHERE civicrm_case.id = %1"; /** * Retrieve contact names by caseId * - * @param int $caseId ID of the case + * @param int $caseId + * ID of the case. * * @return array * @@ -504,7 +520,8 @@ WHERE civicrm_case.id = %1"; * Retrieve case_id by contact_id * * @param int $contactID - * @param boolean $includeDeleted include the deleted cases in result + * @param bool $includeDeleted + * Include the deleted cases in result. * @param null $caseType * * @return array @@ -701,11 +718,12 @@ LEFT JOIN civicrm_option_group aog ON aog.name='activity_type' * Retrieve cases related to particular contact or whole contact * used in Dashboad and Tab * - * @param boolean $allCases + * @param bool $allCases * * @param int $userID * - * @param String $type /upcoming,recent,all/ + * @param string $type + * /upcoming,recent,all/. * * @param string $context * @@ -954,8 +972,10 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c /** * Get Case roles * - * @param int $contactID contact id - * @param int $caseID case id + * @param int $contactID + * Contact id. + * @param int $caseID + * Case id. * @param int $relationshipID * * @return array case role / relationships @@ -1011,9 +1031,12 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c /** * Get Case Activities * - * @param int $caseID case id - * @param array $params posted params - * @param int $contactID contact id + * @param int $caseID + * Case id. + * @param array $params + * Posted params. + * @param int $contactID + * Contact id. * * @param null $context * @param int $userID @@ -1356,8 +1379,10 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c /** * Get Case Related Contacts * - * @param int $caseID case id - * @param boolean $skipDetails if true include details of contacts + * @param int $caseID + * Case id. + * @param bool $skipDetails + * If true include details of contacts. * * @return array $searchRows array of return properties * @@ -1404,8 +1429,10 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c * Send e-mail copy of activity * * @param int $clientId - * @param int $activityId activity Id - * @param array $contacts array of related contact + * @param int $activityId + * Activity Id. + * @param array $contacts + * Array of related contact. * * @param null $attachments * @param int $caseId @@ -1545,8 +1572,10 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c * Retrieve count of activities having a particular type, and * associated with a particular case. * - * @param int $caseId ID of the case - * @param int $activityTypeId ID of the activity type + * @param int $caseId + * ID of the case. + * @param int $activityTypeId + * ID of the activity type. * * @return array * @@ -1575,7 +1604,8 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c /** * Create an activity for a case via email * - * @param int $file email sent + * @param int $file + * Email sent. * * @return array|void $activity object of newly creted activity via email@access public */ @@ -1663,7 +1693,8 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c /** * Retrieve the scheduled activity type and date * - * @param array $cases Array of contact and case id + * @param array $cases + * Array of contact and case id. * * @param string $type * @@ -1734,7 +1765,8 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c /** * Restore the record that are associated with this case * - * @param int $caseId id of the case to restore + * @param int $caseId + * Id of the case to restore. * * @return true if success. * @static @@ -1829,9 +1861,12 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c /** * Get Case ActivitiesDueDates with given criteria. * - * @param int $caseID case id - * @param array $criteriaParams given criteria - * @param boolean $latestDate if set newest or oldest date is selceted. + * @param int $caseID + * Case id. + * @param array $criteriaParams + * Given criteria. + * @param bool $latestDate + * If set newest or oldest date is selceted. * * @return returns case activities due dates * @@ -1881,8 +1916,10 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c * Create activities when Case or Other roles assigned/modified/deleted. * * @param int $caseId - * @param int $relationshipId relationship id - * @param int $relContactId case role assignee contactId. + * @param int $relationshipId + * Relationship id. + * @param int $relContactId + * Case role assignee contactId. * @param int $contactId * * @return void on success creates activity and case activity @@ -1974,8 +2011,10 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c * Get case manger * contact which is assigned a case role of case manager. * - * @param int $caseType case type - * @param int $caseId case id + * @param int $caseType + * Case type. + * @param int $caseId + * Case id. * * @return array $caseManagerContact array of contact on success otherwise empty * @@ -2145,8 +2184,10 @@ LEFT JOIN civicrm_case_contact ON ( civicrm_case.id = civicrm_case_contact.case /** * Retrieve cases related to particular contact. * - * @param int $contactId contact id - * @param boolean $excludeDeleted do not include deleted cases. + * @param int $contactId + * Contact id. + * @param bool $excludeDeleted + * Do not include deleted cases. * * @return an array of cases. * @@ -2185,9 +2226,12 @@ INNER JOIN civicrm_case_contact ON ( civicrm_case.id = civicrm_case_contact.cas /** * Retrieve related cases for give case. * - * @param int $mainCaseId id of main case - * @param int $contactId id of contact - * @param boolean $excludeDeleted do not include deleted cases. + * @param int $mainCaseId + * Id of main case. + * @param int $contactId + * Id of contact. + * @param bool $excludeDeleted + * Do not include deleted cases. * * @return an array of related cases. * @@ -2307,10 +2351,14 @@ INNER JOIN civicrm_case_contact ON ( civicrm_case.id = civicrm_case_contact.cas * 1. Merge two duplicate contacts cases - follow CRM-5758 rules. * 2. Merge two cases of same contact - follow CRM-5598 rules. * - * @param int $mainContactId contact id of main contact record. - * @param int $mainCaseId case id of main case record. - * @param int $otherContactId contact id of record which is going to merge. - * @param int $otherCaseId case id of record which is going to merge. + * @param int $mainContactId + * Contact id of main contact record. + * @param int $mainCaseId + * Case id of main case record. + * @param int $otherContactId + * Contact id of record which is going to merge. + * @param int $otherCaseId + * Case id of record which is going to merge. * * @param bool $changeClient * @@ -2724,8 +2772,10 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')'; * Validate contact permission for * edit/view on activity record and build links. * - * @param array $tplParams params to be sent to template for sending email. - * @param array $activityParams info of the activity. + * @param array $tplParams + * Params to be sent to template for sending email. + * @param array $activityParams + * Info of the activity. * * @return void * @static @@ -2763,11 +2813,16 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')'; * Validate contact permission for * given operation on activity record. * - * @param int $activityId activity record id. - * @param string $operation user operation. - * @param int $actTypeId activity type id. - * @param int $contactId contact id/if not pass consider logged in - * @param boolean $checkComponent do we need to check component enabled. + * @param int $activityId + * Activity record id. + * @param string $operation + * User operation. + * @param int $actTypeId + * Activity type id. + * @param int $contactId + * Contact id/if not pass consider logged in. + * @param bool $checkComponent + * Do we need to check component enabled. * * @return boolean $allow true/false * @static @@ -3030,7 +3085,8 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')'; * Verify user has permission to access a case * * @param int $caseId - * @param bool $denyClosed set TRUE if one wants closed cases to be treated as inaccessible + * @param bool $denyClosed + * Set TRUE if one wants closed cases to be treated as inaccessible. * * @return bool */ @@ -3077,7 +3133,8 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')'; /** * Check whether activity is a case Activity * - * @param int $activityID activity id + * @param int $activityID + * Activity id. * * @return boolean $isCaseActivity true/false */ @@ -3277,8 +3334,10 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')'; /** * Add/copy relationships, when new client is added for a case * - * @param int $caseId case id - * @param int $contactId contact id / new client id + * @param int $caseId + * Case id. + * @param int $contactId + * Contact id / new client id. * * @return void */ @@ -3339,9 +3398,11 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')'; * Get options for a given case 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 */ diff --git a/CRM/Case/BAO/CaseType.php b/CRM/Case/BAO/CaseType.php index b629beaa7f..e57e0cb451 100644 --- a/CRM/Case/BAO/CaseType.php +++ b/CRM/Case/BAO/CaseType.php @@ -54,7 +54,8 @@ class CRM_Case_BAO_CaseType extends CRM_Case_DAO_CaseType { * case type 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. * * @throws CRM_Core_Exception * @@ -100,7 +101,8 @@ class CRM_Case_BAO_CaseType extends CRM_Case_DAO_CaseType { * Format / convert submitted array to xml for case type definition * * @param string $name - * @param array $definition the case-type defintion expressed as an array-tree + * @param array $definition + * The case-type defintion expressed as an array-tree. * @return string XML * @static */ @@ -179,7 +181,8 @@ class CRM_Case_BAO_CaseType extends CRM_Case_DAO_CaseType { /** * Get the case definition either from db or read from xml file * - * @param SimpleXmlElement $xml a single case-type record + * @param SimpleXmlElement $xml + * A single case-type record. * * @return array the definition of the case-type, expressed as PHP array-tree * @static @@ -240,8 +243,10 @@ class CRM_Case_BAO_CaseType extends CRM_Case_DAO_CaseType { * 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 $params + * Input parameters to find object. + * @param array $values + * Output values of the object. * * @return CRM_Case_BAO_CaseType|null the found object or null * @static @@ -261,7 +266,8 @@ class CRM_Case_BAO_CaseType extends CRM_Case_DAO_CaseType { /** * Takes an associative array and creates a case type 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_Case_BAO_CaseType object * @static @@ -301,8 +307,10 @@ class CRM_Case_BAO_CaseType extends CRM_Case_DAO_CaseType { * 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_Case_BAO_CaseType object diff --git a/CRM/Case/Form/Activity.php b/CRM/Case/Form/Activity.php index f9c82a16ca..ada4d36d11 100644 --- a/CRM/Case/Form/Activity.php +++ b/CRM/Case/Form/Activity.php @@ -355,8 +355,10 @@ class CRM_Case_Form_Activity extends CRM_Activity_Form_Activity { /** * 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 * * @return true if no errors, else array of errors diff --git a/CRM/Case/Form/Activity/ChangeCaseStartDate.php b/CRM/Case/Form/Activity/ChangeCaseStartDate.php index de202d1612..dddeefab7b 100644 --- a/CRM/Case/Form/Activity/ChangeCaseStartDate.php +++ b/CRM/Case/Form/Activity/ChangeCaseStartDate.php @@ -103,7 +103,8 @@ class CRM_Case_Form_Activity_ChangeCaseStartDate { /** * 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 CRM_Core_Form $form diff --git a/CRM/Case/Form/Activity/ChangeCaseStatus.php b/CRM/Case/Form/Activity/ChangeCaseStatus.php index d79dff10bf..21fda360de 100644 --- a/CRM/Case/Form/Activity/ChangeCaseStatus.php +++ b/CRM/Case/Form/Activity/ChangeCaseStatus.php @@ -103,7 +103,8 @@ class CRM_Case_Form_Activity_ChangeCaseStatus { /** * 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 CRM_Core_Form $form diff --git a/CRM/Case/Form/Activity/ChangeCaseType.php b/CRM/Case/Form/Activity/ChangeCaseType.php index 773dbdbc04..0d21503701 100644 --- a/CRM/Case/Form/Activity/ChangeCaseType.php +++ b/CRM/Case/Form/Activity/ChangeCaseType.php @@ -100,7 +100,8 @@ class CRM_Case_Form_Activity_ChangeCaseType { /** * 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 CRM_Core_Form $form diff --git a/CRM/Case/Form/Activity/LinkCases.php b/CRM/Case/Form/Activity/LinkCases.php index b24ad656e4..ef335cb5d8 100644 --- a/CRM/Case/Form/Activity/LinkCases.php +++ b/CRM/Case/Form/Activity/LinkCases.php @@ -92,7 +92,8 @@ class CRM_Case_Form_Activity_LinkCases { /** * 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 CRM_Core_Form $form diff --git a/CRM/Case/Form/Case.php b/CRM/Case/Form/Case.php index bd086fb2e7..925e1122b1 100644 --- a/CRM/Case/Form/Case.php +++ b/CRM/Case/Form/Case.php @@ -313,7 +313,8 @@ class CRM_Case_Form_Case extends CRM_Core_Form { /** * 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 CRM_Core_Form $form diff --git a/CRM/Case/Form/CaseView.php b/CRM/Case/Form/CaseView.php index bd488f7824..a21f4585f2 100644 --- a/CRM/Case/Form/CaseView.php +++ b/CRM/Case/Form/CaseView.php @@ -497,7 +497,8 @@ class CRM_Case_Form_CaseView extends CRM_Core_Form { /** * Build the activity selector/datatable * @param CRM_Core_Form $form - * @param array $aTypes to include acivities related to current case id $form->_caseID + * @param array $aTypes + * To include acivities related to current case id $form->_caseID. */ public static function activityForm($form, $aTypes = array()) { $caseRelationships = CRM_Case_BAO_Case::getCaseRoles($form->_contactID, $form->_caseID); diff --git a/CRM/Case/Form/Search.php b/CRM/Case/Form/Search.php index 1a8454b6a3..02eba915bc 100644 --- a/CRM/Case/Form/Search.php +++ b/CRM/Case/Form/Search.php @@ -325,7 +325,8 @@ class CRM_Case_Form_Search extends CRM_Core_Form_Search { /** * Global validation rules for the form * - * @param array $fields posted values of the form + * @param array $fields + * Posted values of the form. * * @return void * @static diff --git a/CRM/Case/Form/Task.php b/CRM/Case/Form/Task.php index cc8ddecbdb..7fd46c836e 100644 --- a/CRM/Case/Form/Task.php +++ b/CRM/Case/Form/Task.php @@ -152,8 +152,10 @@ class CRM_Case_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 $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 * diff --git a/CRM/Case/Info.php b/CRM/Case/Info.php index 4874abc6af..6dd43cecbe 100644 --- a/CRM/Case/Info.php +++ b/CRM/Case/Info.php @@ -205,9 +205,12 @@ class CRM_Case_Info extends CRM_Core_Component_Info { * * If CiviCase is being enabled, load the case related sample data * - * @param array $oldValue List of component names - * @param array $newValue List of component names - * @param array $metadata Specification of the setting (per *.settings.php) + * @param array $oldValue + * List of component names. + * @param array $newValue + * List of component names. + * @param array $metadata + * Specification of the setting (per *.settings.php). */ public static function onToggleComponents($oldValue, $newValue, $metadata) { if ( diff --git a/CRM/Case/PseudoConstant.php b/CRM/Case/PseudoConstant.php index 9cd5535f22..04c6eef8db 100644 --- a/CRM/Case/PseudoConstant.php +++ b/CRM/Case/PseudoConstant.php @@ -190,7 +190,8 @@ class CRM_Case_PseudoConstant extends CRM_Core_PseudoConstant { * * The static array activityType is returned * - * @param boolean $indexName - true return activity name in array + * @param bool $indexName + * True return activity name in array. * key else activity id as array key. * * @param bool $all diff --git a/CRM/Case/Selector/Search.php b/CRM/Case/Selector/Search.php index 02f5803db2..d6e9159cb5 100644 --- a/CRM/Case/Selector/Search.php +++ b/CRM/Case/Selector/Search.php @@ -130,11 +130,15 @@ class CRM_Case_Selector_Search extends CRM_Core_Selector_Base { /** * 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 $additionalClause if the caller wants to further restrict the search (used in participations) - * @param boolean $single are we dealing only with one contact? - * @param int $limit how many signers do we want returned + * @param string $additionalClause + * If the caller wants to further restrict the search (used in participations). + * @param bool $single + * Are we dealing only with one contact?. + * @param int $limit + * How many signers do we want returned. * * @param string $context * @@ -280,11 +284,16 @@ class CRM_Case_Selector_Search extends CRM_Core_Selector_Base { /** * 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 */ @@ -415,8 +424,10 @@ class CRM_Case_Selector_Search extends CRM_Core_Selector_Base { * 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 */ @@ -491,7 +502,8 @@ class CRM_Case_Selector_Search extends CRM_Core_Selector_Base { /** * 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/Case/StateMachine/Search.php b/CRM/Case/StateMachine/Search.php index 4ae5693139..2b1582c693 100644 --- a/CRM/Case/StateMachine/Search.php +++ b/CRM/Case/StateMachine/Search.php @@ -74,7 +74,8 @@ class CRM_Case_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 * diff --git a/CRM/Case/XMLRepository.php b/CRM/Case/XMLRepository.php index d0c5a88ff0..5710603aa8 100644 --- a/CRM/Case/XMLRepository.php +++ b/CRM/Case/XMLRepository.php @@ -254,7 +254,8 @@ class CRM_Case_XMLRepository { * Determine the number of times a particular activity-type is * referenced in CiviCase XML. * - * @param string $activityType symbolic-name of an activity type + * @param string $activityType + * Symbolic-name of an activity type. * @return int */ public function getActivityReferenceCount($activityType) { @@ -273,7 +274,8 @@ class CRM_Case_XMLRepository { * Determine the number of times a particular activity-type is * referenced in CiviCase XML. * - * @param string $relationshipTypeName symbolic-name of a relationship-type + * @param string $relationshipTypeName + * Symbolic-name of a relationship-type. * @return int */ public function getRelationshipReferenceCount($relationshipTypeName) { -- 2.25.1