modules/ModuleBuilder/parsers/relationships/ActivitiesRelationship.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 require_once 'modules/ModuleBuilder/parsers/relationships/OneToManyRelationship.php' ;
  40
  41 /*
  42  * Class to manage the metadata for a One-To-Many Relationship
  43  * The One-To-Many relationships created by this class are a combination of a subpanel and a custom relate field
  44  * The LHS (One) module will receive a new subpanel for the RHS module. The subpanel gets its data ('get_subpanel_data') from a link field that references a new Relationship
  45  * The RHS (Many) module will receive a new relate field to point back to the LHS
  46  *
  47  * OOB modules implement One-To-Many relationships as:
  48  *
  49  * On the LHS (One) side:
  50  * A Relationship of type one-to-many in the rhs modules vardefs.php
  51  * A link field in the same vardefs.php with 'relationship'= the relationship name and 'source'='non-db'
  52  * A subpanel which gets its data (get_subpanel_data) from the link field
  53  *
  54  * On the RHS (Many) side:
  55  * A Relate field in the vardefs, formatted as in this example, which references a link field:
  56  * 'name' => 'account_name',
  57  * 'rname' => 'name',
  58  * 'id_name' => 'account_id',
  59  * 'vname' => 'LBL_ACCOUNT_NAME',
  60  * 'join_name'=>'accounts',
  61  * 'type' => 'relate',
  62  * 'link' => 'accounts',
  63  * 'table' => 'accounts',
  64  * 'module' => 'Accounts',
  65  * 'source' => 'non-db'
  66  * A link field which references the shared Relationship
  67  */
  68
  69 class ActivitiesRelationship extends OneToManyRelationship
  70 {
  71
  72         protected static $subpanelsAdded = array();
  73         protected static $labelsAdded = array();
  74
  75         /*
  76      * Constructor
  77      * @param array $definition Parameters passed in as array defined in parent::$definitionKeys
  78      * The lhs_module value is for the One side; the rhs_module value is for the Many
  79      */
  80     function __construct ($definition)
  81     {
  82         parent::__construct ( $definition ) ;
  83     }
  84
  85     /*
  86      * BUILD methods called during the build
  87      */
  88
  89         /*
  90      * Define the labels to be added to the module for the new relationships
  91      * @return array    An array of system value => display value
  92      */
  93     function buildLabels ()
  94     {
  95         $labelDefinitions = array ( ) ;
  96         if (!$this->relationship_only )
  97         {
  98             if (!isset(ActivitiesRelationship::$labelsAdded[$this->lhs_module])) {
  99                         $labelDefinitions [] = array (
 100                         'module' => 'application' ,
 101                         'system_label' => 'parent_type_display',
 102                         'display_label' => array ( $this->lhs_module => ucfirst ( $this->lhs_module ))
 103                     ) ;
 104
 105                     $labelDefinitions [] = array (
 106                         'module' => 'application' ,
 107                         'system_label' => 'record_type_display',
 108                         'display_label' => array ( $this->lhs_module => ucfirst ( $this->lhs_module ))
 109                     ) ;
 110
 111                     $labelDefinitions [] = array (
 112                         'module' => 'application' ,
 113                         'system_label' => 'record_type_display_notes',
 114                         'display_label' => array ( $this->lhs_module => ucfirst ( $this->lhs_module ))
 115                     ) ;
 116             }
 117
 118             $labelDefinitions [] = array (
 119                 'module' => $this->lhs_module ,
 120                 'system_label' => 'LBL_' . strtoupper ( $this->relationship_name . '_FROM_' . $this->getRightModuleSystemLabel() ) . '_TITLE' ,
 121                 'display_label' => /*'*' .*/ ucfirst ( $this->rhs_module )
 122             ) ;
 123             ActivitiesRelationship::$labelsAdded[$this->lhs_module] = true;
 124         }
 125         return $labelDefinitions ;
 126     }
 127
 128
 129         /*
 130      * @return array    An array of field definitions, ready for the vardefs, keyed by module
 131      */
 132     function buildVardefs ( )
 133     {
 134         $vardefs = array ( ) ;
 135
 136         $vardefs [ $this->rhs_module ] [] = $this->getLinkFieldDefinition ( $this->lhs_module, $this->relationship_name ) ;
 137         $vardefs [ $this->lhs_module ] [] = $this->getLinkFieldDefinition ( $this->rhs_module, $this->relationship_name ) ;
 138
 139
 140         return $vardefs ;
 141     }
 142
 143         protected function getLinkFieldDefinition ($sourceModule , $relationshipName)
 144     {
 145         $vardef = array ( ) ;
 146         $vardef [ 'name' ] = $relationshipName;
 147         $vardef [ 'type' ] = 'link' ;
 148         $vardef [ 'relationship' ] = $relationshipName ;
 149         $vardef [ 'source' ] = 'non-db' ;
 150         $vardef [ 'vname' ] = strtoupper("LBL_{$relationshipName}_FROM_{$sourceModule}_TITLE");
 151         return $vardef ;
 152     }
 153
 154     /*
 155      * Define what fields to add to which modules layouts
 156      * @return array    An array of module => fieldname
 157      */
 158     function buildFieldsToLayouts ()
 159     {
 160         if ($this->relationship_only)
 161             return array () ;
 162
 163         return array( $this->rhs_module => $this->relationship_name . "_name" ) ; // this must match the name of the relate field from buildVardefs
 164     }
 165
 166         function buildSubpanelDefinitions ()
 167     {
 168         if ($this->relationship_only || isset(ActivitiesRelationship::$subpanelsAdded[$this->lhs_module]))
 169             return array () ;
 170
 171         ActivitiesRelationship::$subpanelsAdded[$this->lhs_module] = true;
 172         $relationshipName = substr($this->relationship_name, 0, strrpos($this->relationship_name, '_'));
 173         return array( $this->lhs_module => array (
 174                                   'activities' => $this->buildActivitiesSubpanelDefinition ( $relationshipName ),
 175                                   'history' => $this->buildHistorySubpanelDefinition ( $relationshipName ) ,
 176                                 ));
 177     }
 178
 179     /*
 180      * @return array    An array of relationship metadata definitions
 181      */
 182     function buildRelationshipMetaData ()
 183     {
 184         $relationshipName = $this->definition [ 'relationship_name' ];
 185         $relMetadata = array ( ) ;
 186         $relMetadata [ 'lhs_module' ] = $this->definition [ 'lhs_module' ] ;
 187         $relMetadata [ 'lhs_table' ] = $this->getTablename($this->definition [ 'lhs_module' ]) ;
 188         $relMetadata [ 'lhs_key' ] = 'id' ;
 189         $relMetadata [ 'rhs_module' ] = $this->definition [ 'rhs_module' ] ;
 190         $relMetadata [ 'rhs_table' ] = $this->getTablename($this->definition [ 'rhs_module' ]) ;
 191         $relMetadata ['rhs_key'] = 'parent_id';
 192         $relMetadata ['relationship_type'] = 'one-to-many';
 193         $relMetadata ['relationship_role_column'] = 'parent_type';
 194         $relMetadata ['relationship_role_column_value'] = $this->definition [ 'lhs_module' ] ;
 195
 196         return array( $this->lhs_module => array(
 197                 'relationships' => array ($relationshipName => $relMetadata),
 198                 'fields' => '', 'indices' => '', 'table' => '')
 199         ) ;
 200     }
 201
 202 /*
 203      * Shortcut to construct an Activities collection subpanel
 204      * @param AbstractRelationship $relationship    Source relationship to Activities module
 205      */
 206     protected function buildActivitiesSubpanelDefinition ( $relationshipName )
 207     {
 208                 return array (
 209             'order' => 10 ,
 210             'sort_order' => 'desc' ,
 211             'sort_by' => 'date_start' ,
 212             'title_key' => 'LBL_ACTIVITIES_SUBPANEL_TITLE' ,
 213             'type' => 'collection' ,
 214             'subpanel_name' => 'activities' , //this value is not associated with a physical file
 215             'module' => 'Activities' ,
 216             'top_buttons' => array (
 217                 array ( 'widget_class' => 'SubPanelTopCreateTaskButton' ) ,
 218                 array ( 'widget_class' => 'SubPanelTopScheduleMeetingButton' ) ,
 219                 array ( 'widget_class' => 'SubPanelTopScheduleCallButton' ) ,
 220                 array ( 'widget_class' => 'SubPanelTopComposeEmailButton' ) ) ,
 221                 'collection_list' => array (
 222                     'meetings' => array (
 223                         'module' => 'Meetings' ,
 224                         'subpanel_name' => 'ForActivities' ,
 225                         'get_subpanel_data' => $relationshipName. '_meetings' ) ,
 226                     'tasks' => array (
 227                         'module' => 'Tasks' ,
 228                         'subpanel_name' => 'ForActivities' ,
 229                         'get_subpanel_data' => $relationshipName. '_tasks' ) ,
 230                     'calls' => array (
 231                         'module' => 'Calls' ,
 232                         'subpanel_name' => 'ForActivities' ,
 233                         'get_subpanel_data' => $relationshipName. '_calls' ) ) ) ;
 234     }
 235
 236     /*
 237      * Shortcut to construct a History collection subpanel
 238      * @param AbstractRelationship $relationship    Source relationship to Activities module
 239      */
 240     protected function buildHistorySubpanelDefinition ( $relationshipName )
 241     {
 242         return array (
 243             'order' => 20 ,
 244             'sort_order' => 'desc' ,
 245             'sort_by' => 'date_modified' ,
 246             'title_key' => 'LBL_HISTORY' ,
 247             'type' => 'collection' ,
 248             'subpanel_name' => 'history' , //this values is not associated with a physical file.
 249             'module' => 'History' ,
 250             'top_buttons' => array (
 251                 array ( 'widget_class' => 'SubPanelTopCreateNoteButton' ) ,
 252                                 array ( 'widget_class' => 'SubPanelTopArchiveEmailButton'),
 253                 array ( 'widget_class' => 'SubPanelTopSummaryButton' ) ) ,
 254                 'collection_list' => array (
 255                     'meetings' => array (
 256                         'module' => 'Meetings' ,
 257                         'subpanel_name' => 'ForHistory' ,
 258                         'get_subpanel_data' => $relationshipName. '_meetings' ) ,
 259                     'tasks' => array (
 260                         'module' => 'Tasks' ,
 261                         'subpanel_name' => 'ForHistory' ,
 262                         'get_subpanel_data' => $relationshipName. '_tasks' ) ,
 263                     'calls' => array (
 264                         'module' => 'Calls' ,
 265                         'subpanel_name' => 'ForHistory' ,
 266                         'get_subpanel_data' => $relationshipName. '_calls' ) ,
 267                     'notes' => array (
 268                         'module' => 'Notes' ,
 269                         'subpanel_name' => 'ForHistory' ,
 270                         'get_subpanel_data' => $relationshipName. '_notes' ) ,
 271                     'emails' => array (
 272                         'module' => 'Emails' ,
 273                         'subpanel_name' => 'ForHistory' ,
 274                         'get_subpanel_data' => $relationshipName. '_emails' ) ) )  ;
 275     }
 276 }
 277 ?>