3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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 +--------------------------------------------------------------------+
30 * This class is a generic class to be used when we want to display
31 * a list of rows along with a set of associated actions
33 * Centralizing this code enables us to write a generic lister and enables
34 * us to automate the export process. To use this class, the object has to
35 * implement the Selector/Api.interface.php class
38 * @copyright CiviCRM LLC (c) 2004-2014
42 class CRM_Core_Selector_Controller
{
45 * Constants to determine if we should store
46 * the output in the session or template
49 // move the values from the session to the template
50 const SESSION
= 1, TEMPLATE
= 2,
51 TRANSFER
= 4, EXPORT
= 8, SCREEN
= 16, PDF
= 32;
54 * A CRM Object that implements CRM_Core_Selector_API
65 * The current column to sort on
74 protected $_sortOrder;
77 * @var CRM_Utils_Pager
91 protected $_pagerOffset;
94 * Number of rows to return
97 protected $_pagerRowCount;
100 * Total number of rows
106 * The objectAction for the WebObject
111 * This caches the content for the display system
118 * Is this object being embedded in another object. If
119 * so the display routine needs to not do any work. (The
120 * parent object takes care of the display)
124 protected $_embedded = FALSE;
127 * Are we in print mode? if so we need to modify the display
128 * functionality to do a minimal display :)
132 protected $_print = FALSE;
135 * The storage object (typically a form or a page)
142 * Output target, session, template or both?
149 * Prefif for the selector variables
156 * Cache the smarty template for efficiency reasons
158 * @var CRM_Core_Smarty
160 public static $_template;
163 * Array of properties that the controller dumps into the output object
168 public static $_properties = array('columnHeaders', 'rows', 'rowsEmpty');
171 * Should we compute actions dynamically (since they are quite verbose)
175 protected $_dynamicAction = FALSE;
180 * @param CRM_Core_Selector_API $object an object that implements the selector API
181 * @param int $pageID default pageID
182 * @param int $sortID default sortID
183 * @param int $action the actions to potentially support
184 * @param CRM_Core_Page|CRM_Core_Form $store place in session to store some values
185 * @param int $output what do we so with the output, session/template//both
187 * @param null $prefix
190 * @return \CRM_Core_Selector_Controller
193 public function __construct($object, $pageID, $sortID, $action, $store = NULL, $output = self
::TEMPLATE
, $prefix = NULL, $case = NULL) {
195 $this->_object
= $object;
196 $this->_pageID
= $pageID ?
$pageID : 1;
197 $this->_sortID
= $sortID ?
$sortID : NULL;
198 $this->_action
= $action;
199 $this->_store
= $store;
200 $this->_output
= $output;
201 $this->_prefix
= $prefix;
202 $this->_case
= $case;
205 if ($this->_sortID
&& strpos($this->_sortID
, '_') === FALSE) {
206 $this->_sortID
.= '_u';
210 'pageID' => $this->_pageID
,
213 // let the constructor initialize this, should happen only once
214 if (!isset(self
::$_template)) {
215 self
::$_template = CRM_Core_Smarty
::singleton();
218 $this->_sortOrder
= &$this->_object
->getSortOrder($action);
219 $this->_sort
= new CRM_Utils_Sort($this->_sortOrder
, $this->_sortID
);
222 * if we are in transfer mode, do not goto database, use the
223 * session values instead
226 if ($output == self
::TRANSFER
) {
227 $params['total'] = $this->_store
->get($this->_prefix
. 'rowCount');
230 $params['total'] = $this->_object
->getTotalCount($action, $this->_case
);
233 $this->_total
= $params['total'];
234 $this->_object
->getPagerParams($action, $params);
237 * Set the default values of RowsPerPage
240 $storeRowCount = $store->get($this->_prefix
. CRM_Utils_Pager
::PAGE_ROWCOUNT
);
241 if ($storeRowCount) {
242 $params['rowCount'] = $storeRowCount;
244 elseif (!isset($params['rowCount'])) {
245 $params['rowCount'] = CRM_Utils_Pager
::ROWCOUNT
;
248 $this->_pager
= new CRM_Utils_Pager($params);
249 list($this->_pagerOffset
, $this->_pagerRowCount
) = $this->_pager
->getOffsetAndRowCount();
253 * Have the GET vars changed, i.e. pageId or sortId that forces us to recompute the search values
255 * @param int $reset are we being reset
257 * @return boolean if the GET params are different from the session params
260 public function hasChanged($reset) {
263 * if we are in reset state, i.e the store is cleaned out, we return false
264 * we also return if we dont have a record of the sort id or page id
267 $this->_store
->get($this->_prefix
. CRM_Utils_Pager
::PAGE_ID
) == NULL ||
268 $this->_store
->get($this->_prefix
. CRM_Utils_Sort
::SORT_ID
) == NULL
273 if ($this->_store
->get($this->_prefix
. CRM_Utils_Pager
::PAGE_ID
) != $this->_pager
->getCurrentPageID() ||
274 $this->_store
->get($this->_prefix
. CRM_Utils_Sort
::SORT_ID
) != $this->_sort
->getCurrentSortID() ||
275 $this->_store
->get($this->_prefix
. CRM_Utils_Sort
::SORT_DIRECTION
) != $this->_sort
->getCurrentSortDirection()
283 * Heart of the Controller. This is where all the action takes place
285 * - The rows are fetched and stored depending on the type of output needed
287 * - For export/printing all rows are selected.
289 * - for displaying on screen paging parameters are used to display the
292 * - also depending on output type of session or template rows are appropriately stored in session
293 * or template variables are updated.
299 public function run() {
301 // get the column headers
302 $columnHeaders = &$this->_object
->getColumnHeaders($this->_action
, $this->_output
);
304 $contextArray = explode('_', get_class($this->_object
));
306 $contextName = strtolower($contextArray[1]);
308 // fix contribute and member
309 if ($contextName == 'contribute') {
310 $contextName = 'contribution';
312 elseif ($contextName == 'member') {
313 $contextName = 'membership';
316 // we need to get the rows if we are exporting or printing them
317 if ($this->_output
== self
::EXPORT ||
$this->_output
== self
::SCREEN
) {
318 // get rows (without paging criteria)
319 $rows = self
::getRows($this);
320 CRM_Utils_Hook
::searchColumns($contextName, $columnHeaders, $rows, $this);
321 if ($this->_output
== self
::EXPORT
) {
323 CRM_Core_Report_Excel
::writeCSVFile($this->_object
->getExportFileName(),
327 CRM_Utils_System
::civiExit();
330 // assign to template and display them.
331 self
::$_template->assign_by_ref('rows', $rows);
332 self
::$_template->assign_by_ref('columnHeaders', $columnHeaders);
336 // output requires paging/sorting capability
337 $rows = self
::getRows($this);
338 CRM_Utils_Hook
::searchColumns($contextName, $columnHeaders, $rows, $this);
339 $rowsEmpty = count($rows) ?
FALSE : TRUE;
340 $qill = $this->getQill();
341 $summary = $this->getSummary();
342 // if we need to store in session, lets update session
343 if ($this->_output
& self
::SESSION
) {
344 $this->_store
->set("{$this->_prefix}columnHeaders", $columnHeaders);
345 if ($this->_dynamicAction
) {
346 $this->_object
->removeActions($rows);
348 $this->_store
->set("{$this->_prefix}rows", $rows);
349 $this->_store
->set("{$this->_prefix}rowCount", $this->_total
);
350 $this->_store
->set("{$this->_prefix}rowsEmpty", $rowsEmpty);
351 $this->_store
->set("{$this->_prefix}qill", $qill);
352 $this->_store
->set("{$this->_prefix}summary", $summary);
355 self
::$_template->assign_by_ref("{$this->_prefix}pager", $this->_pager
);
356 self
::$_template->assign_by_ref("{$this->_prefix}sort", $this->_sort
);
358 self
::$_template->assign_by_ref("{$this->_prefix}columnHeaders", $columnHeaders);
359 self
::$_template->assign_by_ref("{$this->_prefix}rows", $rows);
360 self
::$_template->assign("{$this->_prefix}rowsEmpty", $rowsEmpty);
361 self
::$_template->assign("{$this->_prefix}qill", $qill);
362 self
::$_template->assign("{$this->_prefix}summary", $summary);
366 // always store the current pageID and sortID
367 $this->_store
->set($this->_prefix
. CRM_Utils_Pager
::PAGE_ID
,
368 $this->_pager
->getCurrentPageID()
370 $this->_store
->set($this->_prefix
. CRM_Utils_Sort
::SORT_ID
,
371 $this->_sort
->getCurrentSortID()
373 $this->_store
->set($this->_prefix
. CRM_Utils_Sort
::SORT_DIRECTION
,
374 $this->_sort
->getCurrentSortDirection()
376 $this->_store
->set($this->_prefix
. CRM_Utils_Sort
::SORT_ORDER
,
377 $this->_sort
->orderBy()
379 $this->_store
->set($this->_prefix
. CRM_Utils_Pager
::PAGE_ROWCOUNT
,
380 $this->_pager
->_perPage
388 * @param CRM_Core_Form $form
390 * @return array of rows
393 public function getRows($form) {
394 if ($form->_output
== self
::EXPORT ||
$form->_output
== self
::SCREEN
) {
395 //get rows (without paging criteria)
396 return $form->_object
->getRows($form->_action
, 0, 0, $form->_sort
, $form->_output
);
399 return $form->_object
->getRows($form->_action
, $form->_pagerOffset
, $form->_pagerRowCount
,
400 $form->_sort
, $form->_output
, $form->_case
406 * Default function for qill, if needed to be implemented, we
407 * expect the subclass to do it
409 * @return string the status message
412 public function getQill() {
413 return $this->_object
->getQill();
419 public function getSummary() {
420 return $this->_object
->getSummary();
426 * @return CRM_Utils_Pager
429 public function getPager() {
430 return $this->_pager
;
436 * @return CRM_Utils_Sort
439 public function getSort() {
444 * Move the variables from the session to the template
449 public function moveFromSessionToTemplate() {
450 self
::$_template->assign_by_ref("{$this->_prefix}pager", $this->_pager
);
452 $rows = $this->_store
->get("{$this->_prefix}rows");
455 if ($this->_dynamicAction
) {
456 $this->_object
->addActions($rows);
459 self
::$_template->assign("{$this->_prefix}aToZ",
460 $this->_store
->get("{$this->_prefix}AToZBar")
464 self
::$_template->assign_by_ref("{$this->_prefix}sort", $this->_sort
);
465 self
::$_template->assign("{$this->_prefix}columnHeaders", $this->_store
->get("{$this->_prefix}columnHeaders"));
466 self
::$_template->assign("{$this->_prefix}rows", $rows);
467 self
::$_template->assign("{$this->_prefix}rowsEmpty", $this->_store
->get("{$this->_prefix}rowsEmpty"));
468 self
::$_template->assign("{$this->_prefix}qill", $this->_store
->get("{$this->_prefix}qill"));
469 self
::$_template->assign("{$this->_prefix}summary", $this->_store
->get("{$this->_prefix}summary"));
471 if ($this->_embedded
) {
475 self
::$_template->assign('tplFile', $this->_object
->getHookedTemplateFileName());
477 $content = self
::$_template->fetch('CRM/common/print.tpl');
480 $config = CRM_Core_Config
::singleton();
481 $content = self
::$_template->fetch('CRM/common/' . strtolower($config->userFramework
) . '.tpl');
483 echo CRM_Utils_System
::theme($content, $this->_print
);
487 * Setter for embedded
489 * @param boolean $embedded
494 public function setEmbedded($embedded) {
495 $this->_embedded
= $embedded;
499 * Getter for embedded
501 * @return boolean return the embedded value
504 public function getEmbedded() {
505 return $this->_embedded
;
511 * @param boolean $print
516 public function setPrint($print) {
517 $this->_print
= $print;
523 * @return boolean return the print value
526 public function getPrint() {
527 return $this->_print
;
533 public function setDynamicAction($value) {
534 $this->_dynamicAction
= $value;
540 public function getDynamicAction() {
541 return $this->_dynamicAction
;