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