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.
44 class One2MBeanRelationship extends One2MRelationship
46 //Type is read in sugarbean to determine query construction
47 var $type = "one-to-many";
49 public function __construct($def)
51 parent::__construct($def);
55 * @param $lhs SugarBean left side bean to add to the relationship.
56 * @param $rhs SugarBean right side bean to add to the relationship.
57 * @param $additionalFields key=>value pairs of fields to save on the relationship
58 * @return boolean true if successful
60 public function add($lhs, $rhs, $additionalFields = array())
62 $lhsLinkName = $this->lhsLink;
63 $rhsLinkName = $this->rhsLink;
65 //Since this is bean based, we know updating the RHS's field will overwrite any old value,
66 //But we need to use delete to make sure custom logic is called correctly
67 if ($rhs->load_relationship($rhsLinkName))
69 $oldLink = $rhs->$rhsLinkName;
70 $prevRelated = $oldLink->getBeans(null);
71 foreach($prevRelated as $oldLHS)
73 $this->remove($oldLHS, $rhs, false);
77 //Make sure we load the current relationship state to the LHS link
78 if ((isset($lhs->$lhsLinkName) && is_a($lhs->$lhsLinkName, "Link2")) || $lhs->load_relationship($lhsLinkName)) {
79 $lhs->$lhsLinkName->getBeans();
82 $this->updateFields($lhs, $rhs, $additionalFields);
85 if (empty($_SESSION['disable_workflow']) || $_SESSION['disable_workflow'] != "Yes")
87 //Need to call save to update the bean as the relationship is saved on the main table
88 //We don't want to create a save loop though, so make sure we aren't already in the middle of saving this bean
89 SugarRelationship::addToResaveList($rhs);
91 $this->updateLinks($lhs, $lhsLinkName, $rhs, $rhsLinkName);
93 $this->callAfterAdd($lhs, $rhs);
94 $this->callAfterAdd($rhs, $lhs);
98 protected function updateLinks($lhs, $lhsLinkName, $rhs, $rhsLinkName)
100 if (isset($lhs->$lhsLinkName))
101 $lhs->$lhsLinkName->addBean($rhs);
102 //RHS only has one bean ever, so we don't need to preload the relationship
103 if (isset($rhs->$rhsLinkName))
104 $rhs->$rhsLinkName->beans = array($lhs->id => $lhs);
107 protected function updateFields($lhs, $rhs, $additionalFields)
109 //Now update the RHS bean's ID field
110 $rhsID = $this->def['rhs_key'];
111 $rhs->$rhsID = $lhs->id;
112 foreach($additionalFields as $field => $val)
117 if(!empty($this->def["relationship_role_column"]) && !empty($this->def["relationship_role_column_value"]))
119 $roleField = $this->def["relationship_role_column"];
120 $rhs->$roleField = $this->def["relationship_role_column_value"];
124 public function remove($lhs, $rhs, $save = true)
126 $rhsID = $this->def['rhs_key'];
128 //If this relationship has already been removed, we can just return
129 if ($rhs->$rhsID != $lhs->id)
134 if ($save && !$rhs->deleted)
136 $rhs->in_relationship_update = TRUE;
140 if (empty($_SESSION['disable_workflow']) || $_SESSION['disable_workflow'] != "Yes")
142 $this->callAfterDelete($lhs, $rhs);
143 $this->callAfterDelete($rhs, $lhs);
148 * @param $link Link2 loads the relationship for this link.
151 public function load($link)
153 $relatedModule = $link->getSide() == REL_LHS ? $this->def['rhs_module'] : $this->def['lhs_module'];
155 //The related bean ID is stored on the RHS table.
156 //If the link is RHS, just grab it from the focus.
157 if ($link->getSide() == REL_RHS)
159 $rhsID = $this->def['rhs_key'];
160 $id = $link->getFocus()->$rhsID;
163 $rows[$id] = array('id' => $id);
166 else //If the link is LHS, we need to query to get the full list and load all the beans.
168 $db = DBManagerFactory::getInstance();
169 $query = $this->getQuery($link);
172 echo ("query for {$this->name} was empty when loading from {$this->lhsLink}\n");
174 $result = $db->query($query);
175 while ($row = $db->fetchByAssoc($result))
182 return array("rows" => $rows);
185 public function getQuery($link, $return_as_array = false)
188 if ($link->getSide() == REL_RHS) {
193 $lhsKey = $this->def['lhs_key'];
194 $rhsTable = $this->def['rhs_table'];
195 $rhsTableKey = "{$rhsTable}.{$this->def['rhs_key']}";
196 $where = "WHERE $rhsTableKey = '{$link->getFocus()->$lhsKey}' AND {$rhsTable}.deleted=0";
197 //Check for role column
198 if(!empty($this->def["relationship_role_column"]) && !empty($this->def["relationship_role_column_value"]))
200 $roleField = $this->def["relationship_role_column"];
201 $roleValue = $this->def["relationship_role_column_value"];
202 $where .= " AND $rhsTable.$roleField = '$roleValue'";
204 if (!$return_as_array) {
205 return "SELECT id FROM {$this->def['rhs_table']} $where";
210 'select' => "SELECT id",
211 'from' => "FROM {$this->def['rhs_table']}",
218 public function getJoin($link, $params = array(), $return_array = false)
220 $linkIsLHS = $link->getSide() == REL_LHS;
221 $startingTable = (empty($params['left_join_table_alias']) ? $this->def['lhs_table'] : $params['left_join_table_alias']);
223 $startingTable = (empty($params['right_join_table_alias']) ? $this->def['rhs_table'] : $params['right_join_table_alias']);
224 $startingKey = $linkIsLHS ? $this->def['lhs_key'] : $this->def['rhs_key'];
225 $targetTable = $linkIsLHS ? $this->def['rhs_table'] : $this->def['lhs_table'];
226 $targetTableWithAlias = $targetTable;
227 $targetKey = $linkIsLHS ? $this->def['rhs_key'] : $this->def['lhs_key'];
228 $join_type= isset($params['join_type']) ? $params['join_type'] : ' INNER JOIN ';
231 //Set up any table aliases required
232 if ( ! empty($params['join_table_alias']))
234 $targetTableWithAlias = $targetTable. " ".$params['join_table_alias'];
235 $targetTable = $params['join_table_alias'];
238 //First join the relationship table
239 $join .= "$join_type $targetTableWithAlias ON $startingTable.$startingKey=$targetTable.$targetKey AND $targetTable.deleted=0\n"
240 //Next add any role filters
241 . $this->getRoleWhere(($linkIsLHS) ? $targetTable : $startingTable) . "\n";
246 'type' => $this->type,
247 'rel_key' => $targetKey,
248 'join_tables' => array($targetTable),
250 'select' => "$targetTable.id",
256 public function getSubpanelQuery($link, $params = array(), $return_array = false)
259 $linkIsLHS = $link->getSide() == REL_RHS;
260 $startingTable = (empty($params['left_join_table_alias']) ? $this->def['lhs_table'] : $params['left_join_table_alias']);
262 $startingTable = (empty($params['right_join_table_alias']) ? $this->def['rhs_table'] : $params['right_join_table_alias']);
263 $startingKey = $linkIsLHS ? $this->def['lhs_key'] : $this->def['rhs_key'];
264 $targetTable = $linkIsLHS ? $this->def['rhs_table'] : $this->def['lhs_table'];
265 $targetKey = $linkIsLHS ? $this->def['rhs_key'] : $this->def['lhs_key'];
266 $join_type= isset($params['join_type']) ? $params['join_type'] : ' INNER JOIN ';
269 $alias = empty($params['join_table_alias']) ? "{$link->name}_rel": $params['join_table_alias'];
270 //Set up any table aliases required
271 $targetTableWithAlias = "$targetTable $alias";
272 $targetTable = $alias;
274 $query .= "$join_type $targetTableWithAlias ON $startingTable.$startingKey=$targetTable.$targetKey AND $targetTable.deleted=0\n"
275 //Next add any role filters
276 . $this->getRoleWhere() . "\n";
281 'type' => $this->type,
282 'rel_key' => $targetKey,
283 'join_tables' => array($targetTable),
284 'where' => "WHERE $startingTable.$startingKey='{$link->focus->id}'",
297 public function relationship_exists($lhs, $rhs)
303 public function getRelationshipTable()
305 if (isset($this->def['table']))
306 return $this->def['table'];
308 return $this->def['rhs_table'];