4 +--------------------------------------------------------------------+
5 | CiviCRM version 4.4 |
6 +--------------------------------------------------------------------+
7 | Copyright CiviCRM LLC (c) 2004-2013 |
8 +--------------------------------------------------------------------+
9 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
32 * @copyright CiviCRM LLC (c) 2004-2013
36 interface CRM_Report_Interface
{
39 * The constructor gets the submitted form values
41 function __construct(&$formValues);
44 * Builds the quickform for this search
46 function buildForm(&$form);
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
56 * Count of records that match the current input parameters
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
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
72 function contactIDs($offset = 0, $rowcount = 0, $sort = NULL);
75 * Retrieve all the values that match the current input parameters
76 * Used by the selector
78 function all($offset = 0, $rowcount = 0, $sort = NULL,
79 $includeContactIDs = FALSE
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
93 * The from clause for the query
98 * The where clause for the query
100 function where($includeContactIDs = FALSE);
103 * The template FileName to use to display the results
105 function templateFile();
108 * Returns an array of column headers and field names and sort options