include/generic/SugarWidgets/SugarWidgetSubPanelTopButton.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-2012 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
  41
  42
  43 class SugarWidgetSubPanelTopButton extends SugarWidget
  44 {
  45     var $module;
  46         var $title;
  47         var $access_key;
  48         var $form_value;
  49         var $additional_form_fields;
  50         var $acl;
  51
  52 //TODO rename defines to layout defs and make it a member variable instead of passing it multiple layers with extra copying.
  53
  54         /** Take the keys for the strings and look them up.  Module is literal, the rest are label keys
  55         */
  56         function SugarWidgetSubPanelTopButton($module='', $title='', $access_key='', $form_value='')
  57         {
  58                 global $app_strings;
  59
  60                 if(is_array($module))
  61                 {
  62                         // it is really the class details from the mapping
  63                         $class_details = $module;
  64
  65                         // If keys were passed into the constructor, translate them from keys to values.
  66                         if(!empty($class_details['module']))
  67                                 $this->module = $class_details['module'];
  68                         if(!empty($class_details['title']))
  69                                 $this->title = $app_strings[$class_details['title']];
  70                         if(!empty($class_details['access_key']))
  71                                 $this->access_key = $app_strings[$class_details['access_key']];
  72                         if(!empty($class_details['form_value']))
  73                                 $this->form_value = translate($class_details['form_value'], $this->module);
  74                         if(!empty($class_details['additional_form_fields']))
  75                                 $this->additional_form_fields = $class_details['additional_form_fields'];
  76                         if(!empty($class_details['ACL'])){
  77                                 $this->acl = $class_details['ACL'];
  78                         }
  79                 }
  80                 else
  81                 {
  82                         $this->module = $module;
  83
  84                         // If keys were passed into the constructor, translate them from keys to values.
  85                         if(!empty($title))
  86                                 $this->title = $app_strings[$title];
  87                         if(!empty($access_key))
  88                                 $this->access_key = $app_strings[$access_key];
  89                         if(!empty($form_value))
  90                                 $this->form_value = translate($form_value, $module);
  91                 }
  92         }
  93
  94     public function getWidgetId($buttonSuffix = true)
  95     {
  96         $widgetID = parent::getWidgetId() . '_'.preg_replace('[ ]', '', strtolower($this->form_value));
  97         if($buttonSuffix){
  98                 $widgetID .= '_button';
  99         }
 100         return $widgetID;
 101     }
 102
 103     function &_get_form($defines, $additionalFormFields = null, $asUrl = false)
 104     {
 105         global $app_strings;
 106         global $currentModule;
 107
 108         // Create the additional form fields with real values if they were not passed in
 109         if(empty($additionalFormFields) && $this->additional_form_fields)
 110         {
 111             foreach($this->additional_form_fields as $key=>$value)
 112             {
 113                 if(!empty($defines['focus']->$value))
 114                 {
 115                     $additionalFormFields[$key] = $defines['focus']->$value;
 116                 }
 117                 else
 118                 {
 119                     $additionalFormFields[$key] = '';
 120                 }
 121             }
 122         }
 123
 124
 125                 if(!empty($this->module))
 126         {
 127             $defines['child_module_name'] = $this->module;
 128         }
 129         else
 130         {
 131             $defines['child_module_name'] = $defines['module'];
 132         }
 133
 134         $defines['parent_bean_name'] = get_class( $defines['focus']);
 135                 $relationship_name = $this->get_subpanel_relationship_name($defines);
 136
 137
 138         $formValues = array();
 139
 140         //module_button is used to override the value of module name
 141         $formValues['module'] = $defines['child_module_name'];
 142         $formValues[strtolower($defines['parent_bean_name'])."_id"] = $defines['focus']->id;
 143
 144         if(isset($defines['focus']->name))
 145         {
 146             $formValues[strtolower($defines['parent_bean_name'])."_name"] = $defines['focus']->name;
 147             // #26451,add these fields for custom one-to-many relate field.
 148             if(!empty($defines['child_module_name'])){
 149                 $formValues[$relationship_name."_name"] = $defines['focus']->name;
 150                 $childFocusName = !empty($GLOBALS['beanList'][$defines['child_module_name']]) ? $GLOBALS['beanList'][$defines['child_module_name']] : "";
 151                 if(!empty($GLOBALS['dictionary'][ $childFocusName ]["fields"][$relationship_name .'_name']['id_name'])){
 152                         $formValues[$GLOBALS['dictionary'][ $childFocusName ]["fields"][$relationship_name .'_name']['id_name']] = $defines['focus']->id;
 153                 }
 154             }
 155         }
 156
 157         $formValues['return_module'] = $currentModule;
 158
 159         if($currentModule == 'Campaigns'){
 160             $formValues['return_action'] = "DetailView";
 161         }else{
 162             $formValues['return_action'] = $defines['action'];
 163             if ( $formValues['return_action'] == 'SubPanelViewer' ) {
 164                 $formValues['return_action'] = 'DetailView';
 165             }
 166         }
 167
 168         $formValues['return_id'] = $defines['focus']->id;
 169         $formValues['return_relationship'] = $relationship_name;
 170         switch ( strtolower( $currentModule ) )
 171         {
 172             case 'prospects' :
 173                 $name = $defines['focus']->account_name ;
 174                 break ;
 175             case 'documents' :
 176                 $name = $defines['focus']->document_name ;
 177                 break ;
 178             case 'kbdocuments' :
 179                 $name = $defines['focus']->kbdocument_name ;
 180                 break ;
 181             case 'leads' :
 182             case 'contacts' :
 183                 $name = $defines['focus']->first_name . " " .$defines['focus']->last_name ;
 184                 break ;
 185             default :
 186                $name = (isset($defines['focus']->name)) ? $defines['focus']->name : "";
 187         }
 188         $formValues['return_name'] = $name;
 189
 190         // TODO: move this out and get $additionalFormFields working properly
 191         if(empty($additionalFormFields['parent_type']))
 192         {
 193             if($defines['focus']->object_name=='Contact') {
 194                 $additionalFormFields['parent_type'] = 'Accounts';
 195             }
 196             else {
 197                 $additionalFormFields['parent_type'] = $defines['focus']->module_dir;
 198             }
 199         }
 200         if(empty($additionalFormFields['parent_name']))
 201         {
 202             if($defines['focus']->object_name=='Contact') {
 203                 $additionalFormFields['parent_name'] = $defines['focus']->account_name;
 204                 $additionalFormFields['account_name'] = $defines['focus']->account_name;
 205             }
 206             else {
 207                 $additionalFormFields['parent_name'] = $defines['focus']->name;
 208             }
 209         }
 210         if(empty($additionalFormFields['parent_id']))
 211         {
 212             if($defines['focus']->object_name=='Contact') {
 213                 $additionalFormFields['parent_id'] = $defines['focus']->account_id;
 214                 $additionalFormFields['account_id'] = $defines['focus']->account_id;
 215             } else if($defines['focus']->object_name=='Contract') {
 216                 $additionalFormFields['contract_id'] = $defines['focus']->id;
 217             } else {
 218                 $additionalFormFields['parent_id'] = $defines['focus']->id;
 219             }
 220         }
 221
 222         if ($defines['focus']->object_name=='Opportunity') {
 223             $additionalFormFields['account_id'] = $defines['focus']->account_id;
 224             $additionalFormFields['account_name'] = $defines['focus']->account_name;
 225         }
 226
 227         if (!empty($defines['child_module_name']) and $defines['child_module_name']=='Contacts' and !empty($defines['parent_bean_name']) and $defines['parent_bean_name']=='contact' ) {
 228             if (!empty($defines['focus']->id ) and !empty($defines['focus']->name)) {
 229                 $formValues['reports_to_id'] = $defines['focus']->id;
 230                 $formValues['reports_to_name'] = $defines['focus']->name;
 231             }
 232         }
 233         $formValues['action'] = "EditView";
 234
 235         if ( $asUrl ) {
 236             $returnLink = '';
 237             foreach($formValues as $key => $value ) {
 238                 $returnLink .= $key.'='.$value.'&';
 239             }
 240             foreach($additionalFormFields as $key => $value ) {
 241                 $returnLink .= $key.'='.$value.'&';
 242             }
 243             $returnLink = rtrim($returnLink,'&');
 244
 245             return $returnLink;
 246         } else {
 247
 248             $form = 'form' . $relationship_name;
 249             $button = '<form action="index.php" method="post" name="form" id="' . $form . "\">\n";
 250             foreach($formValues as $key => $value) {
 251                 $button .= "<input type='hidden' name='" . $key . "' value='" . $value . "' />\n";
 252             }
 253
 254             // fill in additional form fields for all but action
 255             foreach($additionalFormFields as $key => $value) {
 256                 if($key != 'action') {
 257                     $button .= "<input type='hidden' name='" . $key . "' value='" . $value . "' />\n";
 258                 }
 259             }
 260
 261
 262         return $button;
 263         }
 264     }
 265
 266         /** This default function is used to create the HTML for a simple button */
 267         function display($defines, $additionalFormFields = null, $nonbutton = false)
 268         {
 269                 $temp='';
 270                 $inputID = $this->getWidgetId();
 271
 272                 if(!empty($this->acl) && ACLController::moduleSupportsACL($defines['module'])  &&  !ACLController::checkAccess($defines['module'], $this->acl, true)){
 273                         return $temp;
 274                 }
 275
 276                 global $app_strings;
 277
 278         if ( isset($_REQUEST['layout_def_key']) && $_REQUEST['layout_def_key'] == 'UserEAPM' ) {
 279             // Subpanels generally don't go on the editview, so we have to handle this special
 280             $megaLink = $this->_get_form($defines, $additionalFormFields,true);
 281             $button = "<input title='$this->title' accesskey='$this->access_key' class='button' type='submit' name='$inputID' id='$inputID' value='$this->form_value' onclick='javascript:document.location=\"index.php?".$megaLink."\"; return false;'/>";
 282         } else {
 283             $button = $this->_get_form($defines, $additionalFormFields);
 284             $button .= "<input title='$this->title' accesskey='$this->access_key' class='button' type='submit' name='$inputID' id='$inputID' value='$this->form_value' />\n</form>";
 285         }
 286
 287         if ($nonbutton) {
 288             $button = "<a onclick=''>$this->form_value";
 289         }
 290         return $button;
 291         }
 292
 293         /**
 294          * Returns a string that is the JSON encoded version of the popup request.
 295          * Perhaps this function should be moved to a more globally accessible location?
 296          */
 297         function _create_json_encoded_popup_request($popup_request_data)
 298         {
 299                 $popup_request_array = array();
 300
 301                 if(!empty($popup_request_data['call_back_function']))
 302                 {
 303                         $popup_request_array[] = '"call_back_function":"' . $popup_request_data['call_back_function'] . '"';
 304                 }
 305
 306                 if(!empty($popup_request_data['form_name']))
 307                 {
 308                         $popup_request_array[] = '"form_name":"' . $popup_request_data['form_name'] . '"';
 309                 }
 310
 311                 if(!empty($popup_request_data['field_to_name_array']))
 312                 {
 313                         $field_to_name_array = array();
 314                         foreach($popup_request_data['field_to_name_array'] as $field => $name)
 315                         {
 316                                 $field_to_name_array[] = '"' . $field . '":"' . $name . '"';
 317                         }
 318
 319                         $popup_request_array[] = '"field_to_name_array":{' . implode(',', $field_to_name_array) . '}';
 320                 }
 321
 322                 if(!empty($popup_request_data['passthru_data']))
 323                 {
 324                         $passthru_array = array();
 325                         foreach($popup_request_data['passthru_data'] as $field => $name)
 326                         {
 327                                 $passthru_array[] = '"' . $field . '":"' . $name . '"';
 328                         }
 329
 330                         $popup_request_array[] = '"passthru_data":{' . implode(',', $passthru_array) . '}';
 331                 }
 332
 333                 $encoded_popup_request = '{' . implode(',', $popup_request_array) . '}';
 334
 335                 return $encoded_popup_request;
 336         }
 337
 338         /**
 339          * get_subpanel_relationship_name
 340          * Get the relationship name based on the subapnel definition
 341          * @param mixed $defines The subpanel definition
 342          */
 343         function get_subpanel_relationship_name($defines) {
 344                  $relationship_name = '';
 345                  if(!empty($defines)) {
 346                         $relationship_name = isset($defines['module']) ? $defines['module'] : '';
 347                 $dataSource = $defines['subpanel_definition']->get_data_source_name(true);
 348                 if (!empty($dataSource)) {
 349                                 $relationship_name = $dataSource;
 350                                 //Try to set the relationship name to the real relationship, not the link.
 351                                 if (!empty($defines['subpanel_definition']->parent_bean->field_defs[$dataSource])
 352                                  && !empty($defines['subpanel_definition']->parent_bean->field_defs[$dataSource]['relationship']))
 353                                 {
 354                                         $relationship_name = $defines['subpanel_definition']->parent_bean->field_defs[$dataSource]['relationship'];
 355                                 }
 356                         }
 357                  }
 358                  return $relationship_name;
 359         }
 360
 361 }
 362 ?>