| 1 | <?php |
| 2 | /* |
| 3 | +--------------------------------------------------------------------+ |
| 4 | | CiviCRM version 4.7 | |
| 5 | +--------------------------------------------------------------------+ |
| 6 | | Copyright CiviCRM LLC (c) 2004-2017 | |
| 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-2017 |
| 32 | */ |
| 33 | interface CRM_Report_Interface { |
| 34 | |
| 35 | /** |
| 36 | * The constructor gets the submitted form values. |
| 37 | * |
| 38 | * @param array $formValues |
| 39 | */ |
| 40 | public function __construct(&$formValues); |
| 41 | |
| 42 | /** |
| 43 | * Builds the quickform for this search. |
| 44 | * |
| 45 | * @param CRM_Core_Form $form |
| 46 | */ |
| 47 | public function buildForm(&$form); |
| 48 | |
| 49 | /** |
| 50 | * Builds the search query for various cases. We break it down into finer cases |
| 51 | * since you can optimize each query independently. All the functions below return |
| 52 | * a sql clause with only SELECT, FROM, WHERE sub-parts. The ORDER BY and LIMIT is |
| 53 | * added at a later stage |
| 54 | */ |
| 55 | |
| 56 | /** |
| 57 | * Count of records that match the current input parameters Used by pager. |
| 58 | */ |
| 59 | public function count(); |
| 60 | |
| 61 | /** |
| 62 | * Summary information for the query that can be displayed in the template. |
| 63 | * |
| 64 | * This is useful to pass total / sub total information if needed |
| 65 | */ |
| 66 | public function summary(); |
| 67 | |
| 68 | /** |
| 69 | * Get contact IDs. |
| 70 | * |
| 71 | * List of contact ids that match the current input parameters |
| 72 | * Used by different tasks. Will be also used to optimize the |
| 73 | * 'all' query below to avoid excessive LEFT JOIN blowup |
| 74 | * |
| 75 | * @param int $offset |
| 76 | * @param int $rowcount |
| 77 | * @param string $sort |
| 78 | */ |
| 79 | public function contactIDs($offset = 0, $rowcount = 0, $sort = NULL); |
| 80 | |
| 81 | /** |
| 82 | * Retrieve all the values that match the current input parameters used by the selector. |
| 83 | * |
| 84 | * @param int $offset |
| 85 | * @param int $rowcount |
| 86 | * @param string $sort |
| 87 | * @param bool $includeContactIDs |
| 88 | */ |
| 89 | public function all( |
| 90 | $offset = 0, $rowcount = 0, $sort = NULL, |
| 91 | $includeContactIDs = FALSE |
| 92 | ); |
| 93 | |
| 94 | /** |
| 95 | * The below two functions (from and where) are ONLY used if you want to |
| 96 | * expose a custom group as a smart group and be able to send a mailing |
| 97 | * to them via CiviMail. civicrm_email should be part of the from clause |
| 98 | * The from clause should be a valid sql from clause including the word FROM |
| 99 | * CiviMail will pick up the contacts where the email is primary and |
| 100 | * is not on hold / opt out / do not email |
| 101 | */ |
| 102 | |
| 103 | /** |
| 104 | * The from clause for the query. |
| 105 | */ |
| 106 | public function from(); |
| 107 | |
| 108 | /** |
| 109 | * The where clause for the query. |
| 110 | * |
| 111 | * @param bool $includeContactIDs |
| 112 | */ |
| 113 | public function where($includeContactIDs = FALSE); |
| 114 | |
| 115 | /** |
| 116 | * The template FileName to use to display the results. |
| 117 | */ |
| 118 | public function templateFile(); |
| 119 | |
| 120 | /** |
| 121 | * Returns an array of column headers and field names and sort options. |
| 122 | */ |
| 123 | public function &columns(); |
| 124 | |
| 125 | } |