CRM/Core/QuickForm/Action/Done.php

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