CRM/Event/StateMachine/Search.php

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