modules/ModuleBuilder/parsers/relationships/ManyToManyRelationship.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 require_once 'modules/ModuleBuilder/parsers/relationships/AbstractRelationship.php' ;
  40
  41 /*
  42  * Class to manage the metadata for a Many-To-Many Relationship
  43  * The LHS (One) module will receive a new subpanel for the RHS module
  44  * The RHS (Many) module will receive a new subpanel for the RHS module
  45  * The subpanels get their data ('get_subpanel_data') from two link fields (one each) that reference a new Relationship
  46  *
  47  * In OOB modules it's done the same way (e.g. cases_bugs)
  48  */
  49
  50 class ManyToManyRelationship extends AbstractRelationship
  51 {
  52
  53     /*
  54      * Constructor
  55      * @param array $definition Parameters passed in as array with keys defined in parent::keys
  56      */
  57     function __construct ($definition)
  58     {
  59         parent::__construct ( $definition ) ;
  60     }
  61
  62     /*
  63      * BUILD methods called during the build
  64      */
  65
  66     /*
  67      * Construct subpanel definitions
  68      * The format is that of TO_MODULE => relationship, FROM_MODULE, FROM_MODULES_SUBPANEL, mimicking the format in the layoutdefs.php
  69      * @return array    An array of subpanel definitions, keyed by module
  70      */
  71     function buildSubpanelDefinitions ()
  72     {
  73         $subpanelDefinitions = array ( ) ;
  74         if (!$this->relationship_only)
  75         {
  76             $subpanelDefinitions [ $this->rhs_module ] = $this->getSubpanelDefinition ( $this->relationship_name, $this->lhs_module, $this->lhs_subpanel, $this->getLeftModuleSystemLabel() ) ;
  77             $subpanelDefinitions [ $this->lhs_module ] = $this->getSubpanelDefinition ( $this->relationship_name, $this->rhs_module, $this->rhs_subpanel, $this->getRightModuleSystemLabel() ) ;
  78         }
  79         return $subpanelDefinitions ;
  80     }
  81
  82
  83     /*
  84      * @return array    An array of field definitions, ready for the vardefs, keyed by module
  85      */
  86     function buildVardefs ( )
  87     {
  88         $vardefs = array ( ) ;
  89         $vardefs [ $this->rhs_module ] [] = $this->getLinkFieldDefinition ( $this->lhs_module, $this->relationship_name, false,
  90             'LBL_' . strtoupper ( $this->relationship_name . '_FROM_' . $this->getLeftModuleSystemLabel() ) . '_TITLE' ) ;
  91         $vardefs [ $this->lhs_module ] [] = $this->getLinkFieldDefinition ( $this->rhs_module, $this->relationship_name, false,
  92             'LBL_' . strtoupper ( $this->relationship_name . '_FROM_' . $this->getRightModuleSystemLabel()  ) . '_TITLE' ) ;
  93         return $vardefs ;
  94     }
  95
  96     /*
  97      * @return array    An array of relationship metadata definitions
  98      */
  99     function buildRelationshipMetaData ()
 100     {
 101         return array( $this->lhs_module => $this->getRelationshipMetaData ( MB_MANYTOMANY ) ) ;
 102     }
 103
 104
 105
 106
 107 }