CRM/Contribute/StateMachine/Search.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.3                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   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  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2013
  32  * $Id$
  33  *
  34  */
  35 class CRM_Contribute_StateMachine_Search extends CRM_Core_StateMachine {
  36
  37   /**
  38    * The task that the wizard is currently processing
  39    *
  40    * @var string
  41    * @protected
  42    */
  43   protected $_task;
  44
  45   /**
  46    * class constructor
  47    */ function __construct($controller, $action = CRM_Core_Action::NONE) {
  48     parent::__construct($controller, $action);
  49
  50     $this->_pages = array();
  51
  52     $this->_pages['CRM_Contribute_Form_Search'] = NULL;
  53     list($task, $result) = $this->taskName($controller, 'Search');
  54     $this->_task = $task;
  55
  56     if (is_array($task)) {
  57       foreach ($task as $t) {
  58         $this->_pages[$t] = NULL;
  59       }
  60     }
  61     else {
  62       $this->_pages[$task] = NULL;
  63     }
  64     if ($result) {
  65       $this->_pages['CRM_Contribute_Form_Task_Result'] = NULL;
  66     }
  67     $this->addSequentialPages($this->_pages, $action);
  68   }
  69
  70   /**
  71    * Determine the form name based on the action. This allows us
  72    * to avoid using  conditional state machine, much more efficient
  73    * and simpler
  74    *
  75    * @param CRM_Core_Controller $controller the controller object
  76    *
  77    * @return string the name of the form that will handle the task
  78    * @access protected
  79    */
  80   function taskName($controller, $formName = 'Search') {
  81     // total hack, check POST vars and then session to determine stuff
  82     // fix value if print button is pressed
  83     if (CRM_Utils_Array::value('_qf_' . $formName . '_next_print', $_POST)) {
  84       $value = CRM_Contribute_Task::PRINT_CONTRIBUTIONS;
  85     }
  86     else {
  87       $value = CRM_Utils_Array::value('task', $_POST);
  88     }
  89     if (!isset($value)) {
  90       $value = $this->_controller->get('task');
  91     }
  92     $this->_controller->set('task', $value);
  93     return CRM_Contribute_Task::getTask($value);
  94   }
  95
  96   /**
  97    * return the form name of the task
  98    *
  99    * @return string
 100    * @access public
 101    */
 102   function getTaskFormName() {
 103     return CRM_Utils_String::getClassName($this->_task);
 104   }
 105
 106   /**
 107    * Since this is a state machine for search and we want to come back to the same state
 108    * we dont want to issue a reset of the state session when we are done processing a task
 109    *
 110    */
 111   function shouldReset() {
 112     return FALSE;
 113   }
 114 }
 115