From cde2037df0fa7e95c12954ca67a3a5da1973b7e1 Mon Sep 17 00:00:00 2001 From: Eileen McNaughton Date: Mon, 2 Feb 2015 12:20:25 +1300 Subject: [PATCH] a few comment fixes --- CRM/Campaign/BAO/Petition.php | 4 ++ CRM/Campaign/StateMachine/Search.php | 3 ++ CRM/Case/BAO/Case.php | 58 +++++++++++++++++----------- CRM/Case/Form/Task/Delete.php | 11 ++---- CRM/Case/StateMachine/Search.php | 3 ++ CRM/Case/XMLProcessor/Process.php | 1 + CRM/Contact/BAO/ProximityQuery.php | 2 + CRM/Contact/BAO/Query.php | 4 +- 8 files changed, 52 insertions(+), 34 deletions(-) diff --git a/CRM/Campaign/BAO/Petition.php b/CRM/Campaign/BAO/Petition.php index 42cb414b68..a3fd7919b1 100644 --- a/CRM/Campaign/BAO/Petition.php +++ b/CRM/Campaign/BAO/Petition.php @@ -44,6 +44,10 @@ class CRM_Campaign_BAO_Petition extends CRM_Campaign_BAO_Survey { /** * Get Petition Details for dashboard. * + * @param array $params + * @param bool $onlyCount + * + * @return array|int */ public static function getPetitionSummary($params = array(), $onlyCount = FALSE) { //build the limit and order clause. diff --git a/CRM/Campaign/StateMachine/Search.php b/CRM/Campaign/StateMachine/Search.php index 12d19f47d9..6084477bce 100755 --- a/CRM/Campaign/StateMachine/Search.php +++ b/CRM/Campaign/StateMachine/Search.php @@ -43,6 +43,9 @@ class CRM_Campaign_StateMachine_Search extends CRM_Core_StateMachine { /** * Class constructor + * + * @param object $controller + * @param \const|int $action */ public function __construct($controller, $action = CRM_Core_Action::NONE) { parent::__construct($controller, $action); diff --git a/CRM/Case/BAO/Case.php b/CRM/Case/BAO/Case.php index 7df56b3dc3..6c6601bbd9 100644 --- a/CRM/Case/BAO/Case.php +++ b/CRM/Case/BAO/Case.php @@ -34,19 +34,20 @@ */ /** - * This class contains the functions for Case Management + * This class contains the functions for Case Management. * */ class CRM_Case_BAO_Case extends CRM_Case_DAO_Case { /** - * Static field for all the case information that we can potentially export + * Static field for all the case information that we can potentially export. * * @var array */ static $_exportableFields = NULL; /** + * Class constructor. */ public function __construct() { parent::__construct(); @@ -63,9 +64,9 @@ class CRM_Case_BAO_Case extends CRM_Case_DAO_Case { } /** - * Takes an associative array and creates a case object + * Create a case object. * - * the function extract all the params it needs to initialize the create a + * The function extracts all the params it needs to initialize the create a * case object. the params array could contain additional unused name/value * pairs * @@ -82,7 +83,7 @@ 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 + * and store the values in the values array. * * @param array $params * Input parameters to find object. @@ -91,7 +92,8 @@ class CRM_Case_BAO_Case extends CRM_Case_DAO_Case { * @param array $ids * The array that holds all the db ids. * - * @return CRM_Case_BAO_Case|null the found object or null + * @return CRM_Case_BAO_Case|null + * The found object or null */ public static function &getValues(&$params, &$values, &$ids) { $case = new CRM_Case_BAO_Case(); @@ -107,10 +109,10 @@ class CRM_Case_BAO_Case extends CRM_Case_DAO_Case { } /** - * Takes an associative array and creates a case object + * Takes an associative array and creates a case object. * * @param array $params - * (reference ) an assoc array of name/value pairs. + * (reference) an assoc array of name/value pairs. * * @return CRM_Case_BAO_Case */ @@ -151,7 +153,7 @@ class CRM_Case_BAO_Case extends CRM_Case_DAO_Case { } /** - * Create case contact record + * Create case contact record. * * @param array $params * case_id, contact_id @@ -194,11 +196,9 @@ class CRM_Case_BAO_Case extends CRM_Case_DAO_Case { } /** - * Delet case contact record + * Delete case contact record. * * @param int $caseID - * - * @return void */ public static function deleteCaseContact($caseID) { $caseContact = new CRM_Case_DAO_CaseContact(); @@ -214,12 +214,18 @@ class CRM_Case_BAO_Case extends CRM_Case_DAO_Case { } /** - * convert associative array names to values - * and vice-versa. + * Convert associative array names to values and vice-versa. * * This function is used by both the web form layer and the api. Note that * the api needs the name => value conversion, also the view layer typically * requires value => name conversion + * + * @param array $defaults + * @param string $property + * @param array $lookup + * @param bool $reverse + * + * @return bool */ public static function lookupValue(&$defaults, $property, &$lookup, $reverse) { $id = $property . '_id'; @@ -281,7 +287,7 @@ class CRM_Case_BAO_Case extends CRM_Case_DAO_Case { } /** - * Get the case subject for Activity + * Get the case subject for Activity. * * @param int $activityId * Activity id. @@ -374,7 +380,7 @@ WHERE civicrm_case.id = %1"; } /** - * Enable disable case related relationships + * Enable disable case related relationships. * * @param int $caseId * Case id. @@ -400,7 +406,7 @@ WHERE civicrm_case.id = %1"; } /** - * Delete the activities related to case + * Delete the activities related to case. * * @param int $activityId * Id of the activity. @@ -440,7 +446,7 @@ WHERE civicrm_case.id = %1"; } /** - * Look up a case using an activity ID + * Look up a case using an activity ID. * * @param int $activityId * @@ -505,7 +511,7 @@ WHERE civicrm_case.id = %1"; } /** - * Retrieve case_id by contact_id + * Retrieve case_id by contact_id. * * @param int $contactID * @param bool $includeDeleted @@ -702,8 +708,7 @@ 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 + * Retrieve cases related to particular contact or whole contact used in Dashboard and Tab. * * @param bool $allCases * @@ -2034,14 +2039,16 @@ SELECT civicrm_contact.id as casemanager_id, } /** - * Get all cases with no end dates + * Get all cases with no end dates. * * @param array $params * @param array $excludeCaseIds * @param bool $excludeDeleted * + * @param bool $includeClosed + * * @return array - * case and related data keyed on case id + * Case and related data keyed on case id */ public static function getUnclosedCases($params = array(), $excludeCaseIds = array(), $excludeDeleted = TRUE, $includeClosed = FALSE) { //params from ajax call. @@ -2319,6 +2326,9 @@ INNER JOIN civicrm_case_contact ON ( civicrm_case.id = civicrm_case_contact.cas * @see CRM_Dedupe_Merger::cpTables() * * TODO: use the 3rd $sqls param to append sql statements rather than executing them here + * + * @param int $mainContactId + * @param int $otherContactId */ public static function mergeContacts($mainContactId, $otherContactId) { self::mergeCases($mainContactId, NULL, $otherContactId); @@ -3282,6 +3292,8 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')'; /** * Helper function, also used by the upgrade in case of error * + * @param string $section + * * @return string */ public static function createCaseViewsQuery($section = 'upcoming') { diff --git a/CRM/Case/Form/Task/Delete.php b/CRM/Case/Form/Task/Delete.php index f6d4819cd1..6021879485 100644 --- a/CRM/Case/Form/Task/Delete.php +++ b/CRM/Case/Form/Task/Delete.php @@ -35,7 +35,7 @@ /** * This class provides the functionality to delete a group of - * participations. This class provides functionality for the actual + * case records. This class provides functionality for the actual * deletion. */ class CRM_Case_Form_Task_Delete extends CRM_Case_Form_Task { @@ -56,12 +56,9 @@ class CRM_Case_Form_Task_Delete extends CRM_Case_Form_Task { public $_moveToTrash = TRUE; /** - * Build all the data structures needed to build the form - * - * @return void + * Build all the data structures needed to build the form. */ public function preProcess() { - //check for delete if (!CRM_Core_Permission::checkActionPermission('CiviCase', CRM_Core_Action::DELETE)) { CRM_Core_Error::fatal(ts('You do not have permission to access this page.')); } @@ -71,7 +68,6 @@ class CRM_Case_Form_Task_Delete extends CRM_Case_Form_Task { /** * Build the form object * - * * @return void */ public function buildQuickForm() { @@ -79,8 +75,7 @@ class CRM_Case_Form_Task_Delete extends CRM_Case_Form_Task { } /** - * Process the form after the input has been submitted and validated - * + * Process the form after the input has been submitted and validated. * * @return void */ diff --git a/CRM/Case/StateMachine/Search.php b/CRM/Case/StateMachine/Search.php index 02e8def86d..12e3edc7d5 100644 --- a/CRM/Case/StateMachine/Search.php +++ b/CRM/Case/StateMachine/Search.php @@ -43,6 +43,9 @@ class CRM_Case_StateMachine_Search extends CRM_Core_StateMachine { /** * Class constructor + * + * @param object $controller + * @param \const|int $action */ public function __construct($controller, $action = CRM_Core_Action::NONE) { parent::__construct($controller, $action); diff --git a/CRM/Case/XMLProcessor/Process.php b/CRM/Case/XMLProcessor/Process.php index b3afe3d3ec..fa575b80e0 100644 --- a/CRM/Case/XMLProcessor/Process.php +++ b/CRM/Case/XMLProcessor/Process.php @@ -37,6 +37,7 @@ class CRM_Case_XMLProcessor_Process extends CRM_Case_XMLProcessor { * @param $caseType * @param array $params * + * @return bool * @throws Exception */ public function run($caseType, &$params) { diff --git a/CRM/Contact/BAO/ProximityQuery.php b/CRM/Contact/BAO/ProximityQuery.php index 021dbadf6c..ef20040094 100644 --- a/CRM/Contact/BAO/ProximityQuery.php +++ b/CRM/Contact/BAO/ProximityQuery.php @@ -365,6 +365,8 @@ ACOS( /** * @param array $input * retun void + * + * @return null */ public static function fixInputParams(&$input) { foreach ($input as $param) { diff --git a/CRM/Contact/BAO/Query.php b/CRM/Contact/BAO/Query.php index a809ac54dc..6e837043f3 100644 --- a/CRM/Contact/BAO/Query.php +++ b/CRM/Contact/BAO/Query.php @@ -3289,11 +3289,9 @@ WHERE id IN ( $groupIDs ) } /* - * Where/qill clause for greeting fields + * Where/qill clause for greeting fields. * * @param array $values - * - * @return void */ function greetings(&$values) { list($name, $op, $value, $grouping, $wildcard) = $values; -- 2.25.1