From ab432335bec872240e162853b2131a462a9db44c Mon Sep 17 00:00:00 2001 From: Eileen McNaughton Date: Mon, 2 Feb 2015 16:11:44 +1300 Subject: [PATCH] comment fixes --- CRM/Mailing/BAO/Mailing.php | 4 ++++ CRM/Mailing/Controller/Send.php | 6 ++++++ CRM/Mailing/Event/BAO/Bounce.php | 4 ++++ CRM/Mailing/Event/BAO/Forward.php | 9 +++++++++ CRM/Report/Form/Activity.php | 8 +++++--- CRM/Report/Form/Contribute/History.php | 9 +++++---- CRM/Report/Form/Contribute/TopDonor.php | 4 +--- CRM/Report/Form/Event/ParticipantListing.php | 2 ++ CRM/Report/Interface.php | 4 ++++ CRM/Report/Utils/Get.php | 2 ++ CRM/Upgrade/Controller.php | 4 ++++ 11 files changed, 46 insertions(+), 10 deletions(-) diff --git a/CRM/Mailing/BAO/Mailing.php b/CRM/Mailing/BAO/Mailing.php index 15709cf017..5f09d9ae04 100644 --- a/CRM/Mailing/BAO/Mailing.php +++ b/CRM/Mailing/BAO/Mailing.php @@ -1782,6 +1782,10 @@ ORDER BY civicrm_email.is_bulkmail DESC /** * Get hash value of the mailing + * + * @param $id + * + * @return null|string */ public static function getMailingHash($id) { $hash = NULL; diff --git a/CRM/Mailing/Controller/Send.php b/CRM/Mailing/Controller/Send.php index 54bc90d1c2..287ed71ad2 100644 --- a/CRM/Mailing/Controller/Send.php +++ b/CRM/Mailing/Controller/Send.php @@ -36,6 +36,12 @@ class CRM_Mailing_Controller_Send extends CRM_Core_Controller { /** * Class constructor + * + * @param null $title + * @param bool|int $action + * @param bool $modal + * + * @throws \Exception */ public function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) { parent::__construct($title, $modal, NULL, FALSE, TRUE); diff --git a/CRM/Mailing/Event/BAO/Bounce.php b/CRM/Mailing/Event/BAO/Bounce.php index 7f58f60e11..206a44ec4f 100755 --- a/CRM/Mailing/Event/BAO/Bounce.php +++ b/CRM/Mailing/Event/BAO/Bounce.php @@ -43,6 +43,10 @@ class CRM_Mailing_Event_BAO_Bounce extends CRM_Mailing_Event_DAO_Bounce { /** * Create a new bounce event, update the email address if necessary + * + * @param $params + * + * @return bool|null */ public static function &create(&$params) { $q = &CRM_Mailing_Event_BAO_Queue::verify($params['job_id'], diff --git a/CRM/Mailing/Event/BAO/Forward.php b/CRM/Mailing/Event/BAO/Forward.php index 09c2331fab..80018af16d 100644 --- a/CRM/Mailing/Event/BAO/Forward.php +++ b/CRM/Mailing/Event/BAO/Forward.php @@ -43,6 +43,15 @@ class CRM_Mailing_Event_BAO_Forward extends CRM_Mailing_Event_DAO_Forward { /** * Create a new forward event, create a new contact if necessary + * + * @param $job_id + * @param $queue_id + * @param $hash + * @param $forward_email + * @param null $fromEmail + * @param null $comment + * + * @return bool */ public static function &forward($job_id, $queue_id, $hash, $forward_email, $fromEmail = NULL, $comment = NULL) { $q = CRM_Mailing_Event_BAO_Queue::verify($job_id, $queue_id, $hash); diff --git a/CRM/Report/Form/Activity.php b/CRM/Report/Form/Activity.php index 721c0274b0..39dbdea835 100644 --- a/CRM/Report/Form/Activity.php +++ b/CRM/Report/Form/Activity.php @@ -42,8 +42,7 @@ class CRM_Report_Form_Activity extends CRM_Report_Form { protected $_nonDisplayFields = array(); /** - */ - /** + * Class constructor. */ public function __construct() { // There could be multiple contacts. We not clear on which contact id to display. @@ -346,8 +345,11 @@ class CRM_Report_Form_Activity extends CRM_Report_Form { /** * Adding address fields with dbAlias for order clause. + * + * @param bool $orderBy + * * @return array - * address fields + * Address fields */ public function addressFields($orderBy = FALSE) { $address = parent::addAddressFields(FALSE, TRUE); diff --git a/CRM/Report/Form/Contribute/History.php b/CRM/Report/Form/Contribute/History.php index e0d2ca89bb..df86ec11cf 100644 --- a/CRM/Report/Form/Contribute/History.php +++ b/CRM/Report/Form/Contribute/History.php @@ -419,18 +419,19 @@ class CRM_Report_Form_Contribute_History extends CRM_Report_Form { } /** - * Override to set limit is 10 + * Override to set limit to 10. * * @param int $rowCount * - * @return array|void + * @return array */ public function limit($rowCount = self::ROW_COUNT_LIMIT) { - parent::limit($rowCount); + return parent::limit($rowCount); } /** - * Override to set pager with limit is 10 + * Override to set pager with limit is 10. + * * @param int $rowCount */ public function setPager($rowCount = self::ROW_COUNT_LIMIT) { diff --git a/CRM/Report/Form/Contribute/TopDonor.php b/CRM/Report/Form/Contribute/TopDonor.php index 2dd720e10b..8ff0091a5f 100644 --- a/CRM/Report/Form/Contribute/TopDonor.php +++ b/CRM/Report/Form/Contribute/TopDonor.php @@ -382,8 +382,6 @@ ORDER BY civicrm_contribution_total_amount_sum DESC /** * @param int $rowCount - * - * @return array|void */ public function limit($rowCount = CRM_Report_Form::ROW_COUNT_LIMIT) { // lets do the pager if in html mode @@ -394,7 +392,7 @@ ORDER BY civicrm_contribution_total_amount_sum DESC $rowCount = $this->_dashBoardRowCount; } if ($this->_outputMode == 'html' || $this->_outputMode == 'group') { - //replace only first occurence of SELECT + // Replace only first occurrence of SELECT. $this->_select = preg_replace('/SELECT/', 'SELECT SQL_CALC_FOUND_ROWS ', $this->_select, 1); $pageId = CRM_Utils_Request::retrieve('crmPID', 'Integer', CRM_Core_DAO::$_nullObject); diff --git a/CRM/Report/Form/Event/ParticipantListing.php b/CRM/Report/Form/Event/ParticipantListing.php index e2f73c0891..95e011196d 100644 --- a/CRM/Report/Form/Event/ParticipantListing.php +++ b/CRM/Report/Form/Event/ParticipantListing.php @@ -616,6 +616,8 @@ ORDER BY cv.label * @param int $rowId * @param $rowNum * @param $types + * + * @return bool */ private function _initBasicRow(&$rows, &$entryFound, $row, $rowId, $rowNum, $types) { if (!array_key_exists($rowId, $row)) { diff --git a/CRM/Report/Interface.php b/CRM/Report/Interface.php index bf4fbaed51..b556430ee1 100644 --- a/CRM/Report/Interface.php +++ b/CRM/Report/Interface.php @@ -36,11 +36,15 @@ interface CRM_Report_Interface { /** * The constructor gets the submitted form values + * + * @param $formValues */ public function __construct(&$formValues); /** * Builds the quickform for this search + * @param $form + * @return */ public function buildForm(&$form); diff --git a/CRM/Report/Utils/Get.php b/CRM/Report/Utils/Get.php index 8b82255212..2c1995e6eb 100644 --- a/CRM/Report/Utils/Get.php +++ b/CRM/Report/Utils/Get.php @@ -55,6 +55,8 @@ class CRM_Report_Utils_Get { * @param string $fieldName * @param $field * @param $defaults + * + * @return bool */ public static function dateParam($fieldName, &$field, &$defaults) { // type = 12 (datetime) is not recognized by Utils_Type::escape() method, diff --git a/CRM/Upgrade/Controller.php b/CRM/Upgrade/Controller.php index e25bd216a6..891efdaf85 100644 --- a/CRM/Upgrade/Controller.php +++ b/CRM/Upgrade/Controller.php @@ -36,6 +36,10 @@ class CRM_Upgrade_Controller extends CRM_Core_Controller { /** * Class constructor + * + * @param null $title + * @param bool|int $action + * @param bool $modal */ public function __construct( $title = NULL, -- 2.25.1