CRM-19884: DB Error on Activity Details Report

[civicrm-core.git] / CRM / Report / Interface.php

diff --git a/CRM/Report/Interface.php b/CRM/Report/Interface.php
index b1dc8523a9d9b3afb1eea07f52c26eb439ab9b76..34920bbbf231e6ce731e52612f84b30cfc1bb7a3 100644 (file)
--- a/CRM/Report/Interface.php
+++ b/CRM/Report/Interface.php
@@ -3,7 +3,7 @@
  +--------------------------------------------------------------------+
  | CiviCRM version 4.7                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2015                                |
+ | Copyright CiviCRM LLC (c) 2004-2017                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -28,22 +28,21 @@
 /**
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
+ * @copyright CiviCRM LLC (c) 2004-2017
  */
 interface CRM_Report_Interface {
 
   /**
    * The constructor gets the submitted form values.
    *
-   * @param $formValues
+   * @param array $formValues
    */
   public function __construct(&$formValues);
 
   /**
    * Builds the quickform for this search.
-   * @param $form
+   *
+   * @param CRM_Core_Form $form
    */
   public function buildForm(&$form);
 
@@ -55,27 +54,37 @@ interface CRM_Report_Interface {
    */
 
   /**
-   * Count of records that match the current input parameters
-   * Used by pager
+   * Count of records that match the current input parameters Used by pager.
    */
   public function count();
 
   /**
-   * Summary information for the query that can be displayed in the template
+   * Summary information for the query that can be displayed in the template.
+   *
    * This is useful to pass total / sub total information if needed
    */
   public function summary();
 
   /**
+   * Get contact IDs.
+   *
    * List of contact ids that match the current input parameters
    * Used by different tasks. Will be also used to optimize the
    * 'all' query below to avoid excessive LEFT JOIN blowup
+   *
+   * @param int $offset
+   * @param int $rowcount
+   * @param string $sort
    */
   public function contactIDs($offset = 0, $rowcount = 0, $sort = NULL);
 
   /**
-   * Retrieve all the values that match the current input parameters
-   * Used by the selector
+   * Retrieve all the values that match the current input parameters used by the selector.
+   *
+   * @param int $offset
+   * @param int $rowcount
+   * @param string $sort
+   * @param bool $includeContactIDs
    */
   public function all(
     $offset = 0, $rowcount = 0, $sort = NULL,
@@ -98,6 +107,8 @@ interface CRM_Report_Interface {
 
   /**
    * The where clause for the query.
+   *
+   * @param bool $includeContactIDs
    */
   public function where($includeContactIDs = FALSE);