CRM/Core/Selector/Controller.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  * 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
  32  *
  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
  36  *
  37  * @package CRM
  38  * @copyright CiviCRM LLC (c) 2004-2014
  39  * $Id$
  40  *
  41  */
  42 class CRM_Core_Selector_Controller {
  43
  44   /**
  45    * Constants to determine if we should store
  46    * the output in the session or template
  47    * @var int
  48    */
  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;
  52
  53   /**
  54    * A CRM Object that implements CRM_Core_Selector_API.
  55    * @var object
  56    */
  57   protected $_object;
  58
  59   /**
  60    * @var CRM_Utils_Sort
  61    */
  62   protected $_sort;
  63
  64   /**
  65    * The current column to sort on
  66    * @var int
  67    */
  68   protected $_sortID;
  69
  70   /**
  71    * The sortOrder array
  72    * @var array
  73    */
  74   protected $_sortOrder;
  75
  76   /**
  77    * @var CRM_Utils_Pager
  78    */
  79   protected $_pager;
  80
  81   /**
  82    * The pageID
  83    * @var int
  84    */
  85   protected $_pageID;
  86
  87   /**
  88    * Offset
  89    * @var int
  90    */
  91   protected $_pagerOffset;
  92
  93   /**
  94    * Number of rows to return
  95    * @var int
  96    */
  97   protected $_pagerRowCount;
  98
  99   /**
 100    * Total number of rows
 101    * @var int
 102    */
 103   protected $_total;
 104
 105   /**
 106    * The objectAction for the WebObject
 107    */
 108   protected $_action;
 109
 110   /**
 111    * This caches the content for the display system
 112    *
 113    * @var string
 114    */
 115   protected $_content;
 116
 117   /**
 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)
 121    *
 122    * @var bool
 123    */
 124   protected $_embedded = FALSE;
 125
 126   /**
 127    * Are we in print mode? if so we need to modify the display
 128    * functionality to do a minimal display :)
 129    *
 130    * @var bool
 131    */
 132   protected $_print = FALSE;
 133
 134   /**
 135    * The storage object (typically a form or a page)
 136    *
 137    * @var Object
 138    */
 139   protected $_store;
 140
 141   /**
 142    * Output target, session, template or both?
 143    *
 144    * @var int
 145    */
 146   protected $_output;
 147
 148   /**
 149    * Prefif for the selector variables
 150    *
 151    * @var int
 152    */
 153   protected $_prefix;
 154
 155   /**
 156    * Cache the smarty template for efficiency reasons
 157    *
 158    * @var CRM_Core_Smarty
 159    */
 160   public static $_template;
 161
 162   /**
 163    * Array of properties that the controller dumps into the output object
 164    *
 165    * @var array
 166    */
 167   public static $_properties = array('columnHeaders', 'rows', 'rowsEmpty');
 168
 169   /**
 170    * Should we compute actions dynamically (since they are quite verbose)
 171    *
 172    * @var bool
 173    */
 174   protected $_dynamicAction = FALSE;
 175
 176   /**
 177    * Class constructor.
 178    *
 179    * @param CRM_Core_Selector_API $object
 180    *   An object that implements the selector API.
 181    * @param int $pageID
 182    *   Default pageID.
 183    * @param int $sortID
 184    *   Default sortID.
 185    * @param int $action
 186    *   The actions to potentially support.
 187    * @param CRM_Core_Page|CRM_Core_Form $store place in session to store some values
 188    * @param int $output
 189    *   What do we so with the output, session/template//both.
 190    *
 191    * @param null $prefix
 192    * @param null $case
 193    *
 194    * @return \CRM_Core_Selector_Controller
 195    */
 196   public function __construct($object, $pageID, $sortID, $action, $store = NULL, $output = self::TEMPLATE, $prefix = NULL, $case = NULL) {
 197
 198     $this->_object = $object;
 199     $this->_pageID = $pageID ? $pageID : 1;
 200     $this->_sortID = $sortID ? $sortID : NULL;
 201     $this->_action = $action;
 202     $this->_store = $store;
 203     $this->_output = $output;
 204     $this->_prefix = $prefix;
 205     $this->_case = $case;
 206
 207     // fix sortID
 208     if ($this->_sortID && strpos($this->_sortID, '_') === FALSE) {
 209       $this->_sortID .= '_u';
 210     }
 211
 212     $params = array(
 213       'pageID' => $this->_pageID,
 214     );
 215
 216     // let the constructor initialize this, should happen only once
 217     if (!isset(self::$_template)) {
 218       self::$_template = CRM_Core_Smarty::singleton();
 219     }
 220
 221     $this->_sortOrder = &$this->_object->getSortOrder($action);
 222     $this->_sort = new CRM_Utils_Sort($this->_sortOrder, $this->_sortID);
 223
 224     /*
 225      * if we are in transfer mode, do not goto database, use the
 226      * session values instead
 227      */
 228
 229     if ($output == self::TRANSFER) {
 230       $params['total'] = $this->_store->get($this->_prefix . 'rowCount');
 231     }
 232     else {
 233       $params['total'] = $this->_object->getTotalCount($action, $this->_case);
 234     }
 235
 236     $this->_total = $params['total'];
 237     $this->_object->getPagerParams($action, $params);
 238
 239     /*
 240      * Set the default values of RowsPerPage
 241      */
 242
 243     $storeRowCount = $store->get($this->_prefix . CRM_Utils_Pager::PAGE_ROWCOUNT);
 244     if ($storeRowCount) {
 245       $params['rowCount'] = $storeRowCount;
 246     }
 247     elseif (!isset($params['rowCount'])) {
 248       $params['rowCount'] = CRM_Utils_Pager::ROWCOUNT;
 249     }
 250
 251     $this->_pager = new CRM_Utils_Pager($params);
 252     list($this->_pagerOffset, $this->_pagerRowCount) = $this->_pager->getOffsetAndRowCount();
 253   }
 254
 255   /**
 256    * Have the GET vars changed, i.e. pageId or sortId that forces us to recompute the search values
 257    *
 258    * @param int $reset
 259    *   Are we being reset.
 260    *
 261    * @return bool
 262    *   if the GET params are different from the session params
 263    */
 264   public function hasChanged($reset) {
 265
 266     /**
 267      * if we are in reset state, i.e the store is cleaned out, we return false
 268      * we also return if we dont have a record of the sort id or page id
 269      */
 270     if ($reset ||
 271       $this->_store->get($this->_prefix . CRM_Utils_Pager::PAGE_ID) == NULL ||
 272       $this->_store->get($this->_prefix . CRM_Utils_Sort::SORT_ID) == NULL
 273     ) {
 274       return FALSE;
 275     }
 276
 277     if ($this->_store->get($this->_prefix . CRM_Utils_Pager::PAGE_ID) != $this->_pager->getCurrentPageID() ||
 278       $this->_store->get($this->_prefix . CRM_Utils_Sort::SORT_ID) != $this->_sort->getCurrentSortID() ||
 279       $this->_store->get($this->_prefix . CRM_Utils_Sort::SORT_DIRECTION) != $this->_sort->getCurrentSortDirection()
 280     ) {
 281       return TRUE;
 282     }
 283     return FALSE;
 284   }
 285
 286   /**
 287    * Heart of the Controller. This is where all the action takes place
 288    *
 289    *   - The rows are fetched and stored depending on the type of output needed
 290    *
 291    *   - For export/printing all rows are selected.
 292    *
 293    *   - for displaying on screen paging parameters are used to display the
 294    *     required rows.
 295    *
 296    *   - also depending on output type of session or template rows are appropriately stored in session
 297    *     or template variables are updated.
 298    *
 299    *
 300    * @return void
 301    */
 302   public function run() {
 303
 304     // get the column headers
 305     $columnHeaders = &$this->_object->getColumnHeaders($this->_action, $this->_output);
 306
 307     $contextArray = explode('_', get_class($this->_object));
 308
 309     $contextName = strtolower($contextArray[1]);
 310
 311     // fix contribute and member
 312     if ($contextName == 'contribute') {
 313       $contextName = 'contribution';
 314     }
 315     elseif ($contextName == 'member') {
 316       $contextName = 'membership';
 317     }
 318
 319     // we need to get the rows if we are exporting or printing them
 320     if ($this->_output == self::EXPORT || $this->_output == self::SCREEN) {
 321       // get rows (without paging criteria)
 322       $rows = self::getRows($this);
 323       CRM_Utils_Hook::searchColumns($contextName, $columnHeaders, $rows, $this);
 324       if ($this->_output == self::EXPORT) {
 325         // export the rows.
 326         CRM_Core_Report_Excel::writeCSVFile($this->_object->getExportFileName(),
 327           $columnHeaders,
 328           $rows
 329         );
 330         CRM_Utils_System::civiExit();
 331       }
 332       else {
 333         // assign to template and display them.
 334         self::$_template->assign_by_ref('rows', $rows);
 335         self::$_template->assign_by_ref('columnHeaders', $columnHeaders);
 336       }
 337     }
 338     else {
 339       // output requires paging/sorting capability
 340       $rows = self::getRows($this);
 341       CRM_Utils_Hook::searchColumns($contextName, $columnHeaders, $rows, $this);
 342       $rowsEmpty = count($rows) ? FALSE : TRUE;
 343       $qill = $this->getQill();
 344       $summary = $this->getSummary();
 345       // if we need to store in session, lets update session
 346       if ($this->_output & self::SESSION) {
 347         $this->_store->set("{$this->_prefix}columnHeaders", $columnHeaders);
 348         if ($this->_dynamicAction) {
 349           $this->_object->removeActions($rows);
 350         }
 351         $this->_store->set("{$this->_prefix}rows", $rows);
 352         $this->_store->set("{$this->_prefix}rowCount", $this->_total);
 353         $this->_store->set("{$this->_prefix}rowsEmpty", $rowsEmpty);
 354         $this->_store->set("{$this->_prefix}qill", $qill);
 355         $this->_store->set("{$this->_prefix}summary", $summary);
 356       }
 357       else {
 358         self::$_template->assign_by_ref("{$this->_prefix}pager", $this->_pager);
 359         self::$_template->assign_by_ref("{$this->_prefix}sort", $this->_sort);
 360
 361         self::$_template->assign_by_ref("{$this->_prefix}columnHeaders", $columnHeaders);
 362         self::$_template->assign_by_ref("{$this->_prefix}rows", $rows);
 363         self::$_template->assign("{$this->_prefix}rowsEmpty", $rowsEmpty);
 364         self::$_template->assign("{$this->_prefix}qill", $qill);
 365         self::$_template->assign("{$this->_prefix}summary", $summary);
 366       }
 367
 368       // always store the current pageID and sortID
 369       $this->_store->set($this->_prefix . CRM_Utils_Pager::PAGE_ID,
 370         $this->_pager->getCurrentPageID()
 371       );
 372       $this->_store->set($this->_prefix . CRM_Utils_Sort::SORT_ID,
 373         $this->_sort->getCurrentSortID()
 374       );
 375       $this->_store->set($this->_prefix . CRM_Utils_Sort::SORT_DIRECTION,
 376         $this->_sort->getCurrentSortDirection()
 377       );
 378       $this->_store->set($this->_prefix . CRM_Utils_Sort::SORT_ORDER,
 379         $this->_sort->orderBy()
 380       );
 381       $this->_store->set($this->_prefix . CRM_Utils_Pager::PAGE_ROWCOUNT,
 382         $this->_pager->_perPage
 383       );
 384     }
 385   }
 386
 387   /**
 388    * Retrieve rows.
 389    *
 390    * @param CRM_Core_Form $form
 391    *
 392    * @return array
 393    *   Array of rows
 394    */
 395   public function getRows($form) {
 396     if ($form->_output == self::EXPORT || $form->_output == self::SCREEN) {
 397       //get rows (without paging criteria)
 398       return $form->_object->getRows($form->_action, 0, 0, $form->_sort, $form->_output);
 399     }
 400     else {
 401       return $form->_object->getRows($form->_action, $form->_pagerOffset, $form->_pagerRowCount,
 402         $form->_sort, $form->_output, $form->_case
 403       );
 404     }
 405   }
 406
 407   /**
 408    * Default function for qill, if needed to be implemented, we
 409    * expect the subclass to do it
 410    *
 411    * @return string
 412    *   the status message
 413    */
 414   public function getQill() {
 415     return $this->_object->getQill();
 416   }
 417
 418   /**
 419    * @return mixed
 420    */
 421   public function getSummary() {
 422     return $this->_object->getSummary();
 423   }
 424
 425   /**
 426    * Getter for pager.
 427    *
 428    * @return CRM_Utils_Pager
 429    */
 430   public function getPager() {
 431     return $this->_pager;
 432   }
 433
 434   /**
 435    * Getter for sort.
 436    *
 437    * @return CRM_Utils_Sort
 438    */
 439   public function getSort() {
 440     return $this->_sort;
 441   }
 442
 443   /**
 444    * Move the variables from the session to the template.
 445    *
 446    * @return void
 447    */
 448   public function moveFromSessionToTemplate() {
 449     self::$_template->assign_by_ref("{$this->_prefix}pager", $this->_pager);
 450
 451     $rows = $this->_store->get("{$this->_prefix}rows");
 452
 453     if ($rows) {
 454       if ($this->_dynamicAction) {
 455         $this->_object->addActions($rows);
 456       }
 457
 458       self::$_template->assign("{$this->_prefix}aToZ",
 459         $this->_store->get("{$this->_prefix}AToZBar")
 460       );
 461     }
 462
 463     self::$_template->assign_by_ref("{$this->_prefix}sort", $this->_sort);
 464     self::$_template->assign("{$this->_prefix}columnHeaders", $this->_store->get("{$this->_prefix}columnHeaders"));
 465     self::$_template->assign("{$this->_prefix}rows", $rows);
 466     self::$_template->assign("{$this->_prefix}rowsEmpty", $this->_store->get("{$this->_prefix}rowsEmpty"));
 467     self::$_template->assign("{$this->_prefix}qill", $this->_store->get("{$this->_prefix}qill"));
 468     self::$_template->assign("{$this->_prefix}summary", $this->_store->get("{$this->_prefix}summary"));
 469
 470     if ($this->_embedded) {
 471       return;
 472     }
 473
 474     self::$_template->assign('tplFile', $this->_object->getHookedTemplateFileName());
 475     if ($this->_print) {
 476       $content = self::$_template->fetch('CRM/common/print.tpl');
 477     }
 478     else {
 479       $config = CRM_Core_Config::singleton();
 480       $content = self::$_template->fetch('CRM/common/' . strtolower($config->userFramework) . '.tpl');
 481     }
 482     echo CRM_Utils_System::theme($content, $this->_print);
 483   }
 484
 485   /**
 486    * Setter for embedded.
 487    *
 488    * @param bool $embedded
 489    *
 490    * @return void
 491    */
 492   public function setEmbedded($embedded) {
 493     $this->_embedded = $embedded;
 494   }
 495
 496   /**
 497    * Getter for embedded.
 498    *
 499    * @return bool
 500    *   return the embedded value
 501    */
 502   public function getEmbedded() {
 503     return $this->_embedded;
 504   }
 505
 506   /**
 507    * Setter for print.
 508    *
 509    * @param bool $print
 510    *
 511    * @return void
 512    */
 513   public function setPrint($print) {
 514     $this->_print = $print;
 515   }
 516
 517   /**
 518    * Getter for print.
 519    *
 520    * @return bool
 521    *   return the print value
 522    */
 523   public function getPrint() {
 524     return $this->_print;
 525   }
 526
 527   /**
 528    * @param $value
 529    */
 530   public function setDynamicAction($value) {
 531     $this->_dynamicAction = $value;
 532   }
 533
 534   /**
 535    * @return bool
 536    */
 537   public function getDynamicAction() {
 538     return $this->_dynamicAction;
 539   }
 540
 541 }