Current File : //var/www/crm/modules/ModuleBuilder/parsers/relationships/OneToManyRelationship.php
<?php
if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
/*********************************************************************************
* SugarCRM Community Edition is a customer relationship management program developed by
* SugarCRM, Inc. Copyright (C) 2004-2012 SugarCRM Inc.
*
* This program is free software; you can redistribute it and/or modify it under
* the terms of the GNU Affero General Public License version 3 as published by the
* Free Software Foundation with the addition of the following permission added
* to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
* IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
* OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
* details.
*
* You should have received a copy of the GNU Affero General Public License along with
* this program; if not, see http://www.gnu.org/licenses or write to the Free
* Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
* 02110-1301 USA.
*
* You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
* SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
*
* The interactive user interfaces in modified source and object code versions
* of this program must display Appropriate Legal Notices, as required under
* Section 5 of the GNU Affero General Public License version 3.
*
* In accordance with Section 7(b) of the GNU Affero General Public License version 3,
* these Appropriate Legal Notices must retain the display of the "Powered by
* SugarCRM" logo. If the display of the logo is not reasonably feasible for
* technical reasons, the Appropriate Legal Notices must display the words
* "Powered by SugarCRM".
********************************************************************************/
require_once 'modules/ModuleBuilder/parsers/relationships/AbstractRelationship.php' ;
/*
* Class to manage the metadata for a One-To-Many Relationship
* The One-To-Many relationships created by this class are a combination of a subpanel and a custom relate field
* 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
* The RHS (Many) module will receive a new relate field to point back to the LHS
*
* OOB modules implement One-To-Many relationships as:
*
* On the LHS (One) side:
* A Relationship of type one-to-many in the rhs modules vardefs.php
* A link field in the same vardefs.php with 'relationship'= the relationship name and 'source'='non-db'
* A subpanel which gets its data (get_subpanel_data) from the link field
*
* On the RHS (Many) side:
* A Relate field in the vardefs, formatted as in this example, which references a link field:
* 'name' => 'account_name',
* 'rname' => 'name',
* 'id_name' => 'account_id',
* 'vname' => 'LBL_ACCOUNT_NAME',
* 'join_name'=>'accounts',
* 'type' => 'relate',
* 'link' => 'accounts',
* 'table' => 'accounts',
* 'module' => 'Accounts',
* 'source' => 'non-db'
* A link field which references the shared Relationship
*/
class OneToManyRelationship extends AbstractRelationship
{
/*
* Constructor
* @param array $definition Parameters passed in as array defined in parent::$definitionKeys
* The lhs_module value is for the One side; the rhs_module value is for the Many
*/
function __construct ($definition)
{
parent::__construct ( $definition ) ;
}
/*
* BUILD methods called during the build
*/
/*
* Construct subpanel definitions
* The format is that of TO_MODULE => relationship, FROM_MODULE, FROM_MODULES_SUBPANEL, mimicking the format in the layoutdefs.php
* @return array An array of subpanel definitions, keyed by the module
*/
function buildSubpanelDefinitions ()
{
if ($this->relationship_only)
return array () ;
$source = "";
if ($this->rhs_module == $this->lhs_module)
{
$source = $this->getJoinKeyLHS();
}
return array(
$this->lhs_module => $this->getSubpanelDefinition (
$this->relationship_name, $this->rhs_module, $this->rhs_subpanel , $this->getRightModuleSystemLabel() , $source
)
);
}
/*
* @return array An array of field definitions, ready for the vardefs, keyed by module
*/
function buildVardefs ( )
{
$vardefs = array ( ) ;
$vardefs [ $this->rhs_module ] [] = $this->getLinkFieldDefinition ( $this->lhs_module, $this->relationship_name, false,
'LBL_' . strtoupper ( $this->relationship_name . '_FROM_' . $this->getLeftModuleSystemLabel() ) . '_TITLE',
$this->relationship_only ? false : $this->getIDName( $this->lhs_module )
) ;
if ($this->rhs_module != $this->lhs_module )
{
$vardefs [ $this->lhs_module ] [] = $this->getLinkFieldDefinition ( $this->rhs_module, $this->relationship_name, true,
'LBL_' . strtoupper ( $this->relationship_name . '_FROM_' . $this->getRightModuleSystemLabel() ) . '_TITLE');
}
if (! $this->relationship_only)
{
$vardefs [ $this->rhs_module ] [] = $this->getRelateFieldDefinition ( $this->lhs_module, $this->relationship_name, $this->getLeftModuleSystemLabel() ) ;
$vardefs [ $this->rhs_module ] [] = $this->getLink2FieldDefinition ( $this->lhs_module, $this->relationship_name, true,
'LBL_' . strtoupper ( $this->relationship_name . '_FROM_' . $this->getRightModuleSystemLabel() ) . '_TITLE');
}
return $vardefs ;
}
/*
* Define what fields to add to which modules layouts
* @return array An array of module => fieldname
*/
function buildFieldsToLayouts ()
{
if ($this->relationship_only)
return array () ;
return array( $this->rhs_module =>$this->getValidDBName($this->relationship_name . "_name")); // this must match the name of the relate field from buildVardefs
}
/*
* @return array An array of relationship metadata definitions
*/
function buildRelationshipMetaData ()
{
return array( $this->lhs_module => $this->getRelationshipMetaData ( MB_ONETOMANY ) ) ;
}
}
?>
Mini Shell