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.
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 // test to see if the relationship exist if the relationship between the two beans
64 // exist then we just fail out with false as we don't want to re-trigger this
65 // the save and such as it causes problems with the related() in sugarlogic
66 if($this->relationship_exists($lhs, $rhs)) return false;
68 $lhsLinkName = $this->lhsLink;
69 $rhsLinkName = $this->rhsLink;
71 //Since this is bean based, we know updating the RHS's field will overwrite any old value,
72 //But we need to use delete to make sure custom logic is called correctly
73 if ($rhs->load_relationship($rhsLinkName))
75 $oldLink = $rhs->$rhsLinkName;
76 $prevRelated = $oldLink->getBeans(null);
77 foreach($prevRelated as $oldLHS)
79 $this->remove($oldLHS, $rhs, false);
83 //Make sure we load the current relationship state to the LHS link
84 if ((isset($lhs->$lhsLinkName) && is_a($lhs->$lhsLinkName, "Link2")) || $lhs->load_relationship($lhsLinkName)) {
85 $lhs->$lhsLinkName->load();
88 $this->updateFields($lhs, $rhs, $additionalFields);
91 if (empty($_SESSION['disable_workflow']) || $_SESSION['disable_workflow'] != "Yes")
93 //Need to call save to update the bean as the relationship is saved on the main table
94 //We don't want to create a save loop though, so make sure we aren't already in the middle of saving this bean
95 SugarRelationship::addToResaveList($rhs);
97 $this->updateLinks($lhs, $lhsLinkName, $rhs, $rhsLinkName);
99 $this->callAfterAdd($lhs, $rhs);
100 $this->callAfterAdd($rhs, $lhs);
104 protected function updateLinks($lhs, $lhsLinkName, $rhs, $rhsLinkName)
106 if (isset($lhs->$lhsLinkName))
107 $lhs->$lhsLinkName->addBean($rhs);
108 //RHS only has one bean ever, so we don't need to preload the relationship
109 if (isset($rhs->$rhsLinkName))
110 $rhs->$rhsLinkName->beans = array($lhs->id => $lhs);
113 protected function updateFields($lhs, $rhs, $additionalFields)
115 //Now update the RHS bean's ID field
116 $rhsID = $this->def['rhs_key'];
117 $rhs->$rhsID = $lhs->id;
118 foreach($additionalFields as $field => $val)
123 if(!empty($this->def["relationship_role_column"]) && !empty($this->def["relationship_role_column_value"]))
125 $roleField = $this->def["relationship_role_column"];
126 $rhs->$roleField = $this->def["relationship_role_column_value"];
130 public function remove($lhs, $rhs, $save = true)
132 $rhsID = $this->def['rhs_key'];
134 //If this relationship has already been removed, we can just return
135 if ($rhs->$rhsID != $lhs->id)
140 if ($save && !$rhs->deleted)
142 $rhs->in_relationship_update = TRUE;
146 if (empty($_SESSION['disable_workflow']) || $_SESSION['disable_workflow'] != "Yes")
148 $this->callAfterDelete($lhs, $rhs);
149 $this->callAfterDelete($rhs, $lhs);
154 * @param $link Link2 loads the relationship for this link.
157 public function load($link, $params = array())
159 $relatedModule = $link->getSide() == REL_LHS ? $this->def['rhs_module'] : $this->def['lhs_module'];
161 //The related bean ID is stored on the RHS table.
162 //If the link is RHS, just grab it from the focus.
163 if ($link->getSide() == REL_RHS)
165 $rhsID = $this->def['rhs_key'];
166 $id = $link->getFocus()->$rhsID;
169 $rows[$id] = array('id' => $id);
172 else //If the link is LHS, we need to query to get the full list and load all the beans.
174 $db = DBManagerFactory::getInstance();
175 $query = $this->getQuery($link, $params);
178 $GLOBALS['log']->fatal("query for {$this->name} was empty when loading from {$this->lhsLink}\n");
179 return array("rows" => array());
181 $result = $db->query($query);
182 while ($row = $db->fetchByAssoc($result, FALSE))
189 return array("rows" => $rows);
192 public function getQuery($link, $params = array())
194 //There was an old signature with $return_as_array as the second parameter. We should respect this if $params is true
195 if ($params === true){
196 $params = array("return_as_array" => true);
199 if ($link->getSide() == REL_RHS) {
204 $lhsKey = $this->def['lhs_key'];
205 $rhsTable = $this->def['rhs_table'];
206 $rhsTableKey = "{$rhsTable}.{$this->def['rhs_key']}";
207 $deleted = !empty($params['deleted']) ? 1 : 0;
208 $where = "WHERE $rhsTableKey = '{$link->getFocus()->$lhsKey}' AND {$rhsTable}.deleted=$deleted";
210 //Check for role column
211 if(!empty($this->def["relationship_role_column"]) && !empty($this->def["relationship_role_column_value"]))
213 $roleField = $this->def["relationship_role_column"];
214 $roleValue = $this->def["relationship_role_column_value"];
215 $where .= " AND $rhsTable.$roleField = '$roleValue'";
218 //Add any optional where clause
219 if (!empty($params['where'])){
220 $add_where = is_string($params['where']) ? $params['where'] : "$rhsTable." . $this->getOptionalWhereClause($params['where']);
221 if (!empty($add_where))
222 $where .= " AND $add_where";
225 $from = $this->def['rhs_table'];
227 if (empty($params['return_as_array'])) {
228 //Limit is not compatible with return_as_array
229 $query = "SELECT id FROM $from $where";
230 if (!empty($params['limit']) && $params['limit'] > 0) {
231 $offset = isset($params['offset']) ? $params['offset'] : 0;
232 $query = DBManagerFactory::getInstance()->limitQuery($query, $offset, $params['limit'], false, "", false);
239 'select' => "SELECT {$this->def['rhs_table']}.id",
240 'from' => "FROM {$this->def['rhs_table']}",
247 public function getJoin($link, $params = array(), $return_array = false)
249 $linkIsLHS = $link->getSide() == REL_LHS;
250 $startingTable = (empty($params['left_join_table_alias']) ? $this->def['lhs_table'] : $params['left_join_table_alias']);
252 $startingTable = (empty($params['right_join_table_alias']) ? $this->def['rhs_table'] : $params['right_join_table_alias']);
253 $startingKey = $linkIsLHS ? $this->def['lhs_key'] : $this->def['rhs_key'];
254 $targetTable = $linkIsLHS ? $this->def['rhs_table'] : $this->def['lhs_table'];
255 $targetTableWithAlias = $targetTable;
256 $targetKey = $linkIsLHS ? $this->def['rhs_key'] : $this->def['lhs_key'];
257 $join_type= isset($params['join_type']) ? $params['join_type'] : ' INNER JOIN ';
260 //Set up any table aliases required
261 if ( ! empty($params['join_table_alias']))
263 $targetTableWithAlias = $targetTable. " ".$params['join_table_alias'];
264 $targetTable = $params['join_table_alias'];
267 //First join the relationship table
268 $join .= "$join_type $targetTableWithAlias ON $startingTable.$startingKey=$targetTable.$targetKey AND $targetTable.deleted=0\n"
269 //Next add any role filters
270 . $this->getRoleWhere(($linkIsLHS) ? $targetTable : $startingTable) . "\n";
275 'type' => $this->type,
276 'rel_key' => $targetKey,
277 'join_tables' => array($targetTable),
279 'select' => "$targetTable.id",
285 public function getSubpanelQuery($link, $params = array(), $return_array = false)
288 $linkIsLHS = $link->getSide() == REL_RHS;
289 $startingTable = (empty($params['left_join_table_alias']) ? $this->def['lhs_table'] : $params['left_join_table_alias']);
291 $startingTable = (empty($params['right_join_table_alias']) ? $this->def['rhs_table'] : $params['right_join_table_alias']);
292 $startingKey = $linkIsLHS ? $this->def['lhs_key'] : $this->def['rhs_key'];
293 $targetTable = $linkIsLHS ? $this->def['rhs_table'] : $this->def['lhs_table'];
294 $targetKey = $linkIsLHS ? $this->def['rhs_key'] : $this->def['lhs_key'];
295 $join_type= isset($params['join_type']) ? $params['join_type'] : ' INNER JOIN ';
298 $alias = empty($params['join_table_alias']) ? "{$link->name}_rel": $params['join_table_alias'];
299 $alias = $GLOBALS['db']->getValidDBName($alias, false, 'alias');
301 //Set up any table aliases required
302 $targetTableWithAlias = "$targetTable $alias";
303 $targetTable = $alias;
305 $query .= "$join_type $targetTableWithAlias ON $startingTable.$startingKey=$targetTable.$targetKey AND $targetTable.deleted=0\n"
306 //Next add any role filters
307 . $this->getRoleWhere() . "\n";
312 'type' => $this->type,
313 'rel_key' => $targetKey,
314 'join_tables' => array($targetTable),
315 'where' => "WHERE $startingTable.$startingKey='{$link->focus->id}'",
324 * Check to see if the relationship already exist.
326 * If it does return true otherwise return false
328 * @param SugarBean $lhs Left hand side of the relationship
329 * @param SugarBean $rhs Right hand side of the relationship
332 public function relationship_exists($lhs, $rhs)
334 // we need the key that is stored on the rhs to compare tok
335 $lhsIDName = $this->def['rhs_key'];
337 return (isset($rhs->fetched_row[$lhsIDName]) && $rhs->$lhsIDName == $rhs->fetched_row[$lhsIDName] && $rhs->$lhsIDName == $lhs->id);
340 public function getRelationshipTable()
342 if (isset($this->def['table']))
343 return $this->def['table'];
345 return $this->def['rhs_table'];