CRM/Contribute/StateMachine/Search.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  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2014
  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    */
  42   protected $_task;
  43
  44   /**
  45    * Class constructor
  46    */ function __construct($controller, $action = CRM_Core_Action::NONE) {
  47     parent::__construct($controller, $action);
  48
  49     $this->_pages = array();
  50
  51     $this->_pages['CRM_Contribute_Form_Search'] = NULL;
  52     list($task, $result) = $this->taskName($controller, 'Search');
  53     $this->_task = $task;
  54
  55     if (is_array($task)) {
  56       foreach ($task as $t) {
  57         $this->_pages[$t] = NULL;
  58       }
  59     }
  60     else {
  61       $this->_pages[$task] = NULL;
  62     }
  63     if ($result) {
  64       $this->_pages['CRM_Contribute_Form_Task_Result'] = NULL;
  65     }
  66     $this->addSequentialPages($this->_pages, $action);
  67   }
  68
  69   /**
  70    * Determine the form name based on the action. This allows us
  71    * to avoid using  conditional state machine, much more efficient
  72    * and simpler
  73    *
  74    * @param CRM_Core_Controller $controller the controller object
  75    *
  76    * @param string $formName
  77    *
  78    * @return string the name of the form that will handle the task
  79    */
  80   public function taskName($controller, $formName = 'Search') {
  81     // total hack, check POST vars and then session to determine stuff
  82     $value = CRM_Utils_Array::value('task', $_POST);
  83     if (!isset($value)) {
  84       $value = $this->_controller->get('task');
  85     }
  86     $this->_controller->set('task', $value);
  87     return CRM_Contribute_Task::getTask($value);
  88   }
  89
  90   /**
  91    * Return the form name of the task
  92    *
  93    * @return string
  94    */
  95   public function getTaskFormName() {
  96     return CRM_Utils_String::getClassName($this->_task);
  97   }
  98
  99   /**
 100    * Since this is a state machine for search and we want to come back to the same state
 101    * we dont want to issue a reset of the state session when we are done processing a task
 102    *
 103    */
 104   public function shouldReset() {
 105     return FALSE;
 106   }
 107 }