CRM/Core/QuickForm/Action.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   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  * 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
  33  * @copyright CiviCRM LLC (c) 2004-2014
  34  * $Id$
  35  *
  36  */
  37 require_once 'HTML/QuickForm/Action.php';
  38 class CRM_Core_QuickForm_Action extends HTML_QuickForm_Action {
  39
  40   /**
  41    * reference to the state machine i belong to
  42    * @var object
  43    */
  44   protected $_stateMachine;
  45
  46   /**
  47    * constructor
  48    *
  49    * @param object $stateMachine reference to state machine object
  50    *
  51    * @return \CRM_Core_QuickForm_Action
  52   @access public
  53    */
  54   function __construct(&$stateMachine) {
  55     $this->_stateMachine = &$stateMachine;
  56   }
  57
  58   /**
  59    * returns the user to the top of the user context stack.
  60    *
  61    * @return void
  62    * @access public
  63    */
  64   function popUserContext() {
  65     $session = CRM_Core_Session::singleton();
  66     $config = CRM_Core_Config::singleton();
  67
  68     // check if destination is set, if so goto destination
  69     $destination = $this->_stateMachine->getDestination();
  70     if ($destination) {
  71       $destination = urldecode($destination);
  72     }
  73     else {
  74       $destination = $session->popUserContext();
  75
  76       if (empty($destination)) {
  77         $destination = $config->userFrameworkBaseURL;
  78       }
  79     }
  80
  81     //CRM-5839 -do not redirect control.
  82     if (!$this->_stateMachine->getSkipRedirection()) {
  83       CRM_Utils_System::redirect($destination);
  84     }
  85   }
  86 }
  87