CRM/Report/Interface.php

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