CRM/Contact/Form/Search/Interface.php

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