From ced9bfed5abf0d9edd1c9039a4089666b603a5ff Mon Sep 17 00:00:00 2001 From: Eileen McNaughton Date: Mon, 2 Feb 2015 10:39:41 +1300 Subject: [PATCH] a few comment fixes --- CRM/Admin/Page/ExtensionsUpgrade.php | 2 ++ CRM/Contact/Form/Edit/Notes.php | 1 + CRM/Contact/Form/Search/Interface.php | 2 ++ CRM/Contact/Import/Controller.php | 4 ++++ CRM/Contribute/Import/Controller.php | 4 ++++ CRM/Core/BAO/UFMatch.php | 4 +++- CRM/Core/DAO.php | 2 +- CRM/Core/Smarty/plugins/function.crmDBTpl.php | 2 ++ .../Smarty/plugins/function.crmSetting.php | 7 ++++++- CRM/Mailing/Info.php | 7 +++++++ CRM/Mailing/Page/Common.php | 4 ++++ CRM/Mailing/Page/Optout.php | 8 ++++++++ CRM/Mailing/Page/Unsubscribe.php | 8 ++++++++ CRM/Report/Form/Case/TimeSpent.php | 9 +++++++-- CRM/Report/Form/Contact/CurrentEmployer.php | 9 +++++++-- CRM/Report/Form/Contact/Detail.php | 9 +++++++-- CRM/Report/Form/Contact/Log.php | 10 ++++++++-- CRM/Report/Form/Contact/LoggingSummary.php | 7 +++++-- CRM/Report/Form/Contact/Relationship.php | 12 +++++++++-- CRM/Report/Form/Contact/Summary.php | 10 +++++++++- CRM/Report/Form/Contribute/Bookkeeping.php | 8 +++++++- CRM/Report/Form/Contribute/Detail.php | 9 +++++++-- CRM/Report/Form/Contribute/History.php | 8 +++++++- .../Form/Contribute/HouseholdSummary.php | 9 +++++++-- CRM/Report/Form/Contribute/LoggingSummary.php | 8 +++++++- CRM/Report/Form/Contribute/Lybunt.php | 9 +++++++-- .../Form/Contribute/OrganizationSummary.php | 7 ++++++- CRM/Report/Form/Contribute/PCP.php | 9 +++++++-- CRM/Report/Form/Contribute/Recur.php | 20 +++++++++++++++++++ CRM/Report/Form/Contribute/Repeat.php | 9 +++++++-- CRM/Report/Form/Contribute/SoftCredit.php | 10 +++++++--- CRM/Report/Form/Contribute/Summary.php | 9 +++++++-- CRM/Report/Form/Contribute/Sybunt.php | 9 +++++++-- CRM/Report/Form/Contribute/TopDonor.php | 10 +++++++--- CRM/Report/Form/Event/Income.php | 5 +++++ CRM/Report/Form/Event/IncomeCountSummary.php | 8 +++++++- .../Form/Event/ParticipantListCount.php | 9 +++++++-- CRM/Report/Form/Event/ParticipantListing.php | 10 +++++++--- CRM/Report/Form/Event/Summary.php | 8 +++++++- CRM/Report/Form/Extended.php | 6 ++++++ CRM/Report/Form/Grant/Detail.php | 9 +++++++-- CRM/Report/Form/Grant/Statistics.php | 8 +++++++- CRM/Report/Form/Mailing/Bounce.php | 9 +++++++-- CRM/Report/Form/Mailing/Clicks.php | 9 +++++++-- CRM/Report/Form/Mailing/Detail.php | 9 +++++++-- CRM/Report/Form/Mailing/Opened.php | 9 +++++++-- CRM/Report/Form/Mailing/Summary.php | 9 +++++++-- CRM/Report/Form/Member/Detail.php | 9 +++++++-- CRM/Report/Form/Member/Lapse.php | 9 +++++++-- CRM/Report/Form/Member/Summary.php | 9 +++++++-- CRM/Report/Form/Membership/Summary.php | 7 +++++-- CRM/Report/Form/Pledge/Detail.php | 9 +++++++-- CRM/Report/Form/Pledge/Pbnp.php | 8 ++++++-- CRM/Report/Form/Pledge/Summary.php | 9 +++++++-- CRM/Report/Form/Walklist/Walklist.php | 9 +++++++-- .../phpunit/api/v3/SyntaxConformanceTest.php | 5 +++++ 56 files changed, 361 insertions(+), 76 deletions(-) diff --git a/CRM/Admin/Page/ExtensionsUpgrade.php b/CRM/Admin/Page/ExtensionsUpgrade.php index c453e07edd..59f91f76de 100644 --- a/CRM/Admin/Page/ExtensionsUpgrade.php +++ b/CRM/Admin/Page/ExtensionsUpgrade.php @@ -26,6 +26,8 @@ class CRM_Admin_Page_ExtensionsUpgrade extends CRM_Core_Page { /** * Handle the final step of the queue + * + * @param \CRM_Queue_TaskContext $ctx */ public static function onEnd(CRM_Queue_TaskContext $ctx) { CRM_Core_Error::debug_log_message('CRM_Admin_Page_ExtensionsUpgrade: Finish upgrades'); diff --git a/CRM/Contact/Form/Edit/Notes.php b/CRM/Contact/Form/Edit/Notes.php index 4c8dc6134f..59d15bd2cf 100644 --- a/CRM/Contact/Form/Edit/Notes.php +++ b/CRM/Contact/Form/Edit/Notes.php @@ -38,6 +38,7 @@ class CRM_Contact_Form_Edit_Notes { * build form elements * params object $form object of the form * + * @param $form */ public static function buildQuickForm(&$form) { $form->applyFilter('__ALL__', 'trim'); diff --git a/CRM/Contact/Form/Search/Interface.php b/CRM/Contact/Form/Search/Interface.php index 27c77bb220..f99e40190b 100644 --- a/CRM/Contact/Form/Search/Interface.php +++ b/CRM/Contact/Form/Search/Interface.php @@ -36,6 +36,8 @@ interface CRM_Contact_Form_Search_Interface { /** * The constructor gets the submitted form values + * + * @param $formValues */ public function __construct(&$formValues); diff --git a/CRM/Contact/Import/Controller.php b/CRM/Contact/Import/Controller.php index afab3e0878..8769d3f222 100644 --- a/CRM/Contact/Import/Controller.php +++ b/CRM/Contact/Import/Controller.php @@ -36,6 +36,10 @@ class CRM_Contact_Import_Controller extends CRM_Core_Controller { /** * Class constructor + * + * @param null $title + * @param bool|int $action + * @param bool $modal */ public function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) { parent::__construct($title, $modal); diff --git a/CRM/Contribute/Import/Controller.php b/CRM/Contribute/Import/Controller.php index 6c33167523..ed3d44e3bf 100644 --- a/CRM/Contribute/Import/Controller.php +++ b/CRM/Contribute/Import/Controller.php @@ -36,6 +36,10 @@ class CRM_Contribute_Import_Controller extends CRM_Core_Controller { /** * Class constructor + * + * @param null $title + * @param bool|int $action + * @param bool $modal */ public function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) { parent::__construct($title, $modal); diff --git a/CRM/Core/BAO/UFMatch.php b/CRM/Core/BAO/UFMatch.php index f4f0716ce2..bda036d8ef 100644 --- a/CRM/Core/BAO/UFMatch.php +++ b/CRM/Core/BAO/UFMatch.php @@ -41,7 +41,9 @@ class CRM_Core_BAO_UFMatch extends CRM_Core_DAO_UFMatch { /** * Create UF Match, Note that thsi function is here in it's simplest form @ the moment * - * @return CRM_Core_DAO_UFMatch + * @param $params + * + * @return \CRM_Core_DAO_UFMatch */ public static function create($params) { $hook = empty($params['id']) ? 'create' : 'edit'; diff --git a/CRM/Core/DAO.php b/CRM/Core/DAO.php index 8b382d70df..32fb178dd9 100644 --- a/CRM/Core/DAO.php +++ b/CRM/Core/DAO.php @@ -23,7 +23,7 @@ | GNU Affero General Public License or the licensing of CiviCRM, | | see the CiviCRM license FAQ at http://civicrm.org/licensing | +--------------------------------------------------------------------+ -*/ + */ /** * Our base DAO class. All DAO classes should inherit from this class. diff --git a/CRM/Core/Smarty/plugins/function.crmDBTpl.php b/CRM/Core/Smarty/plugins/function.crmDBTpl.php index 24bd0c910e..074c1babf0 100644 --- a/CRM/Core/Smarty/plugins/function.crmDBTpl.php +++ b/CRM/Core/Smarty/plugins/function.crmDBTpl.php @@ -37,6 +37,8 @@ * load a context. If name is asked for only name data is returned. * And if name is not provided whole context is returned. * + * @param $params + * @param $smarty */ function smarty_function_crmDBTpl($params, &$smarty) { // $vars = array('context', 'name', 'assign' ); out of which name is optional diff --git a/CRM/Core/Smarty/plugins/function.crmSetting.php b/CRM/Core/Smarty/plugins/function.crmSetting.php index bf995738f7..4cc6dd45a6 100644 --- a/CRM/Core/Smarty/plugins/function.crmSetting.php +++ b/CRM/Core/Smarty/plugins/function.crmSetting.php @@ -34,7 +34,12 @@ */ /** - * Retrieve CiviCRM settings from the api for use in templates + * Retrieve CiviCRM settings from the api for use in templates. + * + * @param $params + * @param $smarty + * + * @return int|string|void */ function smarty_function_crmSetting($params, &$smarty) { diff --git a/CRM/Mailing/Info.php b/CRM/Mailing/Info.php index 3047215fa0..480e936d09 100644 --- a/CRM/Mailing/Info.php +++ b/CRM/Mailing/Info.php @@ -57,6 +57,13 @@ class CRM_Mailing_Info extends CRM_Core_Component_Info { ); } + /** + * EXPERIMENTAL: Get a list of AngularJS modules + * + * @return array + * list of modules; same format as CRM_Utils_Hook::angularModules(&$angularModules) + * @see CRM_Utils_Hook::angularModules + */ public function getAngularModules() { $result = array(); $result['crmMailing'] = array( diff --git a/CRM/Mailing/Page/Common.php b/CRM/Mailing/Page/Common.php index 769fc8b774..6863aa338a 100644 --- a/CRM/Mailing/Page/Common.php +++ b/CRM/Mailing/Page/Common.php @@ -36,6 +36,10 @@ class CRM_Mailing_Page_Common extends CRM_Core_Page { protected $_type = NULL; /** + * Run page. + * + * This includes assigning smarty variables and other page processing. + * * @return string * @throws Exception */ diff --git a/CRM/Mailing/Page/Optout.php b/CRM/Mailing/Page/Optout.php index 9816c3e273..7e7a864f13 100644 --- a/CRM/Mailing/Page/Optout.php +++ b/CRM/Mailing/Page/Optout.php @@ -33,6 +33,14 @@ * */ class CRM_Mailing_Page_Optout extends CRM_Mailing_Page_Common { + /** + * Run page. + * + * This includes assigning smarty variables and other page processing. + * + * @return string + * @throws Exception + */ public function run() { $this->_type = 'optout'; return parent::run(); diff --git a/CRM/Mailing/Page/Unsubscribe.php b/CRM/Mailing/Page/Unsubscribe.php index 68da0466c5..398e8e6325 100644 --- a/CRM/Mailing/Page/Unsubscribe.php +++ b/CRM/Mailing/Page/Unsubscribe.php @@ -34,6 +34,14 @@ */ class CRM_Mailing_Page_Unsubscribe extends CRM_Mailing_Page_Common { + /** + * Run page. + * + * This includes assigning smarty variables and other page processing. + * + * @return string + * @throws Exception + */ public function run() { $this->_type = 'unsubscribe'; return parent::run(); diff --git a/CRM/Report/Form/Case/TimeSpent.php b/CRM/Report/Form/Case/TimeSpent.php index 2c4b9f299a..da3be99194 100644 --- a/CRM/Report/Form/Case/TimeSpent.php +++ b/CRM/Report/Form/Case/TimeSpent.php @@ -319,10 +319,15 @@ GROUP BY {$this->_aliases['civicrm_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) { - // custom code to alter rows $entryFound = FALSE; foreach ($rows as $rowNum => $row) { diff --git a/CRM/Report/Form/Contact/CurrentEmployer.php b/CRM/Report/Form/Contact/CurrentEmployer.php index 5891d93939..61ed1e96cb 100644 --- a/CRM/Report/Form/Contact/CurrentEmployer.php +++ b/CRM/Report/Form/Contact/CurrentEmployer.php @@ -303,10 +303,15 @@ FROM civicrm_contact {$this->_aliases['civicrm_contact']} } /** - * @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 $checkList = array(); $entryFound = FALSE; diff --git a/CRM/Report/Form/Contact/Detail.php b/CRM/Report/Form/Contact/Detail.php index 5da23323b2..d5ac31b786 100644 --- a/CRM/Report/Form/Contact/Detail.php +++ b/CRM/Report/Form/Contact/Detail.php @@ -804,10 +804,15 @@ class CRM_Report_Form_Contact_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) { - // custom code to alter rows $entryFound = FALSE; diff --git a/CRM/Report/Form/Contact/Log.php b/CRM/Report/Form/Contact/Log.php index 3e40d2b6c7..9c7de0f294 100644 --- a/CRM/Report/Form/Contact/Log.php +++ b/CRM/Report/Form/Contact/Log.php @@ -236,10 +236,16 @@ ORDER BY {$this->_aliases['civicrm_log']}.modified_date DESC, {$this->_aliases[' } /** - * @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) { // convert display name to links diff --git a/CRM/Report/Form/Contact/LoggingSummary.php b/CRM/Report/Form/Contact/LoggingSummary.php index c3b62f9786..7f8428a235 100644 --- a/CRM/Report/Form/Contact/LoggingSummary.php +++ b/CRM/Report/Form/Contact/LoggingSummary.php @@ -161,10 +161,13 @@ class CRM_Report_Form_Contact_LoggingSummary extends CRM_Logging_ReportSummary { } /** - * Alter Report Display. + * 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 from report query. + * Rows generated by SQL, with an array for each row. */ public function alterDisplay(&$rows) { // cache for id → is_deleted mapping diff --git a/CRM/Report/Form/Contact/Relationship.php b/CRM/Report/Form/Contact/Relationship.php index 65f4f2b6e3..3ce434453b 100644 --- a/CRM/Report/Form/Contact/Relationship.php +++ b/CRM/Report/Form/Contact/Relationship.php @@ -44,6 +44,9 @@ class CRM_Report_Form_Contact_Relationship extends CRM_Report_Form { ); public $_drilldownReport = array('contact/detail' => 'Link to Detail Report'); + /** + * Class constructor. + */ public function __construct() { $contact_type = CRM_Contact_BAO_ContactType::getSelectElements(FALSE, TRUE, '_'); @@ -557,10 +560,15 @@ class CRM_Report_Form_Contact_Relationship 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; foreach ($rows as $rowNum => $row) { diff --git a/CRM/Report/Form/Contact/Summary.php b/CRM/Report/Form/Contact/Summary.php index c9a02a7ea0..a5e591e2e6 100644 --- a/CRM/Report/Form/Contact/Summary.php +++ b/CRM/Report/Form/Contact/Summary.php @@ -271,8 +271,16 @@ class CRM_Report_Form_Contact_Summary extends CRM_Report_Form { $entryFound = TRUE; } + /** + * 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; $genders = CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'gender_id', array('localize' => TRUE)); diff --git a/CRM/Report/Form/Contribute/Bookkeeping.php b/CRM/Report/Form/Contribute/Bookkeeping.php index eda3a2fe16..9356b5de16 100644 --- a/CRM/Report/Form/Contribute/Bookkeeping.php +++ b/CRM/Report/Form/Contribute/Bookkeeping.php @@ -468,7 +468,13 @@ class CRM_Report_Form_Contribute_Bookkeeping 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) { $contributionTypes = CRM_Contribute_PseudoConstant::financialType(); diff --git a/CRM/Report/Form/Contribute/Detail.php b/CRM/Report/Form/Contribute/Detail.php index d012d3edc3..a0da79cf73 100644 --- a/CRM/Report/Form/Contribute/Detail.php +++ b/CRM/Report/Form/Contribute/Detail.php @@ -631,10 +631,15 @@ UNION ALL } /** - * @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 $checkList = array(); $entryFound = FALSE; $display_flag = $prev_cid = $cid = 0; diff --git a/CRM/Report/Form/Contribute/History.php b/CRM/Report/Form/Contribute/History.php index 6731c58ad4..e2ac3fc46e 100644 --- a/CRM/Report/Form/Contribute/History.php +++ b/CRM/Report/Form/Contribute/History.php @@ -726,7 +726,13 @@ class CRM_Report_Form_Contribute_History 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) { if (empty($rows)) { diff --git a/CRM/Report/Form/Contribute/HouseholdSummary.php b/CRM/Report/Form/Contribute/HouseholdSummary.php index f405edacc0..f58f95fde5 100644 --- a/CRM/Report/Form/Contribute/HouseholdSummary.php +++ b/CRM/Report/Form/Contribute/HouseholdSummary.php @@ -404,10 +404,15 @@ class CRM_Report_Form_Contribute_HouseholdSummary 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 $type = substr($this->_params['relationship_type_id_value'], -3); $entryFound = FALSE; diff --git a/CRM/Report/Form/Contribute/LoggingSummary.php b/CRM/Report/Form/Contribute/LoggingSummary.php index 15e32f36e2..f8a3742c2a 100644 --- a/CRM/Report/Form/Contribute/LoggingSummary.php +++ b/CRM/Report/Form/Contribute/LoggingSummary.php @@ -174,7 +174,13 @@ class CRM_Report_Form_Contribute_LoggingSummary extends CRM_Logging_ReportSummar } /** - * @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) { // cache for id → is_deleted mapping diff --git a/CRM/Report/Form/Contribute/Lybunt.php b/CRM/Report/Form/Contribute/Lybunt.php index 07f5b3035d..0fd0009b6a 100644 --- a/CRM/Report/Form/Contribute/Lybunt.php +++ b/CRM/Report/Form/Contribute/Lybunt.php @@ -457,10 +457,15 @@ class CRM_Report_Form_Contribute_Lybunt 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; foreach ($rows as $rowNum => $row) { diff --git a/CRM/Report/Form/Contribute/OrganizationSummary.php b/CRM/Report/Form/Contribute/OrganizationSummary.php index 80ea71ff5b..dce09084ec 100644 --- a/CRM/Report/Form/Contribute/OrganizationSummary.php +++ b/CRM/Report/Form/Contribute/OrganizationSummary.php @@ -407,10 +407,15 @@ class CRM_Report_Form_Contribute_OrganizationSummary extends CRM_Report_Form { } /** + * 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 $type = substr($this->_params['relationship_type_id_value'], -3); $entryFound = FALSE; diff --git a/CRM/Report/Form/Contribute/PCP.php b/CRM/Report/Form/Contribute/PCP.php index be9321aa9b..009553bad4 100644 --- a/CRM/Report/Form/Contribute/PCP.php +++ b/CRM/Report/Form/Contribute/PCP.php @@ -296,10 +296,15 @@ LEFT JOIN civicrm_contribution_page {$this->_aliases['civicrm_contribution_page' } /** - * @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; $checkList = array(); foreach ($rows as $rowNum => $row) { diff --git a/CRM/Report/Form/Contribute/Recur.php b/CRM/Report/Form/Contribute/Recur.php index 9bf843ce57..ed52efe386 100644 --- a/CRM/Report/Form/Contribute/Recur.php +++ b/CRM/Report/Form/Contribute/Recur.php @@ -34,6 +34,9 @@ */ class CRM_Report_Form_Contribute_Recur extends CRM_Report_Form { + /** + * Class constructor. + */ public function __construct() { $this->_columns = array( 'civicrm_contact' => array( @@ -209,10 +212,18 @@ class CRM_Report_Form_Contribute_Recur extends CRM_Report_Form { parent::__construct(); } + /** + * Get template file name. + * + * @return string + */ public function getTemplateName() { return 'CRM/Report/Form.tpl'; } + /** + * Generate FROM SQL clause. + */ public function from() { $this->_from = " FROM civicrm_contact {$this->_aliases['civicrm_contact']} @@ -298,6 +309,15 @@ class CRM_Report_Form_Contribute_Recur extends CRM_Report_Form { } + /** + * 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) { $contributionStatus = CRM_Contribute_PseudoConstant::contributionStatus(); foreach ($rows as $rowNum => $row) { diff --git a/CRM/Report/Form/Contribute/Repeat.php b/CRM/Report/Form/Contribute/Repeat.php index e4f6c2739a..07b24399e9 100644 --- a/CRM/Report/Form/Contribute/Repeat.php +++ b/CRM/Report/Form/Contribute/Repeat.php @@ -895,10 +895,15 @@ currency varchar(3) } /** - * @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 list($from1, $to1) = $this->getFromTo(CRM_Utils_Array::value("receive_date1_relative", $this->_params), CRM_Utils_Array::value("receive_date1_from", $this->_params), CRM_Utils_Array::value("receive_date1_to", $this->_params) diff --git a/CRM/Report/Form/Contribute/SoftCredit.php b/CRM/Report/Form/Contribute/SoftCredit.php index ff9e1e76c7..9c6074f1fe 100644 --- a/CRM/Report/Form/Contribute/SoftCredit.php +++ b/CRM/Report/Form/Contribute/SoftCredit.php @@ -470,11 +470,15 @@ GROUP BY {$this->_aliases['civicrm_contribution']}.currency } /** - * @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; $dispname_flag = $phone_flag = $email_flag = 0; $prev_email = $prev_dispname = $prev_phone = NULL; diff --git a/CRM/Report/Form/Contribute/Summary.php b/CRM/Report/Form/Contribute/Summary.php index 9cd7d364df..3479ec3a5f 100644 --- a/CRM/Report/Form/Contribute/Summary.php +++ b/CRM/Report/Form/Contribute/Summary.php @@ -650,10 +650,15 @@ ROUND(AVG({$this->_aliases['civicrm_contribution_soft']}.amount), 2) as civicrm_ } /** - * @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) { diff --git a/CRM/Report/Form/Contribute/Sybunt.php b/CRM/Report/Form/Contribute/Sybunt.php index 6b3d80fa19..abc9ff3cf9 100644 --- a/CRM/Report/Form/Contribute/Sybunt.php +++ b/CRM/Report/Form/Contribute/Sybunt.php @@ -476,10 +476,15 @@ class CRM_Report_Form_Contribute_Sybunt 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; foreach ($rows as $rowNum => $row) { diff --git a/CRM/Report/Form/Contribute/TopDonor.php b/CRM/Report/Form/Contribute/TopDonor.php index ee6b7e4eba..fdb055fdc8 100644 --- a/CRM/Report/Form/Contribute/TopDonor.php +++ b/CRM/Report/Form/Contribute/TopDonor.php @@ -417,11 +417,15 @@ ORDER BY civicrm_contribution_total_amount_sum DESC } /** - * @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; $rank = 1; if (!empty($rows)) { diff --git a/CRM/Report/Form/Event/Income.php b/CRM/Report/Form/Event/Income.php index 1a4b5041c6..decdb73262 100644 --- a/CRM/Report/Form/Event/Income.php +++ b/CRM/Report/Form/Event/Income.php @@ -311,6 +311,11 @@ class CRM_Report_Form_Event_Income extends CRM_Report_Form_Event { $this->assign_by_ref('pager', $pager); } + /** + * Form post process function. + * + * @return bool + */ public function postProcess() { $this->beginPostProcess(); $this->_setVariable = TRUE; diff --git a/CRM/Report/Form/Event/IncomeCountSummary.php b/CRM/Report/Form/Event/IncomeCountSummary.php index 8e4bc8f576..1c090c8da0 100644 --- a/CRM/Report/Form/Event/IncomeCountSummary.php +++ b/CRM/Report/Form/Event/IncomeCountSummary.php @@ -402,7 +402,13 @@ class CRM_Report_Form_Event_IncomeCountSummary extends CRM_Report_Form_Event { } /** - * @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) { diff --git a/CRM/Report/Form/Event/ParticipantListCount.php b/CRM/Report/Form/Event/ParticipantListCount.php index f81fadc160..a18658ada8 100644 --- a/CRM/Report/Form/Event/ParticipantListCount.php +++ b/CRM/Report/Form/Event/ParticipantListCount.php @@ -450,10 +450,15 @@ class CRM_Report_Form_Event_ParticipantListCount extends CRM_Report_Form_Event { } /** - * @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; $eventType = CRM_Core_OptionGroup::values('event_type'); diff --git a/CRM/Report/Form/Event/ParticipantListing.php b/CRM/Report/Form/Event/ParticipantListing.php index 418ee97507..e2f73c0891 100644 --- a/CRM/Report/Form/Event/ParticipantListing.php +++ b/CRM/Report/Form/Event/ParticipantListing.php @@ -630,11 +630,15 @@ ORDER BY cv.label } /** - * @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; $eventType = CRM_Core_OptionGroup::values('event_type'); diff --git a/CRM/Report/Form/Event/Summary.php b/CRM/Report/Form/Event/Summary.php index 7c21537ac8..a99de4caf6 100644 --- a/CRM/Report/Form/Event/Summary.php +++ b/CRM/Report/Form/Event/Summary.php @@ -375,7 +375,13 @@ class CRM_Report_Form_Event_Summary extends CRM_Report_Form_Event { } /** - * @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) { diff --git a/CRM/Report/Form/Extended.php b/CRM/Report/Form/Extended.php index ef11ba6594..88a3279099 100644 --- a/CRM/Report/Form/Extended.php +++ b/CRM/Report/Form/Extended.php @@ -128,7 +128,13 @@ class CRM_Report_Form_Extended extends CRM_Report_Form { } /** + * 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) { parent::alterDisplay($rows); diff --git a/CRM/Report/Form/Grant/Detail.php b/CRM/Report/Form/Grant/Detail.php index fda6d41083..3799eac34c 100644 --- a/CRM/Report/Form/Grant/Detail.php +++ b/CRM/Report/Form/Grant/Detail.php @@ -312,10 +312,15 @@ class CRM_Report_Form_Grant_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) { - // custom code to alter rows $entryFound = FALSE; foreach ($rows as $rowNum => $row) { // convert display name to links diff --git a/CRM/Report/Form/Grant/Statistics.php b/CRM/Report/Form/Grant/Statistics.php index 6b26966be9..cb3ed771aa 100644 --- a/CRM/Report/Form/Grant/Statistics.php +++ b/CRM/Report/Form/Grant/Statistics.php @@ -348,7 +348,13 @@ WHERE {$this->_aliases['civicrm_grant']}.amount_total IS NOT NULL } /** - * @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) { $totalStatistics = $grantStatistics = array(); diff --git a/CRM/Report/Form/Mailing/Bounce.php b/CRM/Report/Form/Mailing/Bounce.php index ccea88b922..a1b447f7ed 100644 --- a/CRM/Report/Form/Mailing/Bounce.php +++ b/CRM/Report/Form/Mailing/Bounce.php @@ -351,10 +351,15 @@ class CRM_Report_Form_Mailing_Bounce 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; foreach ($rows as $rowNum => $row) { // make count columns point to detail report diff --git a/CRM/Report/Form/Mailing/Clicks.php b/CRM/Report/Form/Mailing/Clicks.php index b5b12afdcb..c576d70e5d 100644 --- a/CRM/Report/Form/Mailing/Clicks.php +++ b/CRM/Report/Form/Mailing/Clicks.php @@ -299,10 +299,15 @@ class CRM_Report_Form_Mailing_Clicks 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; foreach ($rows as $rowNum => $row) { // make count columns point to detail report diff --git a/CRM/Report/Form/Mailing/Detail.php b/CRM/Report/Form/Mailing/Detail.php index e17aafbe72..91ed1f8232 100644 --- a/CRM/Report/Form/Mailing/Detail.php +++ b/CRM/Report/Form/Mailing/Detail.php @@ -443,10 +443,15 @@ class CRM_Report_Form_Mailing_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) { - // 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/Mailing/Opened.php b/CRM/Report/Form/Mailing/Opened.php index bb981a6e18..405ee9b3f1 100644 --- a/CRM/Report/Form/Mailing/Opened.php +++ b/CRM/Report/Form/Mailing/Opened.php @@ -286,10 +286,15 @@ class CRM_Report_Form_Mailing_Opened 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; foreach ($rows as $rowNum => $row) { // make count columns point to detail report diff --git a/CRM/Report/Form/Mailing/Summary.php b/CRM/Report/Form/Mailing/Summary.php index a604330a9f..82d5381e0f 100644 --- a/CRM/Report/Form/Mailing/Summary.php +++ b/CRM/Report/Form/Mailing/Summary.php @@ -571,10 +571,15 @@ class CRM_Report_Form_Mailing_Summary 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; foreach ($rows as $rowNum => $row) { // make count columns point to detail report diff --git a/CRM/Report/Form/Member/Detail.php b/CRM/Report/Form/Member/Detail.php index 1a6d9e184e..eb44925b4c 100644 --- a/CRM/Report/Form/Member/Detail.php +++ b/CRM/Report/Form/Member/Detail.php @@ -384,10 +384,15 @@ class CRM_Report_Form_Member_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) { - // custom code to alter rows $entryFound = FALSE; $checkList = array(); diff --git a/CRM/Report/Form/Member/Lapse.php b/CRM/Report/Form/Member/Lapse.php index 6b50f92cc0..1b93003edb 100644 --- a/CRM/Report/Form/Member/Lapse.php +++ b/CRM/Report/Form/Member/Lapse.php @@ -359,10 +359,15 @@ class CRM_Report_Form_Member_Lapse 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; $checkList = array(); diff --git a/CRM/Report/Form/Member/Summary.php b/CRM/Report/Form/Member/Summary.php index 134e688f66..8cd3cc353e 100644 --- a/CRM/Report/Form/Member/Summary.php +++ b/CRM/Report/Form/Member/Summary.php @@ -525,10 +525,15 @@ GROUP BY {$this->_aliases['civicrm_contribution']}.currency } /** - * @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/Membership/Summary.php b/CRM/Report/Form/Membership/Summary.php index a3a2411c35..5ea756430a 100644 --- a/CRM/Report/Form/Membership/Summary.php +++ b/CRM/Report/Form/Membership/Summary.php @@ -374,12 +374,15 @@ LEFT JOIN civicrm_contribution {$this->_aliases['civicrm_contribution']} } /** - * Make changes to how data is displayed. + * 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; $checkList = array(); diff --git a/CRM/Report/Form/Pledge/Detail.php b/CRM/Report/Form/Pledge/Detail.php index 11b7a5f27b..f49c955fb6 100644 --- a/CRM/Report/Form/Pledge/Detail.php +++ b/CRM/Report/Form/Pledge/Detail.php @@ -500,10 +500,15 @@ class CRM_Report_Form_Pledge_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) { - // custom code to alter rows $entryFound = FALSE; $checkList = array(); $display_flag = $prev_cid = $cid = 0; diff --git a/CRM/Report/Form/Pledge/Pbnp.php b/CRM/Report/Form/Pledge/Pbnp.php index 062ee27950..1f4165c39f 100644 --- a/CRM/Report/Form/Pledge/Pbnp.php +++ b/CRM/Report/Form/Pledge/Pbnp.php @@ -287,10 +287,14 @@ class CRM_Report_Form_Pledge_Pbnp 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 */ public function alterDisplay(&$rows) { - // custom code to alter rows $entryFound = FALSE; $checkList = array(); $display_flag = $prev_cid = $cid = 0; diff --git a/CRM/Report/Form/Pledge/Summary.php b/CRM/Report/Form/Pledge/Summary.php index d91fc6bfd2..3f81a0e060 100644 --- a/CRM/Report/Form/Pledge/Summary.php +++ b/CRM/Report/Form/Pledge/Summary.php @@ -364,10 +364,15 @@ class CRM_Report_Form_Pledge_Summary 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; $checkList = array(); $display_flag = $prev_cid = $cid = 0; diff --git a/CRM/Report/Form/Walklist/Walklist.php b/CRM/Report/Form/Walklist/Walklist.php index 07fab668fb..1877bad74c 100644 --- a/CRM/Report/Form/Walklist/Walklist.php +++ b/CRM/Report/Form/Walklist/Walklist.php @@ -243,10 +243,15 @@ FROM civicrm_contact {$this->_aliases['civicrm_contact']} {$this->_aclFrom } /** - * @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) { // handle state province diff --git a/tests/phpunit/api/v3/SyntaxConformanceTest.php b/tests/phpunit/api/v3/SyntaxConformanceTest.php index a56149017b..c18b1b5167 100644 --- a/tests/phpunit/api/v3/SyntaxConformanceTest.php +++ b/tests/phpunit/api/v3/SyntaxConformanceTest.php @@ -196,6 +196,11 @@ class api_v3_SyntaxConformanceTest extends CiviUnitTestCase { return static::entities(static::toBeSkipped_getlimit()); } + /** + * Generate list of entities that can be retrieved using SQL operator syntax. + * + * @return array + */ public static function entities_getSqlOperators() { return static::entities(static::toBeSkipped_getSqlOperators()); } -- 2.25.1