CRM-19170 preliminary tidy up.
authoreileen <emcnaughton@wikimedia.org>
Thu, 4 Aug 2016 08:21:00 +0000 (20:21 +1200)
committereileen <emcnaughton@wikimedia.org>
Tue, 16 Aug 2016 04:09:48 +0000 (16:09 +1200)
Remove unused return variable, fix comments, remove duplicate key

29 files changed:
CRM/Report/Form.php
CRM/Report/Form/ActivitySummary.php
CRM/Report/Form/Case/Demographics.php
CRM/Report/Form/Case/Summary.php
CRM/Report/Form/Case/TimeSpent.php
CRM/Report/Form/Contact/CurrentEmployer.php
CRM/Report/Form/Contact/Detail.php
CRM/Report/Form/Contact/Log.php
CRM/Report/Form/Contact/Summary.php
CRM/Report/Form/Contribute/Bookkeeping.php
CRM/Report/Form/Contribute/Detail.php
CRM/Report/Form/Contribute/PCP.php
CRM/Report/Form/Contribute/Summary.php
CRM/Report/Form/Event/IncomeCountSummary.php
CRM/Report/Form/Event/ParticipantListCount.php
CRM/Report/Form/Event/ParticipantListing.php
CRM/Report/Form/Event/Summary.php
CRM/Report/Form/Grant/Detail.php
CRM/Report/Form/Grant/Statistics.php
CRM/Report/Form/Mailing/Detail.php
CRM/Report/Form/Mailing/Opened.php
CRM/Report/Form/Mailing/Summary.php
CRM/Report/Form/Member/ContributionDetail.php
CRM/Report/Form/Member/Lapse.php
CRM/Report/Form/Member/Summary.php
CRM/Report/Form/Pledge/Detail.php
CRM/Report/Form/Pledge/Pbnp.php
CRM/Report/Form/Pledge/Summary.php
CRM/Report/Form/Walklist/Walklist.php

index ed8309b17768f121812d22a4251bb955465a7f1d..722ad70f0ccca74a60f0ec7c128ddc3f834f43b6 100644 (file)
@@ -3144,7 +3144,7 @@ WHERE cg.extends IN ('" . implode("','", $this->_customGroupExtends) . "') AND
         else {
           CRM_Core_Session::setStatus(ts("Report mail could not be sent."), ts('Mail Error'), 'error');
         }
-        return TRUE;
+        return;
       }
       elseif ($this->_outputMode == 'print') {
         echo $content;
index fc83ff1e51fd448863013478682a0d790c8bab6c..d4ebc876b062dd1f61f30450c965ee04aea77d36 100644 (file)
@@ -29,8 +29,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC (c) 2004-2016
- * $Id$
- *
  */
 class CRM_Report_Form_ActivitySummary extends CRM_Report_Form {
 
@@ -42,6 +40,7 @@ class CRM_Report_Form_ActivitySummary extends CRM_Report_Form {
   /**
    */
   /**
+   * Class constructor.
    */
   public function __construct() {
     $this->_columns = array(
index 3badc118d50fffeeaed68092d83042399228f223..0ec779030fb9470c889ef1e40b0d91d201153fe3 100644 (file)
@@ -29,8 +29,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC (c) 2004-2016
- * $Id$
- *
  */
 class CRM_Report_Form_Case_Demographics extends CRM_Report_Form {
 
index ea39d69d3635704b88e81682319db8ecc8aeb173..a5ef3c4f6a218fcc2e7ecf1cee7f0a53dbc87684 100644 (file)
@@ -29,8 +29,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC (c) 2004-2016
- * $Id$
- *
  */
 class CRM_Report_Form_Case_Summary extends CRM_Report_Form {
 
@@ -41,8 +39,7 @@ class CRM_Report_Form_Case_Summary extends CRM_Report_Form {
   protected $_customGroupExtends = array('Case');
 
   /**
-   */
-  /**
+   * Class constructor.
    */
   public function __construct() {
     $this->case_types = CRM_Case_PseudoConstant::caseType();
index c90270576470168c8472f3720aaeb1d3c9f525e6..e8d7f62def7b507aa2b25294ad3658822c4ad0cf 100644 (file)
  *
  * @package CRM
  * @copyright CiviCRM LLC (c) 2004-2016
- * $Id$
- *
  */
 class CRM_Report_Form_Case_TimeSpent extends CRM_Report_Form {
+
   /**
-   */
-  /**
+   * Class constructor.
    */
   public function __construct() {
 
index e5ea4b76d598f13feac3f02700e39cfad48df514..d8a9d127af2180f7ed692e8cfcd9ed3eb67a5850 100644 (file)
@@ -29,8 +29,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC (c) 2004-2016
- * $Id$
- *
  */
 class CRM_Report_Form_Contact_CurrentEmployer extends CRM_Report_Form {
 
@@ -44,6 +42,7 @@ class CRM_Report_Form_Contact_CurrentEmployer extends CRM_Report_Form {
   public $_drilldownReport = array('contact/detail' => 'Link to Detail Report');
 
   /**
+   * Class constructor.
    */
   public function __construct() {
 
index d03432e435d3973f3663f11c64d8241cf70fd702..68851120a9fbd86a26523986e57e4a1f69678dd0 100644 (file)
@@ -29,8 +29,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC (c) 2004-2016
- * $Id$
- *
  */
 class CRM_Report_Form_Contact_Detail extends CRM_Report_Form {
   const ROW_COUNT_LIMIT = 10;
index 3cdc9f06b241b6ce527dd588576e00852ffb6052..5c8833c57da2a5267d08a1ef6912715b4f53daac 100644 (file)
  *
  * @package CRM
  * @copyright CiviCRM LLC (c) 2004-2016
- * $Id$
- *
  */
 class CRM_Report_Form_Contact_Log extends CRM_Report_Form {
 
   protected $_summary = NULL;
 
   /**
-   */
-  /**
+   * Class constructor.
    */
   public function __construct() {
 
index 40b44d581b3b1bbfab0c7d4e813cff6cb05807c9..3a496d599c53de2afacd1dffd920859ad3e033f3 100644 (file)
@@ -29,8 +29,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC (c) 2004-2016
- * $Id$
- *
  */
 class CRM_Report_Form_Contact_Summary extends CRM_Report_Form {
 
index 7dc7fcb79a9fe54ad53532189774f7ccc83422bc..7446c0fc8c61ee27ef783f5fe0dbf54ed1939ceb 100644 (file)
@@ -29,8 +29,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC (c) 2004-2016
- * $Id$
- *
  */
 class CRM_Report_Form_Contribute_Bookkeeping extends CRM_Report_Form {
   protected $_addressField = FALSE;
index 2c473405e928209e7710b46ff62c06371724c015..1baa200d2aa4a2418d2b599ea3ef969086fccdcd 100644 (file)
@@ -506,12 +506,13 @@ GROUP BY {$this->_aliases['civicrm_contribution']}.currency";
   /**
    * This function appears to have been overrriden for the purposes of facilitating soft credits in the report.
    *
-   * An alternative approach would have been to have had 2 reports.
-   * 1) contribution report with optional join extending the retrievable fields & filters with soft credit data
-   * 2) soft credit report - showing a row per 'payment engagement' (payment or soft credit).
+   * The report appears to have 2 different functions:
+   * 1) contribution report
+   * 2) soft credit report - showing a row per 'payment engagement' (payment or soft credit). There is a separate
+   * soft credit report as well.
    *
-   * As it is many people are confused by the duplicate rows in 'soft credit mode' and this report is complex
-   * and slowed down by soft credit calculations regardless of whether that information is desired.
+   * Somewhat confusingly this report returns multiple rows per contribution when soft credits are included. It feels
+   * like there is a case to split it into 2 separate reports.
    *
    * Soft credit functionality is not currently unit tested for this report.
    */
index 52074d09e174f67470ac4bb3d9dd753218f7256d..17a1ea5e075547591801bbec2c942650eab39a8a 100644 (file)
@@ -33,9 +33,9 @@
  *
  */
 class CRM_Report_Form_Contribute_PCP extends CRM_Report_Form {
+
   /**
-   */
-  /**
+   * Class constructor.
    */
   public function __construct() {
     $this->_columns = array(
index 899efbf54f23775b8538089bf9521ad760e16715..564ed1ac1e722246c0c49259f3cbe5af98132d80 100644 (file)
@@ -443,6 +443,9 @@ class CRM_Report_Form_Contribute_Summary extends CRM_Report_Form {
    * Set from clause.
    *
    * @param string $entity
+   *
+   * @todo fix function signature to match parent. Remove hacky passing of $entity
+   * to acheive unclear results.
    */
   public function from($entity = NULL) {
     $softCreditJoinType = "LEFT";
index 93c9793e982b9df423ce6e984e5c1ce1d62e62e9..db3577a22e4b62b9c0ebf972c4d08bbb3f7c6af9 100644 (file)
@@ -29,8 +29,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC (c) 2004-2016
- * $Id$
- *
  */
 class CRM_Report_Form_Event_IncomeCountSummary extends CRM_Report_Form_Event {
 
@@ -51,8 +49,7 @@ class CRM_Report_Form_Event_IncomeCountSummary extends CRM_Report_Form_Event {
   public $_drilldownReport = array('event/participantlist' => 'Link to Detail Report');
 
   /**
-   */
-  /**
+   * Class constructor.
    */
   public function __construct() {
 
index a472ed982dd155a332121c19b7a23fa50843c681..7cbe4934e4f5257be85ab09d24949a0d59ec7205 100644 (file)
@@ -29,8 +29,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC (c) 2004-2016
- * $Id$
- *
  */
 class CRM_Report_Form_Event_ParticipantListCount extends CRM_Report_Form_Event {
 
@@ -45,6 +43,7 @@ class CRM_Report_Form_Event_ParticipantListCount extends CRM_Report_Form_Event {
   public $_drilldownReport = array('event/income' => 'Link to Detail Report');
 
   /**
+   * Class constructor.
    */
   public function __construct() {
     $this->_columns = array(
index 9a5bd5160c2782dde02e3c3d1b096272f5b45dd1..4917c7f27da92aea7f34a333f810435e0143eaec 100644 (file)
@@ -29,8 +29,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC (c) 2004-2016
- * $Id$
- *
  */
 class CRM_Report_Form_Event_ParticipantListing extends CRM_Report_Form_Event {
 
@@ -52,8 +50,7 @@ class CRM_Report_Form_Event_ParticipantListing extends CRM_Report_Form_Event {
   public $_drilldownReport = array('event/income' => 'Link to Detail Report');
 
   /**
-   */
-  /**
+   * Class constructor.
    */
   public function __construct() {
     $this->_autoIncludeIndexedFieldsAsOrderBys = 1;
index 9d1e223444640511f21b0946e9558b8be7087ced..42858c574943b315bf2346d030948893605cee33 100644 (file)
@@ -29,8 +29,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC (c) 2004-2016
- * $Id$
- *
  */
 class CRM_Report_Form_Event_Summary extends CRM_Report_Form_Event {
 
@@ -50,8 +48,7 @@ class CRM_Report_Form_Event_Summary extends CRM_Report_Form_Event {
   public $_drilldownReport = array('event/income' => 'Link to Detail Report');
 
   /**
-   */
-  /**
+   * Class constructor.
    */
   public function __construct() {
 
index 461b7f29b6e239d2ded7b03963b8b8867a2d54bf..91c7f36a42747440ff78e392b26b6cd5e6f2e47f 100644 (file)
@@ -29,8 +29,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC (c) 2004-2016
- * $Id$
- *
  */
 class CRM_Report_Form_Grant_Detail extends CRM_Report_Form {
 
@@ -41,8 +39,7 @@ class CRM_Report_Form_Grant_Detail extends CRM_Report_Form {
   );
 
   /**
-   */
-  /**
+   * Class constructor.
    */
   public function __construct() {
     $this->_columns = array(
index 421a8781ef1f2caaa3fd4d82fb374b18b0f16fab..67896422d61c397d64dae47a130092481591018d 100644 (file)
@@ -29,8 +29,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC (c) 2004-2016
- * $Id$
- *
  */
 class CRM_Report_Form_Grant_Statistics extends CRM_Report_Form {
 
@@ -41,8 +39,7 @@ class CRM_Report_Form_Grant_Statistics extends CRM_Report_Form {
   protected $_add2groupSupported = FALSE;
 
   /**
-   */
-  /**
+   * Class constructor.
    */
   public function __construct() {
     $this->_columns = array(
index ccbddd44e0331f543d80de4fd3ddeee6371c9963..c0f31303b3abe17705518f15266d160cfe78834f 100644 (file)
@@ -29,8 +29,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC (c) 2004-2016
- * $Id$
- *
  */
 class CRM_Report_Form_Mailing_Detail extends CRM_Report_Form {
 
index 3d6649dd4590963918d833dc91de1ae1cbdb4151..c41bc77d92ce805cc220d5b26e8146f62c239b7f 100644 (file)
@@ -29,8 +29,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC (c) 2004-2016
- * $Id$
- *
  */
 class CRM_Report_Form_Mailing_Opened extends CRM_Report_Form {
 
@@ -56,6 +54,7 @@ class CRM_Report_Form_Mailing_Opened extends CRM_Report_Form {
   /**
    */
   /**
+   * Class constructor.
    */
   public function __construct() {
     $this->_columns = array();
index d32ef515cae4d8dc0a458506b44a82aaac677f7a..facc20790af71a6d222edf0b3334910c6c3c15fa 100644 (file)
@@ -29,8 +29,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC (c) 2004-2016
- * $Id$
- *
  */
 class CRM_Report_Form_Mailing_Summary extends CRM_Report_Form {
 
@@ -50,8 +48,7 @@ class CRM_Report_Form_Mailing_Summary extends CRM_Report_Form {
   public $campaignEnabled = FALSE;
 
   /**
-   */
-  /**
+   * Class constructor.
    */
   public function __construct() {
     $this->_columns = array();
index a66b96dfe556918e7680946a13ab46609d39b636..87a39191d1fad7d32e5cf23fe290212e95a462ab 100644 (file)
@@ -29,8 +29,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC (c) 2004-2016
- * $Id$
- *
  */
 class CRM_Report_Form_Member_ContributionDetail extends CRM_Report_Form {
   protected $_addressField = FALSE;
@@ -47,6 +45,7 @@ class CRM_Report_Form_Member_ContributionDetail extends CRM_Report_Form {
   /**
    */
   /**
+   * Class constructor.
    */
   public function __construct() {
     $config = CRM_Core_Config::singleton();
index 7a6cd9a6f80fdba29cdf4d6a8d30964cb30137cd..88cf716b3db01d1c8e4eee53191e7c4c55f6ee67 100644 (file)
@@ -47,6 +47,7 @@ class CRM_Report_Form_Member_Lapse extends CRM_Report_Form {
   /**
    */
   /**
+   * Class constructor.
    */
   public function __construct() {
 
@@ -78,10 +79,6 @@ class CRM_Report_Form_Member_Lapse extends CRM_Report_Form {
             'title' => ts('First Name'),
             'no_repeat' => TRUE,
           ),
-          'id' => array(
-            'no_display' => TRUE,
-            'required' => TRUE,
-          ),
           'last_name' => array(
             'title' => ts('Last Name'),
             'no_repeat' => TRUE,
index d9d7c7371a2c2ff1ea3ba2ccc6d88370de1dc003..ed1f33f8899ab95a664f2dec8c57f0882794a229 100644 (file)
@@ -29,8 +29,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC (c) 2004-2016
- * $Id$
- *
  */
 class CRM_Report_Form_Member_Summary extends CRM_Report_Form {
 
@@ -50,6 +48,7 @@ class CRM_Report_Form_Member_Summary extends CRM_Report_Form {
   /**
    */
   /**
+   * Class constructor.
    */
   public function __construct() {
 
index af3a6a2c473871d1519d7e42141726cfb764ea61..a0153f737e95ad6b488e79ab9fa55b6b4486846e 100644 (file)
@@ -40,8 +40,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC (c) 2004-2016
- * $Id$
- *
  */
 class CRM_Report_Form_Pledge_Detail extends CRM_Report_Form {
 
index 2d349bb69cb4ae940fca7d48ec18b15538c6f5eb..1f1a60d11bb2b76c93d24dd2b438548a344ad93b 100644 (file)
@@ -29,8 +29,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC (c) 2004-2016
- * $Id$
- *
  */
 class CRM_Report_Form_Pledge_Pbnp extends CRM_Report_Form {
   protected $_charts = array(
@@ -45,8 +43,7 @@ class CRM_Report_Form_Pledge_Pbnp extends CRM_Report_Form {
   );
 
   /**
-   */
-  /**
+   * Class constructor.
    */
   public function __construct() {
 
index 3abdbca706750a75250b7855be7241ceff09406f..c03f897080f855f405884102d77880517221ced6 100644 (file)
@@ -44,6 +44,7 @@ class CRM_Report_Form_Pledge_Summary extends CRM_Report_Form {
   /**
    */
   /**
+   * Class constructor.
    */
   public function __construct() {
     $this->_columns = array(
index 361492aa22606c7569c1d9a4c946be5796eb8be3..b01211397832040459ffa847e90f19b50eacb914 100644 (file)
@@ -29,8 +29,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC (c) 2004-2016
- * $Id$
- *
  */
 class CRM_Report_Form_Walklist_Walklist extends CRM_Report_Form {
   protected $_addressField = FALSE;
@@ -51,8 +49,7 @@ class CRM_Report_Form_Walklist_Walklist extends CRM_Report_Form {
   );
 
   /**
-   */
-  /**
+   * Class constructor.
    */
   public function __construct() {
     $this->_columns = array(