CRM/Core/Selector/API.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2018                                |
   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  * @package CRM
  37  * @copyright CiviCRM LLC (c) 2004-2018
  38  */
  39 interface CRM_Core_Selector_API {
  40
  41   /**
  42    * Get pager parameters.
  43    *
  44    * Based on the action, the GET variables and the session state
  45    * it adds various key => value pairs to the params array including
  46    *
  47    *  status    - the status message to display. Modifiers will be defined
  48    *              to integrate the total count and the current state of the
  49    *              page: e.g. Displaying Page 3 of 5
  50    *  csvString - The html string to display for export as csv
  51    *  rowCount  - the number of rows to be included
  52    *
  53    * @param string $action
  54    *   The action being performed.
  55    * @param array $params
  56    *   The array that the pagerParams will be inserted into.
  57    */
  58   public function getPagerParams($action, &$params);
  59
  60   /**
  61    * Returns the sort order array for the given action.
  62    *
  63    * @param string $action
  64    *   The action being performed.
  65    *
  66    * @return array
  67    *   the elements that can be sorted along with their properties
  68    */
  69   public function &getSortOrder($action);
  70
  71   /**
  72    * Returns the column headers as an array of tuples.
  73    *
  74    * (name, sortName (key to the sort array))
  75    *
  76    * @param string $action
  77    *   The action being performed.
  78    * @param string $type
  79    *   What should the result set include (web/email/csv).
  80    *
  81    * @return array
  82    *   the column headers that need to be displayed
  83    */
  84   public function &getColumnHeaders($action = NULL, $type = NULL);
  85
  86   /**
  87    * Returns the number of rows for this action.
  88    *
  89    * @param string $action
  90    *   The action being performed.
  91    *
  92    * @return int
  93    *   the total number of rows for this action
  94    */
  95   public function getTotalCount($action);
  96
  97   /**
  98    * Returns all the rows in the given offset and rowCount.
  99    *
 100    * @param string $action
 101    *   The action being performed.
 102    * @param int $offset
 103    *   The row number to start from.
 104    * @param int $rowCount
 105    *   The number of rows to return.
 106    * @param string $sort
 107    *   The sql string that describes the sort order.
 108    * @param string $type
 109    *   What should the result set include (web/email/csv).
 110    *
 111    * @return int
 112    *   the total number of rows for this action
 113    */
 114   public function &getRows($action, $offset, $rowCount, $sort, $type = NULL);
 115
 116   /**
 117    * Return the template (.tpl) filename.
 118    *
 119    * @param string $action
 120    *   The action being performed.
 121    *
 122    * @return string
 123    */
 124   public function getTemplateFileName($action = NULL);
 125
 126   /**
 127    * Return the filename for the exported CSV.
 128    *
 129    * @param string $type
 130    *   The type of export required: csv/xml/foaf etc.
 131    *
 132    * @return string
 133    *   the fileName which we will munge to skip spaces and
 134    *                special characters to avoid various browser issues
 135    */
 136   public function getExportFileName($type = 'csv');
 137
 138 }