CRM/Core/QuickForm/Action/Done.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  * Redefine the back action.
  30  *
  31  * @package CRM
  32  * @copyright CiviCRM LLC (c) 2004-2014
  33  * $Id$
  34  *
  35  */
  36 class CRM_Core_QuickForm_Action_Done extends CRM_Core_QuickForm_Action {
  37
  38   /**
  39    * class constructor
  40    *
  41    * @param object $stateMachine reference to state machine object
  42    *
  43    * @return \CRM_Core_QuickForm_Action_Done
  44   @access public
  45    */
  46   function __construct(&$stateMachine) {
  47     parent::__construct($stateMachine);
  48   }
  49
  50   /**
  51    * Processes the request.
  52    * this is basically a self submit, so validate the page
  53    * and if success, call post process
  54    * when done processing pop to user context
  55    *
  56    * @param  object    $page       CRM_Core_Form the current form-page
  57    * @param  string    $actionName Current action name, as one Action object can serve multiple actions
  58    *
  59    * @return void
  60    * @access public
  61    */
  62   function perform(&$page, $actionName) {
  63     $page->isFormBuilt() or $page->buildForm();
  64
  65     $pageName = $page->getAttribute('name');
  66     $data = &$page->controller->container();
  67     $data['values'][$pageName] = $page->exportValues();
  68     $data['valid'][$pageName] = $page->validate();
  69
  70     // Modal form and page is invalid: don't go further
  71     if ($page->controller->isModal() && !$data['valid'][$pageName]) {
  72       return $page->handle('display');
  73     }
  74
  75     // the page is valid, process it before we jump to the next state
  76     $page->mainProcess();
  77
  78     // ok so we are done now, pop stack and jump back to where we came from
  79     // we do not reset the context because u can achieve that affect using next
  80     // use Done when u want to pop back to the same context without a reset
  81     $this->popUserContext();
  82   }
  83 }
  84