0
0
mirror of https://github.com/salesagility/SuiteCRM.git synced 2024-12-22 04:18:33 +00:00
salesagility_SuiteCRM/data/Link2.php

734 lines
26 KiB
PHP
Executable File

<?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-2013 SugarCRM Inc.
*
* SuiteCRM is an extension to SugarCRM Community Edition developed by SalesAgility Ltd.
* Copyright (C) 2011 - 2018 SalesAgility Ltd.
*
* 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 and "Supercharged by SuiteCRM" logo. If the display of the logos is not
* reasonably feasible for technical reasons, the Appropriate Legal Notices must
* display the words "Powered by SugarCRM" and "Supercharged by SuiteCRM".
*/
/*********************************************************************************
* Description: Represents a relationship from a single bean's perspective.
* Does not actively do work but is used by SugarBean to manipulate relationships.
* Work is deferred to the relationship classes.
*
* Portions created by SugarCRM are Copyright (C) SugarCRM, Inc.
* All Rights Reserved.
* Contributor(s): ______________________________________..
********************************************************************************/
require_once 'data/Relationships/RelationshipFactory.php';
/**
* Represents a relationship from a single beans perspective.
*
* @api
*/
class Link2
{
/**
* @var SugarRelationship
*/
protected $relationship; //relationship object this link is tied to.
protected $focus; //SugarBean this link uses as the context for its calls.
protected $def; //Field def for this link
protected $name; //Field name for this link
protected $beans; //beans on the other side of the link
protected $rows; //any additional fields on the relationship
protected $loaded; //true if this link has been loaded from the database
protected $relationship_fields = array();
//Used to store unsaved beans on this relationship that will be combined with the ones pulled from the DB
// if getBeans() is called.
protected $tempBeans = array();
/**
* @param string $linkName name of a link field in the module's vardefs
* @param SugarBean $bean focus bean for this link (one half of a relationship)
* @param array $linkDef Optional vardef for the link in case it can't be found in the passed in bean
* for the global dictionary
*/
public function __construct($linkName, $bean, $linkDef = array())
{
$this->focus = $bean;
//Try to load the link vardef from the beans field defs. Otherwise start searching
if (empty($bean->field_defs) || empty($bean->field_defs[$linkName])
|| empty($bean->field_defs[$linkName]['relationship'])) {
if (empty($linkDef)) {
//Assume $linkName is really relationship_name, and find the link name with the vardef manager
$this->def = VardefManager::getLinkFieldForRelationship(
$bean->module_dir,
$bean->object_name,
$linkName
);
} else {
$this->def = $linkDef;
}
//Check if multiple links were found for a given relationship
if (is_array($this->def) && !isset($this->def['name'])) {
//More than one link found, we need to figure out if we are currently on the LHS or RHS
//default to lhs for now
if (isset($this->def[0]['side']) && $this->def[0]['side'] == 'left') {
$this->def = $this->def[0];
} elseif (isset($this->def[1]['side']) && $this->def[1]['side'] == 'left') {
$this->def = $this->def[1];
} elseif (isset($this->def[0])) {
$this->def = $this->def[0];
} else {
$GLOBALS['log']->fatal('Link definition not found for: ' . $linkName);
}
}
if (empty($this->def['name'])) {
$GLOBALS['log']->fatal("failed to find link for $linkName");
return;
}
$this->name = $this->def['name'];
} else {
//Linkdef was found in the bean (this is the normal expectation)
$this->def = $bean->field_defs[$linkName];
$this->name = $linkName;
}
//Instantiate the relationship for this link.
$this->relationship = SugarRelationshipFactory::getInstance()->getRelationship($this->def['relationship']);
// Fix to restore functionality from Link.php that needs to be rewritten but for now this will do.
$this->relationship_fields = (!empty($this->def['rel_fields'])) ? $this->def['rel_fields'] : array();
if (!$this->loadedSuccesfully()) {
$logFunction = 'fatal';
if (!isset($this->def['source']) || $this->def['source'] === 'non-db') {
$logFunction = 'warn';
}
$GLOBALS['log']->$logFunction("{$this->name} for {$this->def['relationship']} failed to load\n");
}
//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.
//the property values can be altered again before any requests are made.
if (!empty($this->def) && is_array($this->def)) {
if (isset($this->def['ignore_role'])) {
if ($this->def['ignore_role']) {
$this->ignore_role_filter = true;
$this->add_distinct = true;
}
}
}
}
/**
* Returns false if no relationship was found for this link.
*
* @return bool
*/
public function loadedSuccesfully()
{
return !empty($this->relationship);
}
/**
* @param array $params
*/
public function load($params = array())
{
$data = $this->query($params);
$this->rows = $data['rows'];
$this->beans = null;
$this->loaded = true;
}
/**
* Perform a query on this relationship.
*
* @param array $params An array that can contain the following parameters:
* where: An array with 3 key/value pairs.
* lhs_field: The name of the field to check search.
* operator: The operator to use in the search.
* rhs_value: The value to search for.
* limit: The maximum number of rows
* deleted: If deleted is set to 1, only deleted records related
* to the current record will be returned.
* Example:
* 'where' => array(
* 'lhs_field' => 'source',
* 'operator' => '=',
* 'rhs_value' => 'external'
* )
*/
public function query($params)
{
if (is_object($this->relationship) && method_exists($this->relationship, 'load')) {
return $this->relationship->load($this, $params);
} else {
$GLOBALS['log']->fatal('load() function is not implemented in a relationship');
return null;
}
}
/**
* @param array $params
* @return array ids of records related through this link
*/
public function get($params = array())
{
if (!$this->loaded) {
$this->load($params);
}
return array_keys($this->rows);
}
/**
* @return string the name of the module on the other side of this link
*/
public function getRelatedModuleName()
{
if (!$this->relationship) {
return false;
}
if ($this->getSide() == REL_LHS) {
return $this->relationship->getRHSModule();
} else {
return $this->relationship->getLHSModule();
}
}
/**
* @return string the name of the link field used on the other side of the rel
*/
public function getRelatedModuleLinkName()
{
if (!$this->relationship) {
return false;
}
if ($this->getSide() == REL_LHS) {
return $this->relationship->getRHSLink();
} else {
return $this->relationship->getLHSLink();
}
}
/**
* @return string "many" if multiple records can be related through this link
* or "one" if at most, one record can be related.
*/
public function getType()
{
switch ($this->relationship->type) {
case REL_MANY_MANY:
return 'many';
case REL_ONE_ONE:
return 'one';
case REL_ONE_MANY:
return $this->getSide() == REL_LHS ? 'many' : 'one';
}
return 'many';
}
/**
* @return SugarBean The parent Bean this link references
*/
public function getFocus()
{
return $this->focus;
}
/**
* @return Array of related fields
*/
public function getRelatedFields()
{
return $this->relationship_fields;
}
/**
* @param $name
*
* @return string The value for the relationship field $name
*/
public function getRelatedField($name)
{
if (!empty($this->relationship_fields) && !empty($this->relationship_fields[$name])) {
return $this->relationship_fields[$name];
} else {
return null;
} //For now return null. Later try the relationship object directly.
}
/**
* @return SugarRelationship the relationship object this link references
*/
public function getRelationshipObject()
{
return $this->relationship;
}
/**
* @return string "LHS" or "RHS" depending on the side of the relationship this link represents
*/
public function getSide()
{
//First try the relationship
$focusModuleName = null;
if (isset($this->focus->module_name)) {
$focusModuleName = $this->focus->module_name;
} else {
LoggerManager::getLogger()->error('Focus Module Name is not set for Link2 get side.');
}
if ($this->relationship->getLHSLink() == $this->name &&
($this->relationship->getLHSModule() == (isset($this->focus->module_name) ? $this->focus->module_name : null))
) {
return REL_LHS;
}
$rhsLink = $this->relationship->getRHSLink();
$rhsModule = $this->relationship->getRHSModule();
if (!isset($this->focus)) {
LoggerManager::getLogger()->warn('No focus of Link2 when trying to get side.');
$focusModuleName = null;
} elseif (!isset($this->focus->module_name)) {
LoggerManager::getLogger()->warn('No module name degined in focus of Link2 when trying to get side.');
$focusModuleName = null;
} else {
$focusModuleName = $this->focus->module_name;
}
if ($rhsLink == $this->name &&
($rhsModule == $focusModuleName)
) {
return REL_RHS;
}
//Next try the vardef
if (!empty($this->def['side'])) {
if ((strtolower($this->def['side']) == 'left' || $this->def['side'] == REL_LHS)
//Some relationships make have left in the vardef erroneously if generated by module builder
&& (empty($this->relationship->def['join_key_lhs'])
|| $this->name != $this->relationship->def['join_key_lhs'])
) {
return REL_LHS;
} else {
return REL_RHS;
}
} elseif (!empty($this->def['id_name'])) {
//Next try using the id_name and relationship join keys
if (isset($this->relationship->def['join_key_lhs'])
&& $this->def['id_name'] == $this->relationship->def['join_key_lhs']) {
return REL_RHS;
} elseif (isset($this->relationship->def['join_key_rhs'])
&& $this->def['id_name'] == $this->relationship->def['join_key_rhs']) {
return REL_LHS;
}
}
$GLOBALS['log']->error("Unable to get proper side for link {$this->name}");
return null;
}
/**
* @return bool true if this link represents a relationship where the parent could be one of multiple modules.
* (ex. Activities parent)
*/
public function isParentRelationship()
{
return $this->relationship->isParentRelationship();
}
/**
* @param $params array of parameters. Possible parameters include:
* 'join_table_link_alias': alias the relationship join table in the query (for M2M relationships),
* 'join_table_alias': alias for the final table to be joined against (usually a module main table)
* @param bool $return_array if true the query is returned as a array broken up into
* select, join, where, type, rel_key, and joined_tables
*
* @return string/array join query for this link
*/
public function getJoin($params, $return_array = false)
{
return $this->relationship->getJoin($this, $params, $return_array);
}
/**
* @param array $params optional parameters. Possible Values;
* 'return_as_array': returns the query broken into
*
* @return String/Array query to grab just ids for this relationship
*/
public function getQuery($params = array())
{
return $this->relationship->getQuery($this, $params);
}
/**
* This function is similar getJoin except for M2m relationships it won't join against the final table.
* Its used to retrieve the ID of the related beans only.
*
* @param $params array of parameters. Possible parameters include:
* 'return_as_array': returns the query broken into
* @param bool $return_array same as passing 'return_as_array' into parameters
*
* @return string/array query to use when joining for subpanels
*/
public function getSubpanelQuery($params = array(), $return_array = false)
{
if (!empty($this->def['ignore_role'])) {
$params['ignore_role'] = true;
}
return $this->relationship->getSubpanelQuery($this, $params, $return_array);
}
/**
* Use with caution as if you have a large list of beans in the relationship,
* it can cause the app to timeout or run out of memory.
*
* @param array $params An array that can contain the following parameters:
* where: An array with 3 key/value pairs.
* lhs_field: The name of the field to check search.
* operator: The operator to use in the search.
* rhs_value: The value to search for.
* limit: The maximum number of rows
* deleted: If deleted is set to 1, only deleted records related
* to the current record will be returned.
* Example:
* 'where' => array(
* 'lhs_field' => 'source',
* 'operator' => '=',
* 'rhs_value' => 'external'
* )
*
* @return SugarBean[] array of SugarBeans related through this link.
*/
public function getBeans($params = array())
{
//Some deprecated code attempts to pass in the old format to getBeans with a large number of useless parameters.
//reset the parameters if they are not in the new array format.
if (!is_array($params)) {
$params = array();
}
if (!$this->loaded && empty($params)) {
$this->load();
}
$rows = $this->rows;
//If params is set, we are doing a query rather than a complete load of the relationship
if (!empty($params)) {
$data = $this->query($params);
$rows = $data['rows'];
}
$result = array();
if (!$this->beansAreLoaded() || !empty($params)) {
if (!is_array($this->beans)) {
$this->beans = array();
}
$rel_module = $this->getRelatedModuleName();
//First swap in the temp loaded beans, only if we are doing a complete load (no params)
if (empty($params)) {
$result = $this->tempBeans;
$this->tempBeans = array();
}
//now load from the rows
if (is_array($rows) || is_object($rows)) {
foreach ((array)$rows as $id => $vals) {
if (empty($this->beans[$id])) {
$tmpBean = BeanFactory::getBean($rel_module, $id);
if ($tmpBean !== false) {
$result[$id] = $tmpBean;
}
} else {
$result[$id] = $this->beans[$id];
}
}
} else {
$GLOBALS['log']->fatal('"rows" should be an array or object');
}
//If we did a complete load, cache the result in $this->beans
if (empty($params)) {
$this->beans = $result;
}
} else {
$result = $this->beans;
}
return $result;
}
/**
* @return bool true if this link has initialized its related beans.
*/
public function beansAreLoaded()
{
return is_array($this->beans);
}
/**
* use this function to create link between 2 objects
* 1:1 will be treated like 1 to many.
*
* the function also allows for setting of values for additional field in the table being
* updated to save the relationship, in case of many-to-many relationships this would be the join table.
*
* @param array $rel_keys array of ids or SugarBean objects. If you have the bean in memory, pass it in.
* @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.
*
* @return bool|array Return true if all relationships were added.
* Return an array with the failed keys if any of them failed.
*/
public function add($rel_keys, $additional_values = array())
{
if (!is_array($rel_keys)) {
$rel_keys = array($rel_keys);
}
$failures = array();
foreach ($rel_keys as $key) {
//We must use beans for LogicHooks and other business logic to fire correctly
if (!($key instanceof SugarBean)) {
$key = $this->getRelatedBean($key);
if (!($key instanceof SugarBean)) {
$GLOBALS['log']->error('Unable to load related bean by id');
return false;
}
}
if (empty($key->id) || empty($this->focus->id)) {
return false;
}
if ($this->getSide() == REL_LHS) {
$success = $this->relationship->add($this->focus, $key, $additional_values);
} else {
$success = $this->relationship->add($key, $this->focus, $additional_values);
}
if ($success == false) {
$failures[] = $key->id;
}
// remove temporary beans to prevent runaway memory usage
if(isset($this->tempBeans[$key->id])) {
unset($this->tempBeans[$key->id]);
}
}
if (!empty($failures)) {
return $failures;
}
return true;
}
/**
* @param $rel_keys
* @param array $additional_values
* @return array|bool
*/
public function remove($rel_keys)
{
if (!is_array($rel_keys)) {
$rel_keys = array($rel_keys);
}
$failures = array();
foreach ($rel_keys as $key) {
//We must use beans for LogicHooks and other business logic to fire correctly
$keyBean = $key;
if (!($keyBean instanceof SugarBean)) {
$keyBean = $this->getRelatedBean($keyBean);
if (!($keyBean instanceof SugarBean)) {
$GLOBALS['log']->error('Unable to load related bean by id');
// Note these beans as failed and continue
$failures[] = $key;
continue;
}
}
if (empty($keyBean->id) || empty($this->focus->id)) {
return false;
}
if ($this->getSide() == REL_LHS) {
$success = $this->relationship->remove($this->focus, $keyBean);
} else {
$success = $this->relationship->remove($keyBean, $this->focus);
}
if ($success == false) {
$failures[] = $keyBean->id;
}
// remove temporary beans to prevent runaway memory usage
if(isset($this->tempBeans[$keyBean->id])) {
unset($this->tempBeans[$keyBean->id]);
}
}
if (!empty($failures)) {
return $failures;
}
return true;
}
/**
* Marks the relationship deleted for this given record pair.
*
* @param string $id id of the Parent/Focus SugarBean
* @param string $related_id id or SugarBean to unrelate. Pass a SugarBean if you have it.
*
* @return bool true if delete was successful or false if it was not
*/
public function delete($id, $related_id = '')
{
if (empty($this->focus->id)) {
$this->focus = BeanFactory::getBean($this->focus->module_name, $id);
}
if (!empty($related_id)) {
if (!($related_id instanceof SugarBean)) {
$related_id = $this->getRelatedBean($related_id);
}
if ($this->getSide() == REL_LHS) {
return $this->relationship->remove($this->focus, $related_id);
} else {
return $this->relationship->remove($related_id, $this->focus);
}
} else {
return $this->relationship->removeAll($this);
}
}
/**
* Returns a SugarBean with the given ID from the related module.
*
* @param bool $id id of related record to retrieve
*
* @return SugarBean
*/
protected function getRelatedBean($id = false)
{
$params = array('encode' => true, 'deleted' => true);
return BeanFactory::getBean($this->getRelatedModuleName(), $id, $params);
}
/**
* @param $name
* @return array|bool|SugarRelationship
*/
public function &__get($name)
{
switch ($name) {
case 'relationship_type':
return $this->relationship->type;
case '_relationship':
return $this->relationship;
case 'beans':
if (!is_array($this->beans)) {
$this->getBeans();
}
return $this->beans;
case 'rows':
if (!is_array($this->rows)) {
$this->load();
}
return $this->rows;
}
return $this->$name;
}
/**
* @param $name
* @param $val
*/
public function __set($name, $val)
{
if ($name == 'beans') {
$this->beans = $val;
}
}
/**
* Add a bean object to the list of beans currently loaded to this relationship.
* This for the most part should not need to be called except by the relationship implementation classes.
*
* @param SugarBean $bean
*/
public function addBean($bean)
{
if (!is_array($this->beans)) {
$this->tempBeans[$bean->id] = $bean;
} else {
$this->beans[$bean->id] = $bean;
}
}
/**
* Remove a bean object from the list of beans currently loaded to this relationship.
* This for the most part should not need to be called except by the relationship implementation classes.
*
* @param SugarBean $bean
*/
public function removeBean($bean)
{
if (!is_array($this->beans) && isset($this->tempBeans[$bean->id])) {
unset($this->tempBeans[$bean->id]);
} else {
unset($this->beans[$bean->id]);
unset($this->rows[$bean->id]);
}
}
}