include/SugarObjects/forms/FormBase.php

   1 <?php
   2 if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
   3 /*********************************************************************************
   4  * SugarCRM Community Edition is a customer relationship management program developed by
   5  * SugarCRM, Inc. Copyright (C) 2004-2011 SugarCRM Inc.
   6  *
   7  * This program is free software; you can redistribute it and/or modify it under
   8  * the terms of the GNU Affero General Public License version 3 as published by the
   9  * Free Software Foundation with the addition of the following permission added
  10  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
  11  * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
  12  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
  13  *
  14  * This program is distributed in the hope that it will be useful, but WITHOUT
  15  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  16  * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
  17  * details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License along with
  20  * this program; if not, see http://www.gnu.org/licenses or write to the Free
  21  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  22  * 02110-1301 USA.
  23  *
  24  * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
  25  * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
  26  *
  27  * The interactive user interfaces in modified source and object code versions
  28  * of this program must display Appropriate Legal Notices, as required under
  29  * Section 5 of the GNU Affero General Public License version 3.
  30  *
  31  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
  32  * these Appropriate Legal Notices must retain the display of the "Powered by
  33  * SugarCRM" logo. If the display of the logo is not reasonably feasible for
  34  * technical reasons, the Appropriate Legal Notices must display the words
  35  * "Powered by SugarCRM".
  36  ********************************************************************************/
  37
  38
  39 /**
  40  * FormBase.php
  41  *
  42  * @author Collin Lee
  43  *
  44  * This is an abstract class to provide common functionality across the form base code used in the application.
  45  *
  46  * @see LeadFormBase.php, ContactFormBase.php, MeetingFormBase, CallFormBase.php
  47  */
  48
  49 abstract class FormBase {
  50
  51
  52 /**
  53  * isSaveFromDCMenu
  54  *
  55  * This is a function to help assist in determining if a save operation has been performed from the DCMenu (the shortcut bar
  56  * up top available for most themes).
  57  *
  58  * @return bool Boolean value indicating whether or not the save operation was triggered from DCMenu
  59  */
  60 protected function isSaveFromDCMenu()
  61 {
  62     return (isset($_POST['from_dcmenu']) && $_POST['from_dcmenu']);
  63 }
  64
  65
  66 /**
  67  * isEmptyReturnModuleAndAction
  68  *
  69  * This is a function to help assist in determining if a save operation has been performed without a return module and action specified.
  70  * This will likely be the case where we use AJAX to change the state of a record, but wish to keep the user remaining on the same view.
  71  * For example, this is true when closing Calls and Meetings from dashlets or from from subpanels.
  72  *
  73  * @return bool Boolean value indicating whether or not a return module and return action are specified in request
  74  */
  75 protected function isEmptyReturnModuleAndAction()
  76 {
  77     return empty($_POST['return_module']) && empty($_POST['return_action']);
  78 }
  79
  80
  81 }
  82