3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2018 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
29 * This interface defines the set of functions a class needs to implement
30 * to use the CRM/Selector object.
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
37 * @copyright CiviCRM LLC (c) 2004-2018
39 interface CRM_Core_Selector_API
{
42 * Get pager parameters.
44 * Based on the action, the GET variables and the session state
45 * it adds various key => value pairs to the params array including
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
53 * @param string $action
54 * The action being performed.
55 * @param array $params
56 * The array that the pagerParams will be inserted into.
58 public function getPagerParams($action, &$params);
61 * Returns the sort order array for the given action.
63 * @param string $action
64 * The action being performed.
67 * the elements that can be sorted along with their properties
69 public function &getSortOrder($action);
72 * Returns the column headers as an array of tuples.
74 * (name, sortName (key to the sort array))
76 * @param string $action
77 * The action being performed.
79 * What should the result set include (web/email/csv).
82 * the column headers that need to be displayed
84 public function &getColumnHeaders($action = NULL, $type = NULL);
87 * Returns the number of rows for this action.
89 * @param string $action
90 * The action being performed.
93 * the total number of rows for this action
95 public function getTotalCount($action);
98 * Returns all the rows in the given offset and rowCount.
100 * @param string $action
101 * The action being performed.
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).
112 * the total number of rows for this action
114 public function &getRows($action, $offset, $rowCount, $sort, $type = NULL);
117 * Return the template (.tpl) filename.
119 * @param string $action
120 * The action being performed.
124 public function getTemplateFileName($action = NULL);
127 * Return the filename for the exported CSV.
129 * @param string $type
130 * The type of export required: csv/xml/foaf etc.
133 * the fileName which we will munge to skip spaces and
134 * special characters to avoid various browser issues
136 public function getExportFileName($type = 'csv');