From 041ab3d1bac0bf5a0c070fcb3a0e6fbfc758f39f Mon Sep 17 00:00:00 2001 From: Tim Otten Date: Tue, 6 Jan 2015 11:41:06 -0800 Subject: [PATCH] INFRA-132 - CRM/Activity - Convert single-line @param to multi-line --- CRM/Activity/BAO/Activity.php | 120 ++++++++++++++++-------- CRM/Activity/BAO/ActivityAssignment.php | 12 ++- CRM/Activity/BAO/ActivityContact.php | 3 +- CRM/Activity/BAO/ICalendar.php | 9 +- CRM/Activity/Form/Activity.php | 9 +- CRM/Activity/Form/Task.php | 6 +- CRM/Activity/Form/Task/PickOption.php | 3 +- CRM/Activity/Form/Task/PickProfile.php | 3 +- CRM/Activity/Import/Form/MapField.php | 3 +- CRM/Activity/Import/Parser/Activity.php | 15 ++- CRM/Activity/Selector/Activity.php | 33 ++++--- CRM/Activity/Selector/Search.php | 36 ++++--- CRM/Activity/StateMachine/Search.php | 3 +- 13 files changed, 170 insertions(+), 85 deletions(-) diff --git a/CRM/Activity/BAO/Activity.php b/CRM/Activity/BAO/Activity.php index 95105a0520..2cb2c0fc9e 100644 --- a/CRM/Activity/BAO/Activity.php +++ b/CRM/Activity/BAO/Activity.php @@ -58,7 +58,8 @@ class CRM_Activity_BAO_Activity extends CRM_Activity_DAO_Activity { /** * Check if there is absolute minimum of data to add the object * - * @param array $params (reference ) an assoc array of name/value pairs + * @param array $params + * (reference ) an assoc array of name/value pairs. * * @return boolean */ @@ -72,8 +73,10 @@ class CRM_Activity_BAO_Activity extends CRM_Activity_DAO_Activity { /** * 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_Activity_DAO_Activity object */ @@ -140,7 +143,8 @@ class CRM_Activity_BAO_Activity extends CRM_Activity_DAO_Activity { /** * Delete the activity * - * @param array $params associated array + * @param array $params + * Associated array. * @param bool $moveToTrash * * @return void @@ -263,7 +267,8 @@ class CRM_Activity_BAO_Activity extends CRM_Activity_DAO_Activity { /** * Process the activities * - * @param array $params associated array of the submitted values + * @param array $params + * Associated array of the submitted values. * * @throws CRM_Core_Exception * @@ -640,7 +645,8 @@ class CRM_Activity_BAO_Activity extends CRM_Activity_DAO_Activity { /** * Get the list Activities * - * @param array $input array of parameters + * @param array $input + * Array of parameters. * Keys include * - contact_id int contact_id whose activities we want to retrieve * - offset int which row to start from ? @@ -931,7 +937,8 @@ ORDER BY fixed_sort_order /** * Get the activity Count * - * @param array $input array of parameters + * @param array $input + * Array of parameters. * Keys include * - contact_id int contact_id whose activities we want to retrieve * - admin boolean if contact is admin @@ -966,7 +973,8 @@ LEFT JOIN civicrm_case_activity ON ( civicrm_case_activity.activity_id = tbl.a /** * Get the activity sql clause to pick activities * - * @param array $input array of parameters + * @param array $input + * Array of parameters. * Keys include * - contact_id int contact_id whose activities we want to retrieve * - admin boolean if contact is admin @@ -1146,18 +1154,27 @@ LEFT JOIN civicrm_activity_contact src ON (src.activity_id = ac.activity_id AND * Send the message to all the contacts and also insert a * contact activity in each contacts record * - * @param array $contactDetails the array of contact details to send the email - * @param string $subject the subject of the message + * @param array $contactDetails + * The array of contact details to send the email. + * @param string $subject + * The subject of the message. * @param $text * @param $html - * @param string $emailAddress use this 'to' email address instead of the default Primary address - * @param int $userID use this userID if set + * @param string $emailAddress + * Use this 'to' email address instead of the default Primary address. + * @param int $userID + * Use this userID if set. * @param string $from - * @param array $attachments the array of attachments if any - * @param string $cc cc recipient - * @param string $bcc bcc recipient - * @param array $contactIds contact ids - * @param string $additionalDetails the additional information of CC and BCC appended to the activity Details + * @param array $attachments + * The array of attachments if any. + * @param string $cc + * Cc recipient. + * @param string $bcc + * Bcc recipient. + * @param array $contactIds + * Contact ids. + * @param string $additionalDetails + * The additional information of CC and BCC appended to the activity Details. * * @return array ( sent, activityId) if any email is sent and activityId * @static @@ -1477,11 +1494,14 @@ LEFT JOIN civicrm_activity_contact src ON (src.activity_id = ac.activity_id AND /** * Send the sms message to a specific contact * - * @param int $toID the contact id of the recipient + * @param int $toID + * The contact id of the recipient. * @param $tokenText * @param $tokenHtml - * @param array $smsParams the params used for sending sms - * @param int $activityID the activity ID that tracks the message + * @param array $smsParams + * The params used for sending sms. + * @param int $activityID + * The activity ID that tracks the message. * @param int $userID * * @return mixed true on success or PEAR_Error object @@ -1549,14 +1569,19 @@ LEFT JOIN civicrm_activity_contact src ON (src.activity_id = ac.activity_id AND /** * Send the message to a specific contact * - * @param string $from the name and email of the sender + * @param string $from + * The name and email of the sender. * @param int $fromID - * @param int $toID the contact id of the recipient - * @param string $subject the subject of the message + * @param int $toID + * The contact id of the recipient. + * @param string $subject + * The subject of the message. * @param $text_message * @param $html_message - * @param string $emailAddress use this 'to' email address instead of the default Primary address - * @param int $activityID the activity ID that tracks the message + * @param string $emailAddress + * Use this 'to' email address instead of the default Primary address. + * @param int $activityID + * The activity ID that tracks the message. * @param null $attachments * @param null $cc * @param null $bcc @@ -1683,7 +1708,8 @@ LEFT JOIN civicrm_activity_contact src ON (src.activity_id = ac.activity_id AND /** * To get the Activities of a target contact * - * @param int $contactId Id of the contact whose activities need to find + * @param int $contactId + * Id of the contact whose activities need to find. * * @return array array of activity fields */ @@ -1755,8 +1781,10 @@ WHERE activity.id IN ($activityIds)"; /** * Add activity for Membership/Event/Contribution * - * @param object $activity (reference) particular component object - * @param string $activityType for Membership Signup or Renewal + * @param object $activity + * (reference) particular component object. + * @param string $activityType + * For Membership Signup or Renewal. * @param int $targetContactID * * @return bool @@ -1872,7 +1900,8 @@ SELECT display_name /** * Get Parent activity for currently viewed activity * - * @param int $activityId current activity id + * @param int $activityId + * Current activity id. * * @return int $parentId Id of parent activity otherwise false. */ @@ -1898,7 +1927,8 @@ SELECT display_name /** * Get total count of prior revision of currently viewd activity * - * @param $activityID current activity id + * @param $activityID + * Current activity id. * * @return int $params count of prior activities otherwise false. */ @@ -1934,7 +1964,8 @@ AND id < {$activityID} /** * Get all prior activities of currently viewed activity * - * @param $activityID current activity id + * @param $activityID + * Current activity id. * @param bool $onlyPriorRevisions * * @return array $result prior activities info. @@ -1983,7 +2014,8 @@ AND cl.modified_id = c.id /** * Find the latest revision of a given activity * - * @param int $activityID prior activity id + * @param int $activityID + * Prior activity id. * * @return int current activity id. */ @@ -2014,7 +2046,8 @@ AND cl.modified_id = c.id /** * Create a follow up a given activity * - * @param $activityId int activity id of parent activity + * @param $activityId + * Int activity id of parent activity. * @param array $params * * @return $this|null|object @@ -2053,7 +2086,8 @@ AND cl.modified_id = c.id /** * Get Activity specific File according activity type Id. * - * @param int $activityTypeId activity id + * @param int $activityTypeId + * Activity id. * @param string $crmDir * * @return string|bool if file exists returns $activityTypeFile activity filename otherwise false. @@ -2087,7 +2121,8 @@ AND cl.modified_id = c.id /** * Restore the activity * - * @param array $params associated array + * @param array $params + * Associated array. * * @return void * @@ -2105,7 +2140,8 @@ AND cl.modified_id = c.id /** * Get the exportable fields for Activities * - * @param string $name if it is called by case $name = Case else $name = Activity + * @param string $name + * If it is called by case $name = Case else $name = Activity. * * @return array array of exportable Fields * @static @@ -2197,7 +2233,8 @@ AND cl.modified_id = c.id * This function deletes the activity record related to contact record, * when there are no target and assignee record w/ other contact. * - * @param int $contactId contactId + * @param int $contactId + * ContactId. * * @return true/null */ @@ -2243,8 +2280,10 @@ AND cl.modified_id = c.id /** * Does user has sufficient permission for view/edit activity record? * - * @param int $activityId activity record id. - * @param int $action edit/view + * @param int $activityId + * Activity record id. + * @param int $action + * Edit/view. * * @return boolean $allow true/false */ @@ -2391,7 +2430,8 @@ INNER JOIN civicrm_option_group grp ON ( grp.id = val.option_group_id AND grp.n /** * This function is a wrapper for ajax activity selector * - * @param array $params associated array for params record id. + * @param array $params + * Associated array for params record id. * * @return array $contactActivities associated array of contact activities */ diff --git a/CRM/Activity/BAO/ActivityAssignment.php b/CRM/Activity/BAO/ActivityAssignment.php index 32971d7d44..94279db174 100644 --- a/CRM/Activity/BAO/ActivityAssignment.php +++ b/CRM/Activity/BAO/ActivityAssignment.php @@ -49,7 +49,8 @@ class CRM_Activity_BAO_ActivityAssignment extends CRM_Activity_DAO_ActivityConta /** * Add activity assignment. * - * @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 type of object that is added */ @@ -100,9 +101,12 @@ AND civicrm_contact.is_deleted = 0 /** * Retrieve assignee names by activity_id * - * @param array $activityIDs IDs of the activities - * @param boolean $isDisplayName if set returns display names of assignees - * @param boolean $skipDetails if false returns all details of assignee contact. + * @param array $activityIDs + * IDs of the activities. + * @param bool $isDisplayName + * If set returns display names of assignees. + * @param bool $skipDetails + * If false returns all details of assignee contact. * * @return array * diff --git a/CRM/Activity/BAO/ActivityContact.php b/CRM/Activity/BAO/ActivityContact.php index 99d5ff5424..106144f505 100644 --- a/CRM/Activity/BAO/ActivityContact.php +++ b/CRM/Activity/BAO/ActivityContact.php @@ -49,7 +49,8 @@ class CRM_Activity_BAO_ActivityContact extends CRM_Activity_DAO_ActivityContact /** * Funtion to add activity contact * - * @param array $params the values for this table: activity id, contact id, record type + * @param array $params + * The values for this table: activity id, contact id, record type. * * @return object activity_contact object * diff --git a/CRM/Activity/BAO/ICalendar.php b/CRM/Activity/BAO/ICalendar.php index 901bfe9d18..598f27c43c 100644 --- a/CRM/Activity/BAO/ICalendar.php +++ b/CRM/Activity/BAO/ICalendar.php @@ -47,7 +47,8 @@ class CRM_Activity_BAO_ICalendar { /** * Constructor * - * @param object $act Reference to an activity object + * @param object $act + * Reference to an activity object. * * @return \CRM_Activity_BAO_ICalendar @access public @@ -59,8 +60,10 @@ class CRM_Activity_BAO_ICalendar { /** * Add an ics attachment to the input array * - * @param array $attachments Reference to array in same format returned from CRM_Core_BAO_File::getEntityFile() - * @param array $contacts Array of contacts (attendees) + * @param array $attachments + * Reference to array in same format returned from CRM_Core_BAO_File::getEntityFile(). + * @param array $contacts + * Array of contacts (attendees). * * @return string Array index of the added attachment in the $attachments array, or else null. */ diff --git a/CRM/Activity/Form/Activity.php b/CRM/Activity/Form/Activity.php index b701387e83..56a02c74da 100644 --- a/CRM/Activity/Form/Activity.php +++ b/CRM/Activity/Form/Activity.php @@ -814,8 +814,10 @@ class CRM_Activity_Form_Activity extends CRM_Contact_Form_Task { /** * 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 @@ -995,7 +997,8 @@ class CRM_Activity_Form_Activity extends CRM_Contact_Form_Task { /** * Process activity creation * - * @param array $params associated array of submitted values + * @param array $params + * Associated array of submitted values. * * @return $this|null|object */ diff --git a/CRM/Activity/Form/Task.php b/CRM/Activity/Form/Task.php index 864854939a..f9aea5225d 100644 --- a/CRM/Activity/Form/Task.php +++ b/CRM/Activity/Form/Task.php @@ -174,8 +174,10 @@ WHERE activity_id IN ( $IDs ) AND * 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/Activity/Form/Task/PickOption.php b/CRM/Activity/Form/Task/PickOption.php index ce8981551f..dba91bc410 100644 --- a/CRM/Activity/Form/Task/PickOption.php +++ b/CRM/Activity/Form/Task/PickOption.php @@ -118,7 +118,8 @@ class CRM_Activity_Form_Task_PickOption extends CRM_Activity_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/Activity/Form/Task/PickProfile.php b/CRM/Activity/Form/Task/PickProfile.php index 7988fd6730..ffc938ffea 100755 --- a/CRM/Activity/Form/Task/PickProfile.php +++ b/CRM/Activity/Form/Task/PickProfile.php @@ -146,7 +146,8 @@ class CRM_Activity_Form_Task_PickProfile extends CRM_Activity_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/Activity/Import/Form/MapField.php b/CRM/Activity/Import/Form/MapField.php index ebac84585e..e8b38d7128 100644 --- a/CRM/Activity/Import/Form/MapField.php +++ b/CRM/Activity/Import/Form/MapField.php @@ -267,7 +267,8 @@ class CRM_Activity_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. * * @return array list of errors to be posted back to the form * @static diff --git a/CRM/Activity/Import/Parser/Activity.php b/CRM/Activity/Import/Parser/Activity.php index c31712ec7a..4aa252125a 100644 --- a/CRM/Activity/Import/Parser/Activity.php +++ b/CRM/Activity/Import/Parser/Activity.php @@ -129,7 +129,8 @@ class CRM_Activity_Import_Parser_Activity extends CRM_Activity_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 */ @@ -140,7 +141,8 @@ class CRM_Activity_Import_Parser_Activity extends CRM_Activity_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 */ @@ -151,7 +153,8 @@ class CRM_Activity_Import_Parser_Activity extends CRM_Activity_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 */ @@ -232,8 +235,10 @@ class CRM_Activity_Import_Parser_Activity extends CRM_Activity_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 */ diff --git a/CRM/Activity/Selector/Activity.php b/CRM/Activity/Selector/Activity.php index 8cfe002cb8..75ee5126f2 100644 --- a/CRM/Activity/Selector/Activity.php +++ b/CRM/Activity/Selector/Activity.php @@ -65,8 +65,10 @@ class CRM_Activity_Selector_Activity extends CRM_Core_Selector_Base implements C /** * Class constructor * - * @param int $contactId - contact whose activities we want to display - * @param int $permission - the permission we have for this contact + * @param int $contactId + * Contact whose activities we want to display. + * @param int $permission + * The permission we have for this contact. * * @param bool $admin * @param string $context @@ -289,8 +291,10 @@ class CRM_Activity_Selector_Activity extends CRM_Core_Selector_Base implements 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 */ @@ -312,7 +316,8 @@ class CRM_Activity_Selector_Activity extends CRM_Core_Selector_Base implements C /** * Returns total number of rows for the query. * - * @param string $action - action being performed + * @param string $action + * Action being performed. * * @param null $case * @@ -335,11 +340,16 @@ class CRM_Activity_Selector_Activity extends CRM_Core_Selector_Base implements 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). * * @param null $case * @@ -461,7 +471,8 @@ class CRM_Activity_Selector_Activity extends CRM_Core_Selector_Base implements 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/Activity/Selector/Search.php b/CRM/Activity/Selector/Search.php index 20dea8c37b..ba99110877 100644 --- a/CRM/Activity/Selector/Search.php +++ b/CRM/Activity/Selector/Search.php @@ -141,11 +141,15 @@ class CRM_Activity_Selector_Search extends CRM_Core_Selector_Base implements CRM /** * 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 $activityClause if the caller wants to further restrict the search (used in activities) - * @param boolean $single are we dealing only with one contact? - * @param int $limit how many activities do we want returned + * @param string $activityClause + * If the caller wants to further restrict the search (used in activities). + * @param bool $single + * Are we dealing only with one contact?. + * @param int $limit + * How many activities do we want returned. * * @param string $context * @param null $compContext @@ -218,11 +222,16 @@ class CRM_Activity_Selector_Search extends CRM_Core_Selector_Base implements CRM /** * 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 array rows in the given offset and rowCount */ @@ -360,8 +369,10 @@ class CRM_Activity_Selector_Search extends CRM_Core_Selector_Base implements CRM * 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 */ @@ -420,7 +431,8 @@ class CRM_Activity_Selector_Search extends CRM_Core_Selector_Base implements CRM /** * 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/Activity/StateMachine/Search.php b/CRM/Activity/StateMachine/Search.php index 811bbefaad..aa1dbcf8f1 100644 --- a/CRM/Activity/StateMachine/Search.php +++ b/CRM/Activity/StateMachine/Search.php @@ -69,7 +69,8 @@ class CRM_Activity_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 * -- 2.25.1