Merge remote-tracking branch 'upstream/4.4' into 4.4-master-2014-07-16-12-52-48
[civicrm-core.git] / CRM / Core / QuickForm / Action.php
CommitLineData
6a488035
TO
1<?php
2/*
3 +--------------------------------------------------------------------+
06b69b18 4 | CiviCRM version 4.5 |
6a488035 5 +--------------------------------------------------------------------+
06b69b18 6 | Copyright CiviCRM LLC (c) 2004-2014 |
6a488035
TO
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 * This is the base Action class for all actions which we redefine. This is
30 * integrated with the StateMachine, Controller and State objects
31 *
32 * @package CRM
06b69b18 33 * @copyright CiviCRM LLC (c) 2004-2014
6a488035
TO
34 * $Id$
35 *
36 */
37require_once 'HTML/QuickForm/Action.php';
28518c90
EM
38
39/**
40 * Class CRM_Core_QuickForm_Action
41 */
6a488035
TO
42class CRM_Core_QuickForm_Action extends HTML_QuickForm_Action {
43
44 /**
45 * reference to the state machine i belong to
46 * @var object
47 */
48 protected $_stateMachine;
49
50 /**
51 * constructor
52 *
77b97be7 53 * @param object $stateMachine reference to state machine object
6a488035 54 *
77b97be7
EM
55 * @return \CRM_Core_QuickForm_Action
56 @access public
57 */
58 function __construct(&$stateMachine) {
6a488035
TO
59 $this->_stateMachine = &$stateMachine;
60 }
61
62 /**
63 * returns the user to the top of the user context stack.
64 *
65 * @return void
66 * @access public
67 */
68 function popUserContext() {
69 $session = CRM_Core_Session::singleton();
70 $config = CRM_Core_Config::singleton();
71
72 // check if destination is set, if so goto destination
73 $destination = $this->_stateMachine->getDestination();
74 if ($destination) {
75 $destination = urldecode($destination);
76 }
77 else {
78 $destination = $session->popUserContext();
79
80 if (empty($destination)) {
81 $destination = $config->userFrameworkBaseURL;
82 }
83 }
84
85 //CRM-5839 -do not redirect control.
86 if (!$this->_stateMachine->getSkipRedirection()) {
87 CRM_Utils_System::redirect($destination);
88 }
89 }
90}
91