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 ********************************************************************************/
40 /*********************************************************************************
42 * Description: Represents a relationship from a single bean's perspective.
43 * Does not actively do work but is used by sugarbean to manipulate relationships.
44 * Work is deferred to the relationship classes.
46 * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc.
47 * All Rights Reserved.
48 * Contributor(s): ______________________________________..
49 ********************************************************************************/
51 require_once("data/Relationships/RelationshipFactory.php");
54 * Represents a relationship from a single beans perspective.
59 protected $relationship; //relationship object this link is tied to.
60 protected $focus; //SugarBean this link uses as the context for its calls.
61 protected $def; //Field def for this link
62 protected $name; //Field name for this link
63 protected $beans; //beans on the other side of the link
64 protected $rows; //any additional fields on the relationship
65 protected $loaded; //true if this link has been loaded from the database
66 protected $relationship_fields = array();
67 //Used to store unsaved beans on this relationship that will be combined with the ones pulled from the DB if getBeans() is called.
68 protected $tempBeans = array();
71 * @param $linkName String name of a link field in the module's vardefs
72 * @param $bean SugarBean focus bean for this link (one half of a relationship)
73 * @param $linkDef Array Optional vardef for the link in case it can't be found in the passed in bean for the global dictionary
77 function __construct($linkName, $bean, $linkDef = false){
79 //Try to load the link vardef from the beans field defs. Otherwise start searching
80 if (empty($bean->field_defs) || empty($bean->field_defs[$linkName]) || empty($bean->field_defs[$linkName]['relationship']))
84 //Assume $linkName is really relationship_name, and find the link name with the vardef manager
85 $this->def = VardefManager::getLinkFieldForRelationship($bean->module_dir, $bean->object_name, $linkName);
88 $this->def = $linkDef;
90 //Check if multiple links were found for a given relationship
91 if (is_array($this->def) && !isset($this->def['name']))
93 //More than one link found, we need to figure out if we are currently on the LHS or RHS
94 //default to lhs for now
95 if (isset($this->def[0]['side']) && $this->def[0]['side'] == 'left')
97 $this->def = $this->def[0];
99 else if (isset($this->def[1]['side']) && $this->def[1]['side'] == 'left')
101 $this->def = $this->def[1];
104 $this->def = $this->def[0];
107 if (empty($this->def['name']))
109 $GLOBALS['log']->fatal("failed to find link for $linkName");
113 $this->name = $this->def['name'];
116 //Linkdef was found in the bean (this is the normal expectation)
117 $this->def = $bean->field_defs[$linkName];
118 $this->name = $linkName;
120 //Instantiate the relationship for this link.
121 $this->relationship = SugarRelationshipFactory::getInstance()->getRelationship($this->def['relationship']);
123 // Fix to restore functionality from Link.php that needs to be rewritten but for now this will do.
124 $this->relationship_fields = (!empty($this->def['rel_fields']))?$this->def['rel_fields']: array();
126 if (!$this->loadedSuccesfully())
128 $GLOBALS['log']->fatal("{$this->name} for {$this->def['relationship']} failed to load\n");
130 //Following behavior is tied to a property(ignore_role) value in the vardef. It alters the values of 2 properties, ignore_role_filter and add_distinct.
131 //the property values can be altered again before any requests are made.
132 if (!empty($this->def) && is_array($this->def)) {
133 if ( isset($this->def['ignore_role']) ) {
134 if ($this->def['ignore_role']) {
135 $this->ignore_role_filter=true;
136 $this->add_distinct=true;
143 * Returns false if no relationship was found for this link
146 public function loadedSuccesfully()
148 return !empty($this->relationship);
152 * Forces the link to load the relationship rows.
153 * Will be called internally when the $rows property is accessed or get() is called
156 public function load($params = array())
158 $data = $this->query($params);
159 $this->rows = $data['rows'];
161 $this->loaded = true;
165 * Perform a query on this relationship.
167 * @param array $params An array that can contain the following parameters:<br/>
168 * <ul><li><b>where:</b> An array with 3 key/value pairs.
169 * lhs_field: The name of the field to check search.
170 * operator: The operator to use in the search.
171 * rhs_value: The value to search for.<br/>
174 'lhs_field' => 'source',
176 'rhs_value' => 'external'
179 * <li><b>limit:</b> The maximum number of rows</li>
180 * <li><b>deleted:</b> If deleted is set to 1, only deleted records related to the current record will be returned.</li></ul>
182 public function query($params){
183 return $this->relationship->load($this, $params);
187 * @return array ids of records related through this link
189 public function get($role = false) {
193 return array_keys($this->rows);
199 * @return string name of table for the relationship of this link
201 public function getRelatedTableName() {
202 return BeanFactory::getBean($this->getRelatedModuleName())->table_name;
206 * @return string the name of the module on the other side of this link
208 public function getRelatedModuleName() {
209 if (!$this->relationship) return false;
211 if ($this->getSide() == REL_LHS) {
212 return $this->relationship->getRHSModule();
214 return $this->relationship->getLHSModule();
219 * @return string the name of the link field used on the other side of the rel
221 public function getRelatedModuleLinkName() {
222 if (!$this->relationship) return false;
224 if ($this->getSide() == REL_LHS) {
225 return $this->relationship->getRHSLink();
227 return $this->relationship->getLHSLink();
233 * @return string "many" if multiple records can be related through this link
234 * or "one" if at most, one record can be related.
236 public function getType()
238 switch ($this->relationship->type)
245 return $this->getSide() == REL_LHS ? "many" : "one";
251 * @return SugarBean The parent Bean this link references
253 public function getFocus()
260 * @return list of fields that exist only on the relationship
262 public function getRelatedFields(){
263 return $this->relationship_fields;
268 * @return The value for the relationship field $name
270 public function getRelatedField($name){
271 if (!empty($this->relationship_fields) && !empty($this->relationship_fields[$name]))
272 return $this->relationship_fields[$name];
274 return null; //For now return null. Later try the relationship object directly.
278 * @return SugarRelationship the relationship object this link references
280 public function getRelationshipObject() {
281 return $this->relationship;
285 * @return string "LHS" or "RHS" depending on the side of the relationship this link represents
287 public function getSide() {
288 //First try the relationship
289 if ($this->relationship->getLHSLink() == $this->name &&
290 ($this->relationship->getLHSModule() == $this->focus->module_name)
295 if ($this->relationship->getRHSLink() == $this->name &&
296 ($this->relationship->getRHSModule() == $this->focus->module_name)
301 //Next try the vardef
302 if (!empty($this->def['side']))
304 if ((strtolower($this->def['side']) == 'left' || $this->def['side'] == REL_LHS)
305 //Some relationships make have left in the vardef erroneously if generated by module builder
306 && $this->name != $this->relationship->def['join_key_lhs'])
314 //Next try using the id_name and relationship join keys
315 else if (!empty($this->def['id_name']))
317 if (isset($this->relationship->def['join_key_lhs']) && $this->def['id_name'] == $this->relationship->def['join_key_lhs'])
319 else if (isset($this->relationship->def['join_key_rhs']) && $this->def['id_name'] == $this->relationship->def['join_key_rhs'])
323 $GLOBALS['log']->error("Unable to get proper side for link {$this->name}");
327 * @return bool true if LHSModule == RHSModule
329 protected function is_self_relationship() {
330 return $this->relationship->isSelfReferencing();
334 * @return bool true if this link represents a relationship where the parent could be one of multiple modules. (ex. Activities parent)
336 public function isParentRelationship(){
337 return $this->relationship->isParentRelationship();
341 * @param $params array of parameters. Possible parameters include:
342 * 'join_table_link_alias': alias the relationship join table in the query (for M2M relationships),
343 * 'join_table_alias': alias for the final table to be joined against (usually a module main table)
344 * @param bool $return_array if true the query is returned as a array broken up into
345 * select, join, where, type, rel_key, and joined_tables
346 * @return string/array join query for this link
348 function getJoin($params, $return_array =false)
350 return $this->relationship->getJoin($this, $params, $return_array);
354 * @param array $params optional parameters. Possible Values;
355 * 'return_as_array': returns the query broken into
356 * @return String/Array query to grab just ids for this relationship
358 function getQuery($params = array())
360 return $this->relationship->getQuery($this, $params);
364 * This function is similair getJoin except for M2m relationships it won't join agaist the final table.
365 * Its used to retrieve the ID of the related beans only
366 * @param $params array of parameters. Possible parameters include:
367 * 'return_as_array': returns the query broken into
368 * @param bool $return_array same as passing 'return_as_array' into parameters
369 * @return string/array query to use when joining for subpanels
371 public function getSubpanelQuery($params = array(), $return_array = false)
373 if (!empty($this->def['ignore_role']))
374 $params['ignore_role'] = true;
375 return $this->relationship->getSubpanelQuery($this, $params, $return_array);
379 * Use with caution as if you have a large list of beans in the relationship,
380 * it can cause the app to timeout or run out of memory.
382 * @param array $params An array that can contain the following parameters:<br/>
383 * <ul><li><b>where:</b> An array with 3 key/value pairs.
384 * lhs_field: The name of the field to check search.
385 * operator: The operator to use in the search.
386 * rhs_value: The value to search for.<br/>
389 'lhs_field' => 'source',
391 'rhs_value' => 'external'
394 * <li><b>limit:</b> The maximum number of beans to load.</li>
395 * <li><b>deleted:</b> If deleted is set to 1, only deleted records related to the current record will be returned.</li></ul>
396 * @return array of SugarBeans related through this link.
398 function getBeans($params = array()) {
399 //Some depricated code attempts to pass in the old format to getBeans with a large number of useless paramters.
400 //reset the parameters if they are not in the new array format.
401 if (!is_array($params))
404 if (!$this->loaded && empty($params)) {
409 //If params is set, we are doing a query rather than a complete load of the relationship
410 if (!empty($params)) {
411 $data = $this->query($params);
412 $rows = $data['rows'];
416 if(!$this->beansAreLoaded() || !empty($params))
418 if (!is_array($this->beans))
419 $this->beans = array();
421 $rel_module = $this->getRelatedModuleName();
423 //First swap in the temp loaded beans, only if we are doing a complete load (no params)
424 if (empty($params)) {
425 $result = $this->tempBeans;
426 $this->tempBeans = array();
429 //now load from the rows
430 foreach ($rows as $id => $vals)
432 if (empty($this->beans[$id]))
434 $tmpBean = BeanFactory::getBean($rel_module, $id);
435 if($tmpBean !== FALSE)
436 $result[$id] = $tmpBean;
438 $result[$id] = $this->beans[$id];
442 //If we did a compelte load, cache the result in $this->beans
444 $this->beans = $result;
446 $result = $this->beans;
453 * @return bool true if this link has initialized its related beans.
455 public function beansAreLoaded() {
456 return is_array($this->beans);
460 * use this function to create link between 2 objects
461 * 1:1 will be treated like 1 to many.
463 * the function also allows for setting of values for additional field in the table being
464 * updated to save the relationship, in case of many-to-many relationships this would be the join table.
466 * @param array $rel_keys array of ids or SugarBean objects. If you have the bean in memory, pass it in.
467 * @param array $additional_values the values should be passed as key value pairs with column name as the key name and column value as key value.
471 function add($rel_keys,$additional_values=array()) {
472 if (!is_array($rel_keys))
473 $rel_keys = array($rel_keys);
475 foreach($rel_keys as $key)
477 //We must use beans for LogicHooks and other business logic to fire correctly
478 if (!($key instanceof SugarBean)) {
479 $key = $this->getRelatedBean($key);
480 if (!($key instanceof SugarBean)) {
481 $GLOBALS['log']->error("Unable to load related bean by id");
486 if(empty($key->id) || empty($this->focus->id))
489 if ($this->getSide() == REL_LHS) {
490 $this->relationship->add($this->focus, $key, $additional_values);
493 $this->relationship->add($key, $this->focus, $additional_values);
501 * Marks the relationship delted for this given record pair.
502 * @param $id id of the Parent/Focus SugarBean
503 * @param string $related_id id or SugarBean to unrelate. Pass a SugarBean if you have it.
506 function delete($id, $related_id='') {
507 if (empty($this->focus->id))
508 $this->focus = BeanFactory::getBean($this->focus->module_name, $id);
509 if (!empty($related_id))
511 if (!($related_id instanceof SugarBean)) {
512 $related_id = $this->getRelatedBean($related_id);
514 if ($this->getSide() == REL_LHS) {
515 $this->relationship->remove($this->focus, $related_id);
518 $this->relationship->remove($related_id, $this->focus);
523 $this->relationship->removeAll($this);
528 * Returns a SugarBean with the given ID from the related module.
529 * @param bool $id id of related record to retrieve
532 protected function getRelatedBean($id = false)
534 return BeanFactory::getBean($this->getRelatedModuleName(), $id);
537 public function &__get($name)
541 case "relationship_type":
542 return $this->relationship->type;
543 case "_relationship":
544 return $this->relationship;
546 if (!is_array($this->beans))
550 if (!is_array($this->rows))
557 public function __set($name, $val)
565 * Add a bean object to the list of beans currently loaded to this relationship.
566 * This for the most part should not need to be called except by the relatipnship implementation classes.
567 * @param SugarBean $bean
570 public function addBean($bean)
572 if (!is_array($this->beans))
574 $this->tempBeans[$bean->id] = $bean;
577 $this->beans[$bean->id] = $bean;
583 * Remove a bean object from the list of beans currently loaded to this relationship.
584 * This for the most part should not need to be called except by the relatipnship implementation classes.
586 * @param SugarBean $bean
589 public function removeBean($bean)
591 if (!is_array($this->beans) && isset($this->tempBeans[$bean->id]))
593 unset($this->tempBeans[$bean->id]);
595 unset($this->beans[$bean->id]);
596 unset($this->rows[$bean->id]);
602 * Directly queries the databse for set of values. The relationship classes and not link should handle this.
604 * @param $table_name string relationship table
605 * @param $join_key_values array of key=>values to identify this relationship by
606 * @return bool true if the given join key set exists in the relationship table
608 public function relationship_exists($table_name, $join_key_values) {
610 //find the key values for the table.
611 $dup_keys=$this->_get_alternate_key_fields($table_name);
612 if (empty($dup_keys)) {
613 $GLOBALS['log']->debug("No alternate key define, skipping duplicate check..");
618 $this->_duplicate_where=' WHERE ';
619 foreach ($dup_keys as $field) {
620 //look for key in $join_key_values, if found add to filter criteria else abort duplicate checking.
621 if (isset($join_key_values[$field])) {
623 $this->_duplicate_where .= $delimiter.' '.$field."='".$join_key_values[$field]."'";
626 $GLOBALS['log']->error('Duplicate checking aborted, Please supply a value for this column '.$field);
631 $this->_duplicate_where .= $delimiter.' deleted=0';
633 $query='SELECT id FROM '.$table_name.$this->_duplicate_where;
635 $GLOBALS['log']->debug("relationship_exists query(".$query.')');
637 $result=$this->_db->query($query, true);
638 $row = $this->_db->fetchByAssoc($result);
644 $this->_duplicate_key=$row['id'];
649 //Below are functions not used directly and exist for backwards compatibility with customizations, will be removed in a later version
651 /* returns array of keys for duplicate checking, first check for an index of type alternate_key, if not found searches for
655 public function _get_alternate_key_fields($table_name) {
656 $indices=Link::_get_link_table_definition($table_name,'indices');
657 if (!empty($indices)) {
658 foreach ($indices as $index) {
659 if ( isset($index['type']) && $index['type'] == 'alternate_key' ) {
660 return $index['fields'];
664 //bug 32623, when the relationship is built in old version, there is no alternate_key. we have to use join_key_lhs and join_key_lhs.
665 $relDef = $this->relationship->def;
666 if (!empty($relDef['join_key_lhs']) && !empty($relDef['join_key_rhs']))
667 return array($relDef['join_key_lhs'], $relDef['join_key_rhs']);
672 * Gets the vardef for the relationship of this link.
674 public function _get_link_table_definition($table_name, $def_name) {
676 if (isset($this->relationship->def[$def_name]))
677 return $this->relationship->def[$def_name];
684 * Return the name of the role field for the passed many to many table.
685 * if there is no role filed : return false
686 * @param $table_name name of relationship table to inspect
687 * @return bool|string
689 public function _get_link_table_role_field($table_name) {
690 $varDefs = $this->_get_link_table_definition($table_name, 'fields');
692 if(!empty($varDefs)){
694 foreach($varDefs as $v){
695 if(strpos($v['name'], '_role') !== false){
696 $role_field = $v['name'];
706 * @return boolean returns true if this link is LHS
708 public function _get_bean_position()
710 return $this->getSide() == REL_LHS;