INFRA-132 - Docblock formatting fixes
[civicrm-core.git] / CRM / Grant / 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_Grant_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
52 $this->_pages['CRM_Grant_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
65 if ($result) {
66 $this->_pages['CRM_Grant_Form_Task_Result'] = NULL;
67 }
68
69 $this->addSequentialPages($this->_pages, $action);
70 }
71
72 /**
73 * Determine the form name based on the action. This allows us
74 * to avoid using conditional state machine, much more efficient
75 * and simpler
76 *
77 * @param CRM_Core_Controller $controller
78 * The controller object.
79 *
80 * @param string $formName
81 *
82 * @return string
83 * the name of the form that will handle the task
84 */
85 public function taskName($controller, $formName = 'Search') {
86 // total hack, check POST vars and then session to determine stuff
87 $value = CRM_Utils_Array::value('task', $_POST);
88 if (!isset($value)) {
89 $value = $this->_controller->get('task');
90 }
91 $this->_controller->set('task', $value);
92
93 return CRM_Grant_Task::getTask($value);
94 }
95
96 /**
97 * Return the form name of the task
98 *
99 * @return string
100 */
101 public function getTaskFormName() {
102 return CRM_Utils_String::getClassName($this->_task);
103 }
104 }