From 67d192996ffd7c3c352e1374e084dc70b6a823a8 Mon Sep 17 00:00:00 2001 From: eileenmcnaugton Date: Mon, 31 Aug 2015 23:35:34 +1200 Subject: [PATCH] more comment fixes --- CRM/Campaign/Form/Task/Reserve.php | 5 ++--- CRM/Campaign/Page/Petition/Confirm.php | 2 -- CRM/Campaign/Page/Petition/ThankYou.php | 4 ++-- CRM/Campaign/Page/Vote.php | 2 -- CRM/Campaign/Selector/Search.php | 7 +------ CRM/Case/BAO/Case.php | 5 ++--- CRM/Case/BAO/CaseType.php | 5 +---- CRM/Case/BAO/Query.php | 2 +- CRM/Case/Config.php | 2 -- CRM/Case/Controller/Search.php | 2 -- CRM/Case/Form/Activity.php | 2 -- CRM/Case/Form/Task/Result.php | 10 +-------- CRM/Case/Form/Task/SearchTaskHookSample.php | 6 ------ CRM/Case/Info.php | 2 -- CRM/Case/Page/CaseDetails.php | 7 +++---- CRM/Case/Page/DashBoard.php | 9 +++----- CRM/Case/Page/Tab.php | 11 ++-------- CRM/Case/PseudoConstant.php | 3 --- CRM/Case/Selector/Search.php | 7 +------ CRM/Case/StateMachine/Search.php | 2 -- CRM/Case/Task.php | 6 ++---- CRM/Case/XMLProcessor.php | 2 -- CRM/Case/XMLProcessor/Process.php | 6 +++--- CRM/Case/XMLProcessor/Report.php | 2 -- CRM/Case/XMLProcessor/Settings.php | 8 +++---- CRM/Case/XMLRepository.php | 1 - CRM/Contact/BAO/Contact.php | 1 - CRM/Contact/BAO/Contact/Location.php | 4 +--- CRM/Contact/BAO/Contact/Optimizer.php | 8 +++---- CRM/Contact/BAO/Contact/Permission.php | 4 ---- CRM/Contact/BAO/Contact/Utils.php | 12 ++--------- CRM/Contact/BAO/ContactType.php | 6 ++---- CRM/Contact/BAO/DashboardContact.php | 1 - CRM/Contact/BAO/Group.php | 12 +++++------ CRM/Contact/BAO/GroupContact.php | 7 ------- CRM/Contact/BAO/GroupContactCache.php | 9 +++----- CRM/Contact/BAO/GroupNesting.php | 9 -------- CRM/Contact/BAO/GroupNestingCache.php | 8 +++++-- CRM/Contact/BAO/GroupOrganization.php | 4 ---- CRM/Contact/BAO/Household.php | 4 +--- CRM/Contact/BAO/Individual.php | 10 +++------ CRM/Contact/BAO/ProximityQuery.php | 8 +++---- CRM/Contact/BAO/Query.php | 23 +++++++-------------- 43 files changed, 67 insertions(+), 183 deletions(-) diff --git a/CRM/Campaign/Form/Task/Reserve.php b/CRM/Campaign/Form/Task/Reserve.php index 817b67e898..14b0e9d735 100644 --- a/CRM/Campaign/Form/Task/Reserve.php +++ b/CRM/Campaign/Form/Task/Reserve.php @@ -37,9 +37,8 @@ class CRM_Campaign_Form_Task_Reserve extends CRM_Campaign_Form_Task { /** - * Survet id` - * * @var int + * Survey id. */ protected $_surveyId; @@ -232,7 +231,7 @@ class CRM_Campaign_Form_Task_Reserve extends CRM_Campaign_Form_Task { /** * Process the form after the input has been submitted and validated. - */ + */ public function postProcess() { //add reservation. $countVoters = 0; diff --git a/CRM/Campaign/Page/Petition/Confirm.php b/CRM/Campaign/Page/Petition/Confirm.php index b36d0693c5..cf5e020936 100644 --- a/CRM/Campaign/Page/Petition/Confirm.php +++ b/CRM/Campaign/Page/Petition/Confirm.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Campaign_Page_Petition_Confirm extends CRM_Core_Page { /** diff --git a/CRM/Campaign/Page/Petition/ThankYou.php b/CRM/Campaign/Page/Petition/ThankYou.php index ed0575c935..6c27ba2bc0 100644 --- a/CRM/Campaign/Page/Petition/ThankYou.php +++ b/CRM/Campaign/Page/Petition/ThankYou.php @@ -29,11 +29,11 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Campaign_Page_Petition_ThankYou extends CRM_Core_Page { /** + * Run page. + * * @return string */ public function run() { diff --git a/CRM/Campaign/Page/Vote.php b/CRM/Campaign/Page/Vote.php index b1d83e1d86..5c9ea35959 100644 --- a/CRM/Campaign/Page/Vote.php +++ b/CRM/Campaign/Page/Vote.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** diff --git a/CRM/Campaign/Selector/Search.php b/CRM/Campaign/Selector/Search.php index a0151c66cf..bc9dc5e176 100755 --- a/CRM/Campaign/Selector/Search.php +++ b/CRM/Campaign/Selector/Search.php @@ -29,15 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class is used to retrieve and display a range of - * contacts that match the given criteria (specifically for - * results of advanced search options. - * + * This class is used to retrieve and display a range of contacts that match the given criteria. */ class CRM_Campaign_Selector_Search extends CRM_Core_Selector_Base implements CRM_Core_Selector_API { diff --git a/CRM/Case/BAO/Case.php b/CRM/Case/BAO/Case.php index 0d3b5337ca..33f89bbb8e 100644 --- a/CRM/Case/BAO/Case.php +++ b/CRM/Case/BAO/Case.php @@ -33,7 +33,6 @@ /** * This class contains the functions for Case Management. - * */ class CRM_Case_BAO_Case extends CRM_Case_DAO_Case { @@ -1441,11 +1440,11 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c * @param null $attachments * @param int $caseId * - * @return null|array + * @return bool |array */ public static function sendActivityCopy($clientId, $activityId, $contacts, $attachments = NULL, $caseId) { if (!$activityId) { - return; + return FALSE; } $tplParams = $activityInfo = array(); diff --git a/CRM/Case/BAO/CaseType.php b/CRM/Case/BAO/CaseType.php index 5d0f1fdd28..889a9c1a65 100644 --- a/CRM/Case/BAO/CaseType.php +++ b/CRM/Case/BAO/CaseType.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class contains the functions for Case Type management - * + * This class contains the functions for Case Type management. */ class CRM_Case_BAO_CaseType extends CRM_Case_DAO_CaseType { diff --git a/CRM/Case/BAO/Query.php b/CRM/Case/BAO/Query.php index de28c1ad5b..e7a2c7a84f 100644 --- a/CRM/Case/BAO/Query.php +++ b/CRM/Case/BAO/Query.php @@ -240,7 +240,7 @@ class CRM_Case_BAO_Query { * Where clause for a single field. * * @param array $values - * @param CRM_Case_BAO_Query s$query + * @param CRM_Case_BAO_Query $query */ public static function whereClauseSingle(&$values, &$query) { list($name, $op, $value, $grouping, $wildcard) = $values; diff --git a/CRM/Case/Config.php b/CRM/Case/Config.php index c0337fbcea..c01f995e49 100644 --- a/CRM/Case/Config.php +++ b/CRM/Case/Config.php @@ -33,8 +33,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Case_Config extends CRM_Core_Component_Config { } diff --git a/CRM/Case/Controller/Search.php b/CRM/Case/Controller/Search.php index 64610630b0..c997926d42 100644 --- a/CRM/Case/Controller/Search.php +++ b/CRM/Case/Controller/Search.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** diff --git a/CRM/Case/Form/Activity.php b/CRM/Case/Form/Activity.php index 55a6b70d0c..ac997bc85a 100644 --- a/CRM/Case/Form/Activity.php +++ b/CRM/Case/Form/Activity.php @@ -346,8 +346,6 @@ class CRM_Case_Form_Activity extends CRM_Activity_Form_Activity { * Process the form submission. * * @param array $params - * - * @return array|null */ public function postProcess($params = NULL) { $transaction = new CRM_Core_Transaction(); diff --git a/CRM/Case/Form/Task/Result.php b/CRM/Case/Form/Task/Result.php index 7ca73bb548..fdc52f5cd8 100644 --- a/CRM/Case/Form/Task/Result.php +++ b/CRM/Case/Form/Task/Result.php @@ -29,29 +29,21 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Used for displaying results - * - * + * Used for displaying results. */ class CRM_Case_Form_Task_Result extends CRM_Case_Form_Task { /** * Build all the data structures needed to build the form. - * - * @return void */ public function preProcess() { } /** * Build the form object. - * - * @return void */ public function buildQuickForm() { $this->addButtons(array( diff --git a/CRM/Case/Form/Task/SearchTaskHookSample.php b/CRM/Case/Form/Task/SearchTaskHookSample.php index 02ed6d60f3..78a42f4e20 100644 --- a/CRM/Case/Form/Task/SearchTaskHookSample.php +++ b/CRM/Case/Form/Task/SearchTaskHookSample.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** @@ -41,8 +39,6 @@ class CRM_Case_Form_Task_SearchTaskHookSample extends CRM_Case_Form_Task { /** * Build all the data structures needed to build the form. - * - * @return void */ public function preProcess() { parent::preProcess(); @@ -74,8 +70,6 @@ WHERE cs.id IN ( {$caseIDs} )"; /** * Build the form object. - * - * @return void */ public function buildQuickForm() { $this->addButtons(array( diff --git a/CRM/Case/Info.php b/CRM/Case/Info.php index 6ebde5ec4f..0c91d9a59c 100644 --- a/CRM/Case/Info.php +++ b/CRM/Case/Info.php @@ -32,8 +32,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Case_Info extends CRM_Core_Component_Info { diff --git a/CRM/Case/Page/CaseDetails.php b/CRM/Case/Page/CaseDetails.php index 2555ab6ff9..df9471e764 100644 --- a/CRM/Case/Page/CaseDetails.php +++ b/CRM/Case/Page/CaseDetails.php @@ -29,14 +29,13 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Case_Page_CaseDetails extends CRM_Core_Page { /** - * the main function that is called when the page loads, - * it decides the which action has to be taken for the page. + * The main function that is called when the page loads. + * + * It decides the which action has to be taken for the page. * * @return null */ diff --git a/CRM/Case/Page/DashBoard.php b/CRM/Case/Page/DashBoard.php index 80a5e6cbe8..b22da4aba7 100644 --- a/CRM/Case/Page/DashBoard.php +++ b/CRM/Case/Page/DashBoard.php @@ -29,22 +29,19 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This page is for Case Dashboard + * This page is for Case Dashboard. */ class CRM_Case_Page_DashBoard extends CRM_Core_Page { public $useLivePageJS = TRUE; /** - * Heart of the viewing process. The runner gets all the meta data for - * the contact and calls the appropriate type of page to view. + * Heart of the viewing process. * - * @return void + * The runner gets all the meta data for the contact and calls the appropriate type of page to view. */ public function preProcess() { //check for civicase access. diff --git a/CRM/Case/Page/Tab.php b/CRM/Case/Page/Tab.php index 80faee5949..512b50b677 100644 --- a/CRM/Case/Page/Tab.php +++ b/CRM/Case/Page/Tab.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class handle case related functions - * + * This class handle case related functions. */ class CRM_Case_Page_Tab extends CRM_Core_Page { @@ -97,8 +94,6 @@ class CRM_Case_Page_Tab extends CRM_Core_Page { /** * View details of a case. - * - * @return void */ public function view() { $controller = new CRM_Core_Controller_Simple( @@ -137,9 +132,7 @@ class CRM_Case_Page_Tab extends CRM_Core_Page { } /** - * called when action is browse. - * - * @return void + * Called when action is browse. */ public function browse() { diff --git a/CRM/Case/PseudoConstant.php b/CRM/Case/PseudoConstant.php index 3cb4fad183..d40fa669dd 100644 --- a/CRM/Case/PseudoConstant.php +++ b/CRM/Case/PseudoConstant.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** * This class holds all the Pseudo constants that are specific for CiviCase. - * */ class CRM_Case_PseudoConstant extends CRM_Core_PseudoConstant { diff --git a/CRM/Case/Selector/Search.php b/CRM/Case/Selector/Search.php index 6acf462fff..283b36d827 100644 --- a/CRM/Case/Selector/Search.php +++ b/CRM/Case/Selector/Search.php @@ -29,15 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class is used to retrieve and display a range of - * contacts that match the given criteria (specifically for - * results of advanced search options. - * + * This class is used to retrieve and display a range of contacts that match the given criteria. */ class CRM_Case_Selector_Search extends CRM_Core_Selector_Base { diff --git a/CRM/Case/StateMachine/Search.php b/CRM/Case/StateMachine/Search.php index 246a8f1853..9fda0907b3 100644 --- a/CRM/Case/StateMachine/Search.php +++ b/CRM/Case/StateMachine/Search.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Case_StateMachine_Search extends CRM_Core_StateMachine { diff --git a/CRM/Case/Task.php b/CRM/Case/Task.php index cbef459dfe..42603ae426 100644 --- a/CRM/Case/Task.php +++ b/CRM/Case/Task.php @@ -29,14 +29,12 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * class to represent the actions that can be performed on a group of contacts - * used by the search forms + * Class to represent the actions that can be performed on a group of contacts. * + * Used by the search forms */ class CRM_Case_Task { const DELETE_CASES = 1, PRINT_CASES = 2, EXPORT_CASES = 3, RESTORE_CASES = 4; diff --git a/CRM/Case/XMLProcessor.php b/CRM/Case/XMLProcessor.php index 48e60d4675..ab60bf19ba 100644 --- a/CRM/Case/XMLProcessor.php +++ b/CRM/Case/XMLProcessor.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Case_XMLProcessor { diff --git a/CRM/Case/XMLProcessor/Process.php b/CRM/Case/XMLProcessor/Process.php index 7ca2a03f9e..b97411828a 100644 --- a/CRM/Case/XMLProcessor/Process.php +++ b/CRM/Case/XMLProcessor/Process.php @@ -29,12 +29,12 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Case_XMLProcessor_Process extends CRM_Case_XMLProcessor { /** - * @param $caseType + * Run. + * + * @param string $caseType * @param array $params * * @return bool diff --git a/CRM/Case/XMLProcessor/Report.php b/CRM/Case/XMLProcessor/Report.php index 99c7f98c44..5f68f1f1db 100644 --- a/CRM/Case/XMLProcessor/Report.php +++ b/CRM/Case/XMLProcessor/Report.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Case_XMLProcessor_Report extends CRM_Case_XMLProcessor { diff --git a/CRM/Case/XMLProcessor/Settings.php b/CRM/Case/XMLProcessor/Settings.php index 61465e61ac..a9ea2d5a6f 100644 --- a/CRM/Case/XMLProcessor/Settings.php +++ b/CRM/Case/XMLProcessor/Settings.php @@ -29,19 +29,19 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Case_XMLProcessor_Settings extends CRM_Case_XMLProcessor { private $_settings = array(); /** - * Input: The base filename without the .xml extension - * Output: An array of settings. + * Run. + * * @param string $filename + * The base filename without the .xml extension * * @return array + * An array of settings. */ public function run($filename = 'settings') { $xml = $this->retrieve($filename); diff --git a/CRM/Case/XMLRepository.php b/CRM/Case/XMLRepository.php index 42309337ff..d8169b7359 100644 --- a/CRM/Case/XMLRepository.php +++ b/CRM/Case/XMLRepository.php @@ -29,7 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ * * The XMLRepository is responsible for loading XML for case-types. * It includes any bulk operations that apply across the list of all XML diff --git a/CRM/Contact/BAO/Contact.php b/CRM/Contact/BAO/Contact.php index 6cfb4af7c9..d2f4889e5c 100644 --- a/CRM/Contact/BAO/Contact.php +++ b/CRM/Contact/BAO/Contact.php @@ -29,7 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ */ class CRM_Contact_BAO_Contact extends CRM_Contact_DAO_Contact { diff --git a/CRM/Contact/BAO/Contact/Location.php b/CRM/Contact/BAO/Contact/Location.php index 47154bd3d4..df696802eb 100644 --- a/CRM/Contact/BAO/Contact/Location.php +++ b/CRM/Contact/BAO/Contact/Location.php @@ -29,13 +29,11 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_BAO_Contact_Location { /** - * Get the display name, primary email, location type and location id of a contact + * Get the display name, primary email, location type and location id of a contact. * * @param int $id * Id of the contact. diff --git a/CRM/Contact/BAO/Contact/Optimizer.php b/CRM/Contact/BAO/Contact/Optimizer.php index f9a5e51cc6..7b29de360d 100644 --- a/CRM/Contact/BAO/Contact/Optimizer.php +++ b/CRM/Contact/BAO/Contact/Optimizer.php @@ -29,13 +29,13 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_BAO_Contact_Optimizer { /** - * @param $newValues - * @param $oldValues + * Edit function. + * + * @param array $newValues + * @param array $oldValues */ public static function edit(&$newValues, &$oldValues) { // still need to do more work on this diff --git a/CRM/Contact/BAO/Contact/Permission.php b/CRM/Contact/BAO/Contact/Permission.php index 5525c081ab..2bd730008a 100644 --- a/CRM/Contact/BAO/Contact/Permission.php +++ b/CRM/Contact/BAO/Contact/Permission.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_BAO_Contact_Permission { @@ -87,8 +85,6 @@ WHERE contact_a.id = %1 AND $permission"; * @param int|string $type the type of operation (view|edit) * @param bool $force * Should we force a recompute. - * - * @return void */ public static function cache($userID, $type = CRM_Core_Permission::VIEW, $force = FALSE) { static $_processed = array(); diff --git a/CRM/Contact/BAO/Contact/Utils.php b/CRM/Contact/BAO/Contact/Utils.php index b5d8b596f4..66de04582c 100644 --- a/CRM/Contact/BAO/Contact/Utils.php +++ b/CRM/Contact/BAO/Contact/Utils.php @@ -29,13 +29,11 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_BAO_Contact_Utils { /** - * Given a contact type, get the contact image + * Given a contact type, get the contact image. * * @param string $contactType * Contact type. @@ -811,8 +809,6 @@ Group By componentId"; * * @param array $address * This is associated array which contains submitted form values. - * - * @return void */ public static function processSharedAddress(&$address) { if (!is_array($address)) { @@ -908,8 +904,6 @@ Group By componentId"; * * @param $contactID * The contactID that was edited / deleted. - * - * @return void */ public static function clearContactCaches($contactID = NULL) { // clear acl cache if any. @@ -1122,11 +1116,9 @@ WHERE id IN (" . implode(',', $contactIds) . ")"; * @param string $templateString * The greeting template string with contact tokens + Smarty syntax. * - * @param $contactDetails + * @param array $contactDetails * @param int $contactID * @param string $className - * - * @return void */ public static function processGreetingTemplate(&$templateString, $contactDetails, $contactID, $className) { CRM_Utils_Token::replaceGreetingTokens($templateString, $contactDetails, $contactID, $className, TRUE); diff --git a/CRM/Contact/BAO/ContactType.php b/CRM/Contact/BAO/ContactType.php index e9a9c4e6b1..15ad7309d1 100644 --- a/CRM/Contact/BAO/ContactType.php +++ b/CRM/Contact/BAO/ContactType.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_BAO_ContactType extends CRM_Contact_DAO_ContactType { @@ -894,7 +892,7 @@ WHERE extends = %1 AND " . implode(" OR ", $subTypeClause); * @param array $subtypes * List of subtypes related to which entry is to be removed. * - * @return void + * @return bool */ public static function deleteCustomRowsOfSubtype($gID, $subtypes = array()) { if (!$gID or empty($subtypes)) { @@ -932,7 +930,7 @@ WHERE ($subtypeClause)"; * @param int $entityID * Entity id. * - * @return void + * @return null|string */ public static function deleteCustomRowsForEntityID($customTable, $entityID) { $customTable = CRM_Utils_Type::escape($customTable, 'String'); diff --git a/CRM/Contact/BAO/DashboardContact.php b/CRM/Contact/BAO/DashboardContact.php index 46d2c9859a..c3b034c80e 100644 --- a/CRM/Contact/BAO/DashboardContact.php +++ b/CRM/Contact/BAO/DashboardContact.php @@ -28,7 +28,6 @@ /** * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ */ class CRM_Contact_BAO_DashboardContact extends CRM_Contact_DAO_DashboardContact { } diff --git a/CRM/Contact/BAO/Group.php b/CRM/Contact/BAO/Group.php index 55e5b41a4f..e9e7056f8c 100644 --- a/CRM/Contact/BAO/Group.php +++ b/CRM/Contact/BAO/Group.php @@ -29,13 +29,11 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group { /** - * Class constructor + * Class constructor. */ public function __construct() { parent::__construct(); @@ -65,11 +63,11 @@ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group { } /** - * Delete the group and all the object that connect to - * this group. Incredibly destructive + * Delete the group and all the object that connect to this group. * - * @param int $id - * Group id. + * Incredibly destructive. + * + * @param int $id Group id. */ public static function discard($id) { CRM_Utils_Hook::pre('delete', 'Group', $id, CRM_Core_DAO::$_nullArray); diff --git a/CRM/Contact/BAO/GroupContact.php b/CRM/Contact/BAO/GroupContact.php index da7ebc3604..7306a4c0d0 100644 --- a/CRM/Contact/BAO/GroupContact.php +++ b/CRM/Contact/BAO/GroupContact.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_BAO_GroupContact extends CRM_Contact_DAO_GroupContact { @@ -514,8 +512,6 @@ SELECT * * * @param bool $visibility * @param string $method - * - * @return void */ public static function create(&$params, $contactId, $visibility = FALSE, $method = 'Admin') { $contactIds = array(); @@ -602,9 +598,6 @@ SELECT * * @see CRM_Dedupe_Merger::cpTables() * * TODO: use the 3rd $sqls param to append sql statements rather than executing them here - * - * @return void - * */ public static function mergeGroupContact($mainContactId, $otherContactId) { $params = array( diff --git a/CRM/Contact/BAO/GroupContactCache.php b/CRM/Contact/BAO/GroupContactCache.php index 347e6888a2..d3fbd76136 100644 --- a/CRM/Contact/BAO/GroupContactCache.php +++ b/CRM/Contact/BAO/GroupContactCache.php @@ -29,16 +29,15 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_BAO_GroupContactCache extends CRM_Contact_DAO_GroupContactCache { static $_alreadyLoaded = array(); /** - * Check to see if we have cache entries for this group - * if not, regenerate, else return + * Check to see if we have cache entries for this group. + * + * If not, regenerate, else return. * * @param $groupIDs * Of group that we are checking against. @@ -284,8 +283,6 @@ WHERE id IN ( $groupIDs ) * the groupID to delete cache entries, NULL for all groups. * @param bool $onceOnly * run the function exactly once for all groups. - * - * @return void */ public static function remove($groupID = NULL, $onceOnly = TRUE) { static $invoked = FALSE; diff --git a/CRM/Contact/BAO/GroupNesting.php b/CRM/Contact/BAO/GroupNesting.php index 045da9e888..209afb79ff 100644 --- a/CRM/Contact/BAO/GroupNesting.php +++ b/CRM/Contact/BAO/GroupNesting.php @@ -30,8 +30,6 @@ * * @package CRM * @copyright U.S. PIRG 2007 - * $Id$ - * */ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implements Iterator { @@ -287,9 +285,6 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen * Id of the group to add the child to. * @param int $childID * Id of the new child group. - * - * - * @return void */ public static function add($parentID, $childID) { // TODO: Add checks here to make sure invalid nests can't be created @@ -307,8 +302,6 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen * The id of the group to remove the child from. * @param $childID * The id of the child group being removed. - * - * @return void */ public static function remove($parentID, $childID) { $dao = new CRM_Contact_DAO_GroupNesting(); @@ -323,8 +316,6 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen * * @param int $childID * The id of the child group being removed. - * - * @return void */ public static function removeAllParentForChild($childID) { $dao = new CRM_Contact_DAO_GroupNesting(); diff --git a/CRM/Contact/BAO/GroupNestingCache.php b/CRM/Contact/BAO/GroupNestingCache.php index bb1198f51b..632277794e 100644 --- a/CRM/Contact/BAO/GroupNestingCache.php +++ b/CRM/Contact/BAO/GroupNestingCache.php @@ -29,10 +29,14 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_BAO_GroupNestingCache { + + /** + * Update cache. + * + * @throws \Exception + */ static public function update() { // lets build the tree in memory first diff --git a/CRM/Contact/BAO/GroupOrganization.php b/CRM/Contact/BAO/GroupOrganization.php index 9b4d297253..89ad08170c 100644 --- a/CRM/Contact/BAO/GroupOrganization.php +++ b/CRM/Contact/BAO/GroupOrganization.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_BAO_GroupOrganization extends CRM_Contact_DAO_GroupOrganization { @@ -72,8 +70,6 @@ class CRM_Contact_BAO_GroupOrganization extends CRM_Contact_DAO_GroupOrganizatio * (reference ) an assoc array of name/value pairs. * @param array $formatedValues * (reference ) an assoc array of name/value pairs. - * - * @return void */ public static function formatValues(&$params, &$formatedValues) { if (!empty($params['group_organization'])) { diff --git a/CRM/Contact/BAO/Household.php b/CRM/Contact/BAO/Household.php index 571f730195..e37ec0f009 100644 --- a/CRM/Contact/BAO/Household.php +++ b/CRM/Contact/BAO/Household.php @@ -29,13 +29,11 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_BAO_Household extends CRM_Contact_DAO_Contact { /** - * This is a contructor of the class. + * Class constructor. */ public function __construct() { parent::__construct(); diff --git a/CRM/Contact/BAO/Individual.php b/CRM/Contact/BAO/Individual.php index 00d5d482e6..578fec08f5 100644 --- a/CRM/Contact/BAO/Individual.php +++ b/CRM/Contact/BAO/Individual.php @@ -29,17 +29,15 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Class contains functions for individual contact type + * Class contains functions for individual contact type. */ class CRM_Contact_BAO_Individual extends CRM_Contact_DAO_Contact { /** - * This is a contructor of the class. + * Class constructor. */ public function __construct() { } @@ -351,14 +349,12 @@ class CRM_Contact_BAO_Individual extends CRM_Contact_DAO_Contact { } /** - * Regenerates display_name for contacts with given prefixes/suffixes + * Regenerates display_name for contacts with given prefixes/suffixes. * * @param array $ids * The array with the prefix/suffix id governing which contacts to regenerate. * @param int $action * The action describing whether prefix/suffix was UPDATED or DELETED. - * - * @return void */ public static function updateDisplayNames(&$ids, $action) { // get the proper field name (prefix_id or suffix_id) and its value diff --git a/CRM/Contact/BAO/ProximityQuery.php b/CRM/Contact/BAO/ProximityQuery.php index dbe5cbe096..ca7451899c 100644 --- a/CRM/Contact/BAO/ProximityQuery.php +++ b/CRM/Contact/BAO/ProximityQuery.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_BAO_ProximityQuery { @@ -254,11 +252,13 @@ ACOS( } /** - * @param $query + * Process form. + * + * @param CRM_Contact_BAO_Query $query * @param array $values * + * @return null * @throws Exception - * @return void */ public static function process(&$query, &$values) { list($name, $op, $distance, $grouping, $wildcard) = $values; diff --git a/CRM/Contact/BAO/Query.php b/CRM/Contact/BAO/Query.php index 30bcb57642..4276c04053 100644 --- a/CRM/Contact/BAO/Query.php +++ b/CRM/Contact/BAO/Query.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** @@ -463,8 +461,6 @@ class CRM_Contact_BAO_Query { /** * Function which actually does all the work for the constructor. - * - * @return void */ public function initialize() { $this->_select = array(); @@ -504,12 +500,14 @@ class CRM_Contact_BAO_Query { $this->openedSearchPanes(TRUE); } + /** + * Fix and handle contact deletion nicely. + * + * this code is primarily for search builder use case where different clauses can specify if they want deleted. + * + * CRM-11971 + */ public function buildParamsLookup() { - // first fix and handle contact deletion nicely - // this code is primarily for search builder use case - // where different clauses can specify if they want deleted - // contacts or not - // CRM-11971 $trashParamExists = FALSE; $paramByGroup = array(); foreach ($this->_params as $k => $param) { @@ -568,10 +566,7 @@ class CRM_Contact_BAO_Query { } /** - * Some composite fields do not appear in the fields array - * hack to make them part of the query - * - * @return void + * Some composite fields do not appear in the fields array hack to make them part of the query. */ public function addSpecialFields() { static $special = array('contact_type', 'contact_sub_type', 'sort_name', 'display_name'); @@ -589,8 +584,6 @@ class CRM_Contact_BAO_Query { * clauses. Note that since the where clause introduces new * tables, the initial attempt also retrieves all variables used * in the params list - * - * @return void */ public function selectClause() { -- 2.25.1