From 4b62bc4f72abfa7db070eb16c343ac6c31a5c7d4 Mon Sep 17 00:00:00 2001 From: Eileen McNaughton Date: Mon, 2 Feb 2015 10:17:38 +1300 Subject: [PATCH] Comment fixes --- CRM/Contact/Form/Search/Custom/FullText/Contact.php | 3 +++ .../Form/Search/Custom/FullText/Contribution.php | 3 +++ .../Form/Search/Custom/FullText/Membership.php | 3 +++ .../Form/Search/Custom/FullText/Participant.php | 3 +++ CRM/Core/CodeGen/Util/Smarty.php | 5 +++++ CRM/Core/Form.php | 4 ++-- CRM/Core/I18n/SchemaStructure_4_5_beta2.php | 4 ++++ CRM/Core/ManagedEntities.php | 5 +++++ CRM/Core/Page/Redirect.php | 9 +++++++++ CRM/Report/Form.php | 9 +++++++-- CRM/Report/Form/Activity.php | 11 +++++++---- CRM/Report/Form/ActivitySummary.php | 9 +++++++-- CRM/Report/Form/Campaign/SurveyDetails.php | 12 +++++++----- CRM/Report/Form/Case/Demographics.php | 9 +++++++-- CRM/Report/Form/Case/Detail.php | 8 +++++++- CRM/Report/Form/Case/Summary.php | 8 +++++++- 16 files changed, 86 insertions(+), 19 deletions(-) diff --git a/CRM/Contact/Form/Search/Custom/FullText/Contact.php b/CRM/Contact/Form/Search/Custom/FullText/Contact.php index 834025faea..f9290c8767 100644 --- a/CRM/Contact/Form/Search/Custom/FullText/Contact.php +++ b/CRM/Contact/Form/Search/Custom/FullText/Contact.php @@ -34,6 +34,9 @@ */ class CRM_Contact_Form_Search_Custom_FullText_Contact extends CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery { + /** + * Class constructor. + */ public function __construct() { parent::__construct('Contact', ts('Contacts')); } diff --git a/CRM/Contact/Form/Search/Custom/FullText/Contribution.php b/CRM/Contact/Form/Search/Custom/FullText/Contribution.php index df24428b3a..6ef97a2179 100644 --- a/CRM/Contact/Form/Search/Custom/FullText/Contribution.php +++ b/CRM/Contact/Form/Search/Custom/FullText/Contribution.php @@ -34,6 +34,9 @@ */ class CRM_Contact_Form_Search_Custom_FullText_Contribution extends CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery { + /** + * Class constructor. + */ public function __construct() { parent::__construct('Contribution', ts('Contributions')); } diff --git a/CRM/Contact/Form/Search/Custom/FullText/Membership.php b/CRM/Contact/Form/Search/Custom/FullText/Membership.php index fac21b49fc..aea55a1bbf 100644 --- a/CRM/Contact/Form/Search/Custom/FullText/Membership.php +++ b/CRM/Contact/Form/Search/Custom/FullText/Membership.php @@ -34,6 +34,9 @@ */ class CRM_Contact_Form_Search_Custom_FullText_Membership extends CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery { + /** + * Class constructor. + */ public function __construct() { parent::__construct('Membership', ts('Memberships')); } diff --git a/CRM/Contact/Form/Search/Custom/FullText/Participant.php b/CRM/Contact/Form/Search/Custom/FullText/Participant.php index f39dcb6790..7a4503a924 100644 --- a/CRM/Contact/Form/Search/Custom/FullText/Participant.php +++ b/CRM/Contact/Form/Search/Custom/FullText/Participant.php @@ -34,6 +34,9 @@ */ class CRM_Contact_Form_Search_Custom_FullText_Participant extends CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery { + /** + * Class constructor. + */ public function __construct() { parent::__construct('Participant', ts('Participants')); } diff --git a/CRM/Core/CodeGen/Util/Smarty.php b/CRM/Core/CodeGen/Util/Smarty.php index fe627988ba..ce11d28b3f 100644 --- a/CRM/Core/CodeGen/Util/Smarty.php +++ b/CRM/Core/CodeGen/Util/Smarty.php @@ -31,6 +31,11 @@ class CRM_Core_CodeGen_Util_Smarty { } } + /** + * Set plugin directories. + * + * @param array $pluginDirs + */ public function setPluginDirs($pluginDirs) { $this->smartyPluginDirs = $pluginDirs; $this->smarty = NULL; diff --git a/CRM/Core/Form.php b/CRM/Core/Form.php index 1a7035aaca..cbe49b178c 100644 --- a/CRM/Core/Form.php +++ b/CRM/Core/Form.php @@ -152,7 +152,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { private $_chainSelectFields = array(); /** - * Constructor for the basic form page + * Constructor for the basic form page. * * We should not use QuickForm directly. This class provides a lot * of default convenient functions, rules and buttons @@ -361,7 +361,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * The postProcess hook is typically called by the framework + * The postProcess hook is typically called by the framework. * However in a few cases, the form exits or redirects early in which * case it needs to call this function so other modules can do the needful * Calling this function directly should be avoided if possible. In general a diff --git a/CRM/Core/I18n/SchemaStructure_4_5_beta2.php b/CRM/Core/I18n/SchemaStructure_4_5_beta2.php index 50aab894e6..8131ac8d14 100644 --- a/CRM/Core/I18n/SchemaStructure_4_5_beta2.php +++ b/CRM/Core/I18n/SchemaStructure_4_5_beta2.php @@ -34,6 +34,10 @@ * DO NOT EDIT. Generated by CRM_Core_CodeGen */ class CRM_Core_I18n_SchemaStructure_4_5_beta2 { + + /** + * Get column definition. + */ public static function &columns() { static $result = NULL; if (!$result) { diff --git a/CRM/Core/ManagedEntities.php b/CRM/Core/ManagedEntities.php index e47c7dfde2..16ac0ad2fd 100644 --- a/CRM/Core/ManagedEntities.php +++ b/CRM/Core/ManagedEntities.php @@ -7,6 +7,11 @@ */ class CRM_Core_ManagedEntities { + /** + * Get clean up options. + * + * @return array + */ public static function getCleanupOptions() { return array( 'always' => ts('Always'), diff --git a/CRM/Core/Page/Redirect.php b/CRM/Core/Page/Redirect.php index f5f484e708..4498ecd0cd 100644 --- a/CRM/Core/Page/Redirect.php +++ b/CRM/Core/Page/Redirect.php @@ -12,6 +12,15 @@ * @endcoe */ class CRM_Core_Page_Redirect extends CRM_Core_Page { + + /** + * Run page + * + * @param string $path + * @param array $pageArgs + * + * @return string|void + */ public function run($path = NULL, $pageArgs = array()) { $url = self::createUrl($path, $_REQUEST, $pageArgs, TRUE); // return $url; diff --git a/CRM/Report/Form.php b/CRM/Report/Form.php index 9314b1f1f0..d01df5c4ef 100644 --- a/CRM/Report/Form.php +++ b/CRM/Report/Form.php @@ -1766,10 +1766,15 @@ class CRM_Report_Form extends CRM_Core_Form { } /** - * @param $rows + * Alter display of rows. + * + * Iterate through the rows retrieved via SQL and make changes for display purposes, + * such as rendering contacts as links. + * + * @param array $rows + * Rows generated by SQL, with an array for each row. */ public function alterDisplay(&$rows) { - // custom code to alter rows } /** diff --git a/CRM/Report/Form/Activity.php b/CRM/Report/Form/Activity.php index bd7ca05529..721c0274b0 100644 --- a/CRM/Report/Form/Activity.php +++ b/CRM/Report/Form/Activity.php @@ -767,16 +767,19 @@ GROUP BY civicrm_activity_id {$this->_having} {$this->_orderBy} {$this->_limit}" } /** - * @param $rows + * Alter display of rows. + * + * Iterate through the rows retrieved via SQL and make changes for display purposes, + * such as rendering contacts as links. + * + * @param array $rows + * Rows generated by SQL, with an array for each row. */ public function alterDisplay(&$rows) { - // custom code to alter rows - $entryFound = FALSE; $activityType = CRM_Core_PseudoConstant::activityType(TRUE, TRUE, FALSE, 'label', TRUE); $activityStatus = CRM_Core_PseudoConstant::activityStatus(); $viewLinks = FALSE; - $seperator = CRM_Core_DAO::VALUE_SEPARATOR; $context = CRM_Utils_Request::retrieve('context', 'String', $this, FALSE, 'report'); $actUrl = ''; diff --git a/CRM/Report/Form/ActivitySummary.php b/CRM/Report/Form/ActivitySummary.php index cb57d817fe..392305bb30 100644 --- a/CRM/Report/Form/ActivitySummary.php +++ b/CRM/Report/Form/ActivitySummary.php @@ -458,10 +458,15 @@ class CRM_Report_Form_ActivitySummary extends CRM_Report_Form { } /** - * @param $rows + * Alter display of rows. + * + * Iterate through the rows retrieved via SQL and make changes for display purposes, + * such as rendering contacts as links. + * + * @param array $rows + * Rows generated by SQL, with an array for each row. */ public function alterDisplay(&$rows) { - // custom code to alter rows $entryFound = FALSE; $activityType = CRM_Core_PseudoConstant::activityType(TRUE, TRUE, FALSE, 'label', TRUE); diff --git a/CRM/Report/Form/Campaign/SurveyDetails.php b/CRM/Report/Form/Campaign/SurveyDetails.php index 248f8c3582..078647aa1f 100644 --- a/CRM/Report/Form/Campaign/SurveyDetails.php +++ b/CRM/Report/Form/Campaign/SurveyDetails.php @@ -608,17 +608,19 @@ INNER JOIN civicrm_option_value val ON ( val.option_group_id = survey.result_id } /** - * @param $rows + * Alter display of rows. + * + * Iterate through the rows retrieved via SQL and make changes for display purposes, + * such as rendering contacts as links. + * + * @param array $rows + * Rows generated by SQL, with an array for each row. */ public function alterDisplay(&$rows) { - //format the survey result data. $this->_formatSurveyResult($rows); - - //format the survey response data. $this->_formatSurveyResponseData($rows); - // custom code to alter rows $entryFound = FALSE; foreach ($rows as $rowNum => $row) { // handle state province diff --git a/CRM/Report/Form/Case/Demographics.php b/CRM/Report/Form/Case/Demographics.php index 7a5c02cc48..b50ed04ae7 100644 --- a/CRM/Report/Form/Case/Demographics.php +++ b/CRM/Report/Form/Case/Demographics.php @@ -378,10 +378,15 @@ where (cg.extends='Contact' OR cg.extends='Individual' OR cg.extends_entity_colu } /** - * @param $rows + * Alter display of rows. + * + * Iterate through the rows retrieved via SQL and make changes for display purposes, + * such as rendering contacts as links. + * + * @param array $rows + * Rows generated by SQL, with an array for each row. */ public function alterDisplay(&$rows) { - // custom code to alter rows $entryFound = FALSE; foreach ($rows as $rowNum => $row) { // make count columns point to detail report diff --git a/CRM/Report/Form/Case/Detail.php b/CRM/Report/Form/Case/Detail.php index 25722bb239..2cd970144a 100644 --- a/CRM/Report/Form/Case/Detail.php +++ b/CRM/Report/Form/Case/Detail.php @@ -572,7 +572,13 @@ class CRM_Report_Form_Case_Detail extends CRM_Report_Form { } /** - * @param $rows + * Alter display of rows. + * + * Iterate through the rows retrieved via SQL and make changes for display purposes, + * such as rendering contacts as links. + * + * @param array $rows + * Rows generated by SQL, with an array for each row. */ public function alterDisplay(&$rows) { $entryFound = FALSE; diff --git a/CRM/Report/Form/Case/Summary.php b/CRM/Report/Form/Case/Summary.php index eaf22ce8a4..762b689884 100644 --- a/CRM/Report/Form/Case/Summary.php +++ b/CRM/Report/Form/Case/Summary.php @@ -341,7 +341,13 @@ inner join civicrm_contact $c2 on ${c2}.id=${ccc}.contact_id } /** - * @param $rows + * Alter display of rows. + * + * Iterate through the rows retrieved via SQL and make changes for display purposes, + * such as rendering contacts as links. + * + * @param array $rows + * Rows generated by SQL, with an array for each row. */ public function alterDisplay(&$rows) { $entryFound = FALSE; -- 2.25.1