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.
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.
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
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
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.
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.
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 ********************************************************************************/
39 require_once("data/Relationships/One2MRelationship.php");
42 * Represents a one to many relationship that is table based.
45 class One2MBeanRelationship extends One2MRelationship
47 //Type is read in sugarbean to determine query construction
48 var $type = "one-to-many";
50 public function __construct($def)
52 parent::__construct($def);
56 * @param $lhs SugarBean left side bean to add to the relationship.
57 * @param $rhs SugarBean right side bean to add to the relationship.
58 * @param $additionalFields key=>value pairs of fields to save on the relationship
59 * @return boolean true if successful
61 public function add($lhs, $rhs, $additionalFields = array())
63 $lhsLinkName = $this->lhsLink;
64 $rhsLinkName = $this->rhsLink;
66 //Since this is bean based, we know updating the RHS's field will overwrite any old value,
67 //But we need to use delete to make sure custom logic is called correctly
68 if ($rhs->load_relationship($rhsLinkName))
70 $oldLink = $rhs->$rhsLinkName;
71 $prevRelated = $oldLink->getBeans(null);
72 foreach($prevRelated as $oldLHS)
74 $this->remove($oldLHS, $rhs, false);
78 //Make sure we load the current relationship state to the LHS link
79 if ((isset($lhs->$lhsLinkName) && is_a($lhs->$lhsLinkName, "Link2")) || $lhs->load_relationship($lhsLinkName)) {
80 $lhs->$lhsLinkName->load();
83 $this->updateFields($lhs, $rhs, $additionalFields);
86 if (empty($_SESSION['disable_workflow']) || $_SESSION['disable_workflow'] != "Yes")
88 //Need to call save to update the bean as the relationship is saved on the main table
89 //We don't want to create a save loop though, so make sure we aren't already in the middle of saving this bean
90 SugarRelationship::addToResaveList($rhs);
92 $this->updateLinks($lhs, $lhsLinkName, $rhs, $rhsLinkName);
94 $this->callAfterAdd($lhs, $rhs);
95 $this->callAfterAdd($rhs, $lhs);
99 protected function updateLinks($lhs, $lhsLinkName, $rhs, $rhsLinkName)
101 if (isset($lhs->$lhsLinkName))
102 $lhs->$lhsLinkName->addBean($rhs);
103 //RHS only has one bean ever, so we don't need to preload the relationship
104 if (isset($rhs->$rhsLinkName))
105 $rhs->$rhsLinkName->beans = array($lhs->id => $lhs);
108 protected function updateFields($lhs, $rhs, $additionalFields)
110 //Now update the RHS bean's ID field
111 $rhsID = $this->def['rhs_key'];
112 $rhs->$rhsID = $lhs->id;
113 foreach($additionalFields as $field => $val)
118 if(!empty($this->def["relationship_role_column"]) && !empty($this->def["relationship_role_column_value"]))
120 $roleField = $this->def["relationship_role_column"];
121 $rhs->$roleField = $this->def["relationship_role_column_value"];
125 public function remove($lhs, $rhs, $save = true)
127 $rhsID = $this->def['rhs_key'];
129 //If this relationship has already been removed, we can just return
130 if ($rhs->$rhsID != $lhs->id)
135 if ($save && !$rhs->deleted)
137 $rhs->in_relationship_update = TRUE;
141 if (empty($_SESSION['disable_workflow']) || $_SESSION['disable_workflow'] != "Yes")
143 $this->callAfterDelete($lhs, $rhs);
144 $this->callAfterDelete($rhs, $lhs);
149 * @param $link Link2 loads the relationship for this link.
152 public function load($link)
154 $relatedModule = $link->getSide() == REL_LHS ? $this->def['rhs_module'] : $this->def['lhs_module'];
156 //The related bean ID is stored on the RHS table.
157 //If the link is RHS, just grab it from the focus.
158 if ($link->getSide() == REL_RHS)
160 $rhsID = $this->def['rhs_key'];
161 $id = $link->getFocus()->$rhsID;
164 $rows[$id] = array('id' => $id);
167 else //If the link is LHS, we need to query to get the full list and load all the beans.
169 $db = DBManagerFactory::getInstance();
170 $query = $this->getQuery($link);
173 echo ("query for {$this->name} was empty when loading from {$this->lhsLink}\n");
175 $result = $db->query($query);
176 while ($row = $db->fetchByAssoc($result))
183 return array("rows" => $rows);
186 public function getQuery($link, $return_as_array = false)
189 if ($link->getSide() == REL_RHS) {
194 $lhsKey = $this->def['lhs_key'];
195 $rhsTable = $this->def['rhs_table'];
196 $rhsTableKey = "{$rhsTable}.{$this->def['rhs_key']}";
197 $where = "WHERE $rhsTableKey = '{$link->getFocus()->$lhsKey}' AND {$rhsTable}.deleted=0";
198 //Check for role column
199 if(!empty($this->def["relationship_role_column"]) && !empty($this->def["relationship_role_column_value"]))
201 $roleField = $this->def["relationship_role_column"];
202 $roleValue = $this->def["relationship_role_column_value"];
203 $where .= " AND $rhsTable.$roleField = '$roleValue'";
205 if (!$return_as_array) {
206 return "SELECT id FROM {$this->def['rhs_table']} $where";
211 'select' => "SELECT {$this->def['rhs_table']}.id",
212 'from' => "FROM {$this->def['rhs_table']}",
219 public function getJoin($link, $params = array(), $return_array = false)
221 $linkIsLHS = $link->getSide() == REL_LHS;
222 $startingTable = (empty($params['left_join_table_alias']) ? $this->def['lhs_table'] : $params['left_join_table_alias']);
224 $startingTable = (empty($params['right_join_table_alias']) ? $this->def['rhs_table'] : $params['right_join_table_alias']);
225 $startingKey = $linkIsLHS ? $this->def['lhs_key'] : $this->def['rhs_key'];
226 $targetTable = $linkIsLHS ? $this->def['rhs_table'] : $this->def['lhs_table'];
227 $targetTableWithAlias = $targetTable;
228 $targetKey = $linkIsLHS ? $this->def['rhs_key'] : $this->def['lhs_key'];
229 $join_type= isset($params['join_type']) ? $params['join_type'] : ' INNER JOIN ';
232 //Set up any table aliases required
233 if ( ! empty($params['join_table_alias']))
235 $targetTableWithAlias = $targetTable. " ".$params['join_table_alias'];
236 $targetTable = $params['join_table_alias'];
239 //First join the relationship table
240 $join .= "$join_type $targetTableWithAlias ON $startingTable.$startingKey=$targetTable.$targetKey AND $targetTable.deleted=0\n"
241 //Next add any role filters
242 . $this->getRoleWhere(($linkIsLHS) ? $targetTable : $startingTable) . "\n";
247 'type' => $this->type,
248 'rel_key' => $targetKey,
249 'join_tables' => array($targetTable),
251 'select' => "$targetTable.id",
257 public function getSubpanelQuery($link, $params = array(), $return_array = false)
260 $linkIsLHS = $link->getSide() == REL_RHS;
261 $startingTable = (empty($params['left_join_table_alias']) ? $this->def['lhs_table'] : $params['left_join_table_alias']);
263 $startingTable = (empty($params['right_join_table_alias']) ? $this->def['rhs_table'] : $params['right_join_table_alias']);
264 $startingKey = $linkIsLHS ? $this->def['lhs_key'] : $this->def['rhs_key'];
265 $targetTable = $linkIsLHS ? $this->def['rhs_table'] : $this->def['lhs_table'];
266 $targetKey = $linkIsLHS ? $this->def['rhs_key'] : $this->def['lhs_key'];
267 $join_type= isset($params['join_type']) ? $params['join_type'] : ' INNER JOIN ';
270 $alias = empty($params['join_table_alias']) ? "{$link->name}_rel": $params['join_table_alias'];
271 $alias = $GLOBALS['db']->getValidDBName($alias, false, 'alias');
273 //Set up any table aliases required
274 $targetTableWithAlias = "$targetTable $alias";
275 $targetTable = $alias;
277 $query .= "$join_type $targetTableWithAlias ON $startingTable.$startingKey=$targetTable.$targetKey AND $targetTable.deleted=0\n"
278 //Next add any role filters
279 . $this->getRoleWhere() . "\n";
284 'type' => $this->type,
285 'rel_key' => $targetKey,
286 'join_tables' => array($targetTable),
287 'where' => "WHERE $startingTable.$startingKey='{$link->focus->id}'",
300 public function relationship_exists($lhs, $rhs)
306 public function getRelationshipTable()
308 if (isset($this->def['table']))
309 return $this->def['table'];
311 return $this->def['rhs_table'];