CRM/Core/Selector/API.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  * This interface defines the set of functions a class needs to implement
  30  * to use the CRM/Selector object.
  31  *
  32  * Using this interface allows us to standardize on multiple things including
  33  * list display, pagination, sorting and export in multiple formats (CSV is
  34  * supported right now, XML support will be added as and when needed
  35  *
  36  *
  37  * @package CRM
  38  * @copyright CiviCRM LLC (c) 2004-2014
  39  * $Id$
  40  *
  41  */
  42 interface CRM_Core_Selector_API {
  43
  44   /**
  45    * Based on the action, the GET variables and the session state
  46    * it adds various key => value pairs to the params array including
  47    *
  48    *  status    - the status message to display. Modifiers will be defined
  49    *              to integrate the total count and the current state of the
  50    *              page: e.g. Displaying Page 3 of 5
  51    *  csvString - The html string to display for export as csv
  52    *  rowCount  - the number of rows to be included
  53    *
  54    * @param string action the action being performed
  55    * @param array  params the array that the pagerParams will be inserted into
  56    *
  57    * @return void
  58    *
  59    *
  60    */
  61   public function getPagerParams($action, &$params);
  62
  63   /**
  64    * Returns the sort order array for the given action
  65    *
  66    * @param string action the action being performed
  67    *
  68    * @return array the elements that can be sorted along with their properties
  69    *
  70    */
  71   public function &getSortOrder($action);
  72
  73   /**
  74    * Returns the column headers as an array of tuples:
  75    * (name, sortName (key to the sort array))
  76    *
  77    * @param string $action the action being performed
  78    * @param enum   $type   what should the result set include (web/email/csv)
  79    *
  80    * @return array the column headers that need to be displayed
  81    */
  82   public function &getColumnHeaders($action = NULL, $type = NULL);
  83
  84   /**
  85    * Returns the number of rows for this action
  86    *
  87    * @param string action the action being performed
  88    *
  89    * @return int   the total number of rows for this action
  90    *
  91    *
  92    */
  93   public function getTotalCount($action);
  94
  95   /**
  96    * Returns all the rows in the given offset and rowCount
  97    *
  98    * @param enum   $action   the action being performed
  99    * @param int    $offset   the row number to start from
 100    * @param int    $rowCount the number of rows to return
 101    * @param string $sort     the sql string that describes the sort order
 102    * @param enum   $type     what should the result set include (web/email/csv)
 103    *
 104    * @return int   the total number of rows for this action
 105    */
 106   public function &getRows($action, $offset, $rowCount, $sort, $type = NULL);
 107
 108   /**
 109    * Return the template (.tpl) filename
 110    *
 111    * @param string $action the action being performed
 112    *
 113    * @return string
 114    *
 115    */
 116   public function getTemplateFileName($action = NULL);
 117
 118   /**
 119    * Return the filename for the exported CSV
 120    *
 121    * @param string type   the type of export required: csv/xml/foaf etc
 122    *
 123    * @return string the fileName which we will munge to skip spaces and
 124    *                special characters to avoid various browser issues
 125    *
 126    */
 127   public function getExportFileName($type = 'csv');
 128 }