CRM/Contact/StateMachine/Search.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   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-2015
  32  */
  33 class CRM_Contact_StateMachine_Search extends CRM_Core_StateMachine {
  34
  35   /**
  36    * The task that the wizard is currently processing
  37    *
  38    * @var string
  39    */
  40   protected $_task;
  41
  42   /**
  43    * Class constructor.
  44    *
  45    * @param object $controller
  46    * @param \const|int $action
  47    */
  48   public function __construct($controller, $action = CRM_Core_Action::NONE) {
  49     parent::__construct($controller, $action);
  50
  51     $this->_pages = array();
  52     if ($action == CRM_Core_Action::ADVANCED) {
  53       $this->_pages['CRM_Contact_Form_Search_Advanced'] = NULL;
  54       list($task, $result) = $this->taskName($controller, 'Advanced');
  55     }
  56     elseif ($action == CRM_Core_Action::PROFILE) {
  57       $this->_pages['CRM_Contact_Form_Search_Builder'] = NULL;
  58       list($task, $result) = $this->taskName($controller, 'Builder');
  59     }
  60     elseif ($action == CRM_Core_Action::COPY) {
  61       $this->_pages['CRM_Contact_Form_Search_Custom'] = NULL;
  62       list($task, $result) = $this->taskName($controller, 'Custom');
  63     }
  64     else {
  65       $this->_pages['CRM_Contact_Form_Search_Basic'] = NULL;
  66       list($task, $result) = $this->taskName($controller, 'Basic');
  67     }
  68     $this->_task = $task;
  69     if (is_array($task)) {
  70       foreach ($task as $t) {
  71         $this->_pages[$t] = NULL;
  72       }
  73     }
  74     else {
  75       $this->_pages[$task] = NULL;
  76     }
  77
  78     if ($result) {
  79       $this->_pages['CRM_Contact_Form_Task_Result'] = NULL;
  80     }
  81
  82     $this->addSequentialPages($this->_pages, $action);
  83   }
  84
  85   /**
  86    * Determine the form name based on the action. This allows us
  87    * to avoid using  conditional state machine, much more efficient
  88    * and simpler
  89    *
  90    * @param CRM_Core_Controller $controller
  91    *   The controller object.
  92    *
  93    * @param string $formName
  94    *
  95    * @return string
  96    *   the name of the form that will handle the task
  97    */
  98   public function taskName($controller, $formName = 'Search') {
  99     // total hack, check POST vars and then session to determine stuff
 100     $value = CRM_Utils_Array::value('task', $_POST);
 101     if (!isset($value)) {
 102       $value = $this->_controller->get('task');
 103     }
 104     $this->_controller->set('task', $value);
 105
 106     if ($value) {
 107       $componentMode = $this->_controller->get('component_mode');
 108       $modeValue = CRM_Contact_Form_Search::getModeValue($componentMode);
 109       $taskClassName = $modeValue['taskClassName'];
 110       return $taskClassName::getTask($value);
 111     }
 112     else {
 113       return CRM_Contact_Task::getTask($value);
 114     }
 115   }
 116
 117   /**
 118    * Return the form name of the task.
 119    *
 120    * @return string
 121    */
 122   public function getTaskFormName() {
 123     if (is_array($this->_task)) {
 124       // return first page
 125       return CRM_Utils_String::getClassName($this->_task[0]);
 126     }
 127     else {
 128       return CRM_Utils_String::getClassName($this->_task);
 129     }
 130   }
 131
 132   /**
 133    * Since this is a state machine for search and we want to come back to the same state
 134    * we dont want to issue a reset of the state session when we are done processing a task
 135    */
 136   public function shouldReset() {
 137     return FALSE;
 138   }
 139
 140 }