CRM/Report/Interface.php

   1 <?php
   2
   3 /*
   4  +--------------------------------------------------------------------+
   5  | CiviCRM version 4.6                                                |
   6  +--------------------------------------------------------------------+
   7  | Copyright CiviCRM LLC (c) 2004-2014                                |
   8  +--------------------------------------------------------------------+
   9  | This file is a part of CiviCRM.                                    |
  10  |                                                                    |
  11  | CiviCRM is free software; you can copy, modify, and distribute it  |
  12  | under the terms of the GNU Affero General Public License           |
  13  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  14  |                                                                    |
  15  | CiviCRM is distributed in the hope that it will be useful, but     |
  16  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  17  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  18  | See the GNU Affero General Public License for more details.        |
  19  |                                                                    |
  20  | You should have received a copy of the GNU Affero General Public   |
  21  | License and the CiviCRM Licensing Exception along                  |
  22  | with this program; if not, contact CiviCRM LLC                     |
  23  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  24  | GNU Affero General Public License or the licensing of CiviCRM,     |
  25  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  26  +--------------------------------------------------------------------+
  27 */
  28
  29 /**
  30  *
  31  * @package CRM
  32  * @copyright CiviCRM LLC (c) 2004-2014
  33  * $Id$
  34  *
  35  */
  36 interface CRM_Report_Interface {
  37
  38   /**
  39    * The constructor gets the submitted form values
  40    */
  41   public function __construct(&$formValues);
  42
  43   /**
  44    * Builds the quickform for this search
  45    */
  46   public function buildForm(&$form);
  47
  48   /**
  49    * Builds the search query for various cases. We break it down into finer cases
  50    * since you can optimize each query independently. All the functions below return
  51    * a sql clause with only SELECT, FROM, WHERE sub-parts. The ORDER BY and LIMIT is
  52    * added at a later stage
  53    */
  54
  55   /**
  56    * Count of records that match the current input parameters
  57    * Used by pager
  58    */
  59   public function count();
  60
  61   /**
  62    * Summary information for the query that can be displayed in the template
  63    * This is useful to pass total / sub total information if needed
  64    */
  65   public function summary();
  66
  67   /**
  68    * List of contact ids that match the current input parameters
  69    * Used by different tasks. Will be also used to optimize the
  70    * 'all' query below to avoid excessive LEFT JOIN blowup
  71    */
  72   public function contactIDs($offset = 0, $rowcount = 0, $sort = NULL);
  73
  74   /**
  75    * Retrieve all the values that match the current input parameters
  76    * Used by the selector
  77    */
  78   function all($offset = 0, $rowcount = 0, $sort = NULL,
  79     $includeContactIDs = FALSE
  80   );
  81
  82   /**
  83    * The below two functions (from and where) are ONLY used if you want to
  84    * expose a custom group as a smart group and be able to send a mailing
  85    * to them via CiviMail. civicrm_email should be part of the from clause
  86    * The from clause should be a valid sql from clause including the word FROM
  87    * CiviMail will pick up the contacts where the email is primary and
  88    * is not on hold / opt out / do not email
  89    *
  90    */
  91
  92   /**
  93    * The from clause for the query
  94    */
  95   public function from();
  96
  97   /**
  98    * The where clause for the query
  99    */
 100   public function where($includeContactIDs = FALSE);
 101
 102   /**
 103    * The template FileName to use to display the results
 104    */
 105   public function templateFile();
 106
 107   /**
 108    * Returns an array of column headers and field names and sort options
 109    */
 110   public function &columns();
 111 }