From 7aaf6db0e1b2748043a5a5d8848e0b8fbd60f0c0 Mon Sep 17 00:00:00 2001 From: Tim Otten Date: Tue, 6 Jan 2015 11:41:07 -0800 Subject: [PATCH] INFRA-132 - CRM/Campaign - Convert single-line @param to multi-line --- CRM/Campaign/BAO/Campaign.php | 30 +++++++---- CRM/Campaign/BAO/Petition.php | 9 ++-- CRM/Campaign/BAO/Query.php | 3 +- CRM/Campaign/BAO/Survey.php | 69 +++++++++++++++++--------- CRM/Campaign/Form/Task.php | 6 ++- CRM/Campaign/Form/Task/Reserve.php | 3 +- CRM/Campaign/Page/Petition/Confirm.php | 9 ++-- CRM/Campaign/Page/SurveyType.php | 3 +- CRM/Campaign/Selector/Search.php | 36 +++++++++----- CRM/Campaign/StateMachine/Search.php | 3 +- 10 files changed, 113 insertions(+), 58 deletions(-) diff --git a/CRM/Campaign/BAO/Campaign.php b/CRM/Campaign/BAO/Campaign.php index 5485b48874..0e78c78ddf 100644 --- a/CRM/Campaign/BAO/Campaign.php +++ b/CRM/Campaign/BAO/Campaign.php @@ -41,7 +41,8 @@ Class CRM_Campaign_BAO_Campaign extends CRM_Campaign_DAO_Campaign { * contact 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_Campaign_DAO_Campaign object * @static @@ -100,7 +101,8 @@ Class CRM_Campaign_BAO_Campaign extends CRM_Campaign_DAO_Campaign { /** * Delete the campaign * - * @param int $id id of the campaign + * @param int $id + * Id of the campaign. * * @return bool|mixed */ @@ -118,8 +120,10 @@ Class CRM_Campaign_BAO_Campaign extends CRM_Campaign_DAO_Campaign { * retrieves the relevant objects. Typically the valid params are only * campaign_id. * - * @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_Campaign_DAO_Campaign|null */ @@ -138,9 +142,12 @@ Class CRM_Campaign_BAO_Campaign extends CRM_Campaign_DAO_Campaign { /** * Return the all eligible campaigns w/ cache. * - * @param int $includeId lets inlcude this campaign by force. - * @param int $excludeId do not include this campaign. - * @param boolean $onlyActive consider only active campaigns. + * @param int $includeId + * Lets inlcude this campaign by force. + * @param int $excludeId + * Do not include this campaign. + * @param bool $onlyActive + * Consider only active campaigns. * * @param bool $onlyCurrent * @param bool $appendDatesToTitle @@ -465,7 +472,8 @@ SELECT campaign.id as id, /** * Get Campaigns groups * - * @param int $campaignId campaign id + * @param int $campaignId + * Campaign id. * * @return array * @static @@ -499,8 +507,10 @@ INNER JOIN civicrm_group grp ON ( grp.id = campgrp.entity_id ) /** * 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 diff --git a/CRM/Campaign/BAO/Petition.php b/CRM/Campaign/BAO/Petition.php index 26393d99c8..18f485206f 100644 --- a/CRM/Campaign/BAO/Petition.php +++ b/CRM/Campaign/BAO/Petition.php @@ -173,7 +173,8 @@ SELECT petition.id as id, /** * Takes an associative array and creates a petition signature activity * - * @param array $params (reference ) an assoc array of name/value pairs + * @param array $params + * (reference ) an assoc array of name/value pairs. * * @return CRM_Campaign_BAO_Petition * @static @@ -462,7 +463,8 @@ AND tag_id = ( SELECT id FROM civicrm_tag WHERE name = %2 )"; /** * This function returns all entities assigned to a specific tag * - * @param object $tag an object of a tag. + * @param object $tag + * An object of a tag. * * @return array $contactIds array of contact ids */ @@ -534,7 +536,8 @@ AND tag_id = ( SELECT id FROM civicrm_tag WHERE name = %2 )"; /** * Takes an associative array and sends a thank you or email verification email * - * @param array $params (reference ) an assoc array of name/value pairs + * @param array $params + * (reference ) an assoc array of name/value pairs. * * @param $sendEmailMode * diff --git a/CRM/Campaign/BAO/Query.php b/CRM/Campaign/BAO/Query.php index 4eeaf8a584..75fdd8f910 100755 --- a/CRM/Campaign/BAO/Query.php +++ b/CRM/Campaign/BAO/Query.php @@ -448,7 +448,8 @@ INNER JOIN civicrm_custom_group grp on fld.custom_group_id = grp.id * Retrieve all valid voter ids, * and build respective clause to restrict search. * - * @param array $criteria an array + * @param array $criteria + * An array. * @return $voterClause as a string * @static */ diff --git a/CRM/Campaign/BAO/Survey.php b/CRM/Campaign/BAO/Survey.php index 1ebf0e5e8a..feca48aa87 100644 --- a/CRM/Campaign/BAO/Survey.php +++ b/CRM/Campaign/BAO/Survey.php @@ -44,8 +44,10 @@ class CRM_Campaign_BAO_Survey extends CRM_Campaign_DAO_Survey { * retrieves the relevant objects. Typically the valid params are only * campaign_id. * - * @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. * */ @@ -242,10 +244,14 @@ SELECT survey.id as id, /** * Get Surveys * - * @param boolean $onlyActive retrieve only active surveys. - * @param boolean $onlyDefault retrieve only default survey. - * @param boolean $forceAll retrieve all surveys. - * @param boolean $includePetition include or exclude petitions + * @param bool $onlyActive + * Retrieve only active surveys. + * @param bool $onlyDefault + * Retrieve only default survey. + * @param bool $forceAll + * Retrieve all surveys. + * @param bool $includePetition + * Include or exclude petitions. * * @static */ @@ -334,7 +340,8 @@ SELECT survey.id as id, /** * Get Surveys custom groups * - * @param $surveyTypes array an array of survey type id. + * @param $surveyTypes + * Array an array of survey type id. * * @return array * @static @@ -374,8 +381,10 @@ SELECT survey.id as id, /** * 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 @@ -387,7 +396,8 @@ SELECT survey.id as id, /** * Delete the survey * - * @param int $id survey id + * @param int $id + * Survey id. * * @return mixed|null * @static @@ -410,7 +420,8 @@ SELECT survey.id as id, * This function retrieve contact information. * * @param array $voterIds - * @param array $returnProperties an array of return elements. + * @param array $returnProperties + * An array of return elements. * * @return array $voterDetails array of contact info. * @static @@ -499,8 +510,10 @@ Group By contact.id"; /** * This function retrieve survey related activities w/ for give voter ids. * - * @param int $surveyId survey id. - * @param array $voterIds voterIds. + * @param int $surveyId + * Survey id. + * @param array $voterIds + * VoterIds. * * @param int $interviewerId * @param array $statusIds @@ -560,7 +573,8 @@ INNER JOIN civicrm_activity_contact activityAssignment /** * This function retrieve survey related activities. * - * @param int $surveyId survey id. + * @param int $surveyId + * Survey id. * * @param int $interviewerId * @param null $statusIds @@ -662,9 +676,12 @@ INNER JOIN civicrm_contact contact_a ON ( activityTarget.contact_id = contact_a /** * This function retrieve survey voter information. * - * @param int $surveyId survey id. - * @param int $interviewerId interviewer id. - * @param array $statusIds survey status ids. + * @param int $surveyId + * Survey id. + * @param int $interviewerId + * Interviewer id. + * @param array $statusIds + * Survey status ids. * * @return array $$contactIds survey related contact ids. * @static @@ -717,7 +734,8 @@ INNER JOIN civicrm_contact contact_a ON ( activityTarget.contact_id = contact_a /** * This function is to check survey activity. * - * @param int $activityId activity id. + * @param int $activityId + * Activity id. * @return boolean $isSurveyActivity true/false * @static */ @@ -745,7 +763,8 @@ INNER JOIN civicrm_contact contact_a ON ( activityTarget.contact_id = contact_a /** * This function retrive all response options of survey * - * @param int $surveyId survey id. + * @param int $surveyId + * Survey id. * @return array $responseOptions an array of option values@static */ public static function getResponsesOptions($surveyId) { @@ -935,8 +954,10 @@ INNER JOIN civicrm_contact contact_a ON ( activityTarget.contact_id = contact_a * Get the valid survey response fields those * are configured with profile and custom fields. * - * @param int $surveyId survey id. - * @param int $surveyTypeId survey activity type id. + * @param int $surveyId + * Survey id. + * @param int $surveyTypeId + * Survey activity type id. * * @return array an array of valid survey response fields. */ @@ -1106,9 +1127,9 @@ UPDATE civicrm_activity * Get options for a given field. * @see CRM_Core_DAO::buildOptions * - * @param String $fieldName - * @param String $context: @see CRM_Core_DAO::buildOptionsContext - * @param Array $props: whatever is known about this dao object + * @param string $fieldName + * @param string $context: @see CRM_Core_DAO::buildOptionsContext + * @param array $props: whatever is known about this dao object * * @return array|bool */ diff --git a/CRM/Campaign/Form/Task.php b/CRM/Campaign/Form/Task.php index be6cfefe4a..cde042f94a 100755 --- a/CRM/Campaign/Form/Task.php +++ b/CRM/Campaign/Form/Task.php @@ -135,8 +135,10 @@ class CRM_Campaign_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/Campaign/Form/Task/Reserve.php b/CRM/Campaign/Form/Task/Reserve.php index bc8cc7e620..7326c554e4 100644 --- a/CRM/Campaign/Form/Task/Reserve.php +++ b/CRM/Campaign/Form/Task/Reserve.php @@ -201,7 +201,8 @@ class CRM_Campaign_Form_Task_Reserve extends CRM_Campaign_Form_Task { /** * 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/Campaign/Page/Petition/Confirm.php b/CRM/Campaign/Page/Petition/Confirm.php index 24028dc763..d356dca8ce 100644 --- a/CRM/Campaign/Page/Petition/Confirm.php +++ b/CRM/Campaign/Page/Petition/Confirm.php @@ -93,9 +93,12 @@ class CRM_Campaign_Page_Petition_Confirm extends CRM_Core_Page { /** * Confirm email verification * - * @param int $contact_id The id of the contact - * @param int $subscribe_id The id of the subscription event - * @param string $hash The hash + * @param int $contact_id + * The id of the contact. + * @param int $subscribe_id + * The id of the subscription event. + * @param string $hash + * The hash. * * @param int $activity_id * @param int $petition_id diff --git a/CRM/Campaign/Page/SurveyType.php b/CRM/Campaign/Page/SurveyType.php index f6c9523d17..93b9e4a326 100644 --- a/CRM/Campaign/Page/SurveyType.php +++ b/CRM/Campaign/Page/SurveyType.php @@ -207,7 +207,8 @@ class CRM_Campaign_Page_SurveyType extends CRM_Core_Page_Basic { /** * Get userContext params * - * @param int $mode mode that we are in + * @param int $mode + * Mode that we are in. * * @return string */ diff --git a/CRM/Campaign/Selector/Search.php b/CRM/Campaign/Selector/Search.php index 049a626e21..e967a56a28 100755 --- a/CRM/Campaign/Selector/Search.php +++ b/CRM/Campaign/Selector/Search.php @@ -134,11 +134,15 @@ class CRM_Campaign_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 $surveyClause if the caller wants to further restrict the search. - * @param boolean $single are we dealing only with one contact? - * @param int $limit how many voters do we want returned + * @param string $surveyClause + * If the caller wants to further restrict the search. + * @param bool $single + * Are we dealing only with one contact?. + * @param int $limit + * How many voters do we want returned. * * @param string $context * @@ -223,11 +227,16 @@ class CRM_Campaign_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 int the total number of rows for this action */ @@ -310,8 +319,10 @@ FROM {$from} * 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 */ @@ -360,7 +371,8 @@ FROM {$from} /** * 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/Campaign/StateMachine/Search.php b/CRM/Campaign/StateMachine/Search.php index 073a4c11e2..c5fd3cfe2b 100755 --- a/CRM/Campaign/StateMachine/Search.php +++ b/CRM/Campaign/StateMachine/Search.php @@ -72,7 +72,8 @@ class CRM_Campaign_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