data/Relationships/One2MBeanRelationship.php

Show:

inherited

Classes
- \One2MBeanRelationship

Table of Contents

\One2MBeanRelationship
jump to top

Package: SugarCRM

Represents a one to many relationship that is table based.

It contains at least two links. Each link represents a connection from one record to the records linked in this relationship. Links have a context(focus) bean while relationships do not.

Parent(s): \One2MRelationship < \M2MRelationship < \SugarRelationship
Children: \One2OneBeanRelationship
Api

Properties


                 $beansToResave= 'array()'

staticinheritedInherited from: \SugarRelationship::$$beansToResave \M2MRelationship::$$beansToResave \One2MRelationship::$$beansToResave

Default valuearray()Details

Type: n/a
Inherited_from: \SugarRelationship::$$beansToResave
Inherited_from: \M2MRelationship::$$beansToResave
Inherited_from: \One2MRelationship::$$beansToResave


                 $def= ''

inheritedInherited from: \SugarRelationship::$$def \M2MRelationship::$$def \One2MRelationship::$$def

Details

Type: n/a
Inherited_from: \SugarRelationship::$$def
Inherited_from: \M2MRelationship::$$def
Inherited_from: \One2MRelationship::$$def


                 $ignore_role_filter= 'false'

inheritedInherited from: \SugarRelationship::$$ignore_role_filter \M2MRelationship::$$ignore_role_filter \One2MRelationship::$$ignore_role_filter

Default valuefalseDetails

Type: n/a
Inherited_from: \SugarRelationship::$$ignore_role_filter
Inherited_from: \M2MRelationship::$$ignore_role_filter
Inherited_from: \One2MRelationship::$$ignore_role_filter


                 $lhsLink= ''

inheritedInherited from: \SugarRelationship::$$lhsLink \M2MRelationship::$$lhsLink \One2MRelationship::$$lhsLink

Details

Type: n/a
Inherited_from: \SugarRelationship::$$lhsLink
Inherited_from: \M2MRelationship::$$lhsLink
Inherited_from: \One2MRelationship::$$lhsLink


                 $rhsLink= ''

inheritedInherited from: \SugarRelationship::$$rhsLink \M2MRelationship::$$rhsLink \One2MRelationship::$$rhsLink

Details

Type: n/a
Inherited_from: \SugarRelationship::$$rhsLink
Inherited_from: \M2MRelationship::$$rhsLink
Inherited_from: \One2MRelationship::$$rhsLink


                 $self_referencing= 'false'

inheritedInherited from: \SugarRelationship::$$self_referencing \M2MRelationship::$$self_referencing \One2MRelationship::$$self_referencing

Default valuefalseDetails

Type: n/a
Inherited_from: \SugarRelationship::$$self_referencing
Inherited_from: \M2MRelationship::$$self_referencing
Inherited_from: \One2MRelationship::$$self_referencing


                 $type= '"one-to-many"'

Default value"one-to-many"Details

Type: n/a

Methods

__construct(
           $def
          )
        
        :
          void

Parameters

Name	Type	Description
$def

__get(
           $name
          )
        
        :
          void

inherited

Inherited from: \SugarRelationship::__get()\M2MRelationship::__get()\One2MRelationship::__get()

Parameters

Name	Type	Description
$name

add(
          \$lhs $lhs, \$rhs $rhs, \$additionalFields $additionalFields
              =
              array()
          )
        
        :
          boolean

Parameters

Name	Type	Description
$lhs	\$lhs	SugarBean left side bean to add to the relationship.
$rhs	\$rhs	SugarBean right side bean to add to the relationship.
$additionalFields	\$additionalFields	key=>value pairs of fields to save on the relationship

Returns

Type	Description
boolean	true if successful

addRow(
          array $row
          )
        
        :
          bool | void

inherited

Inherited from: \SugarRelationship::addRow()\M2MRelationship::addRow()\One2MRelationship::addRow()

Parameters

Name	Type	Description
$row	array	values to be inserted into the relationship

Returns

Type	Description
bool \| void	null if new row was inserted and true if an existing row was updated

addSelfReferencing(
           $lhs,  $rhs, array $additionalFields
              =
              array()
          )
        
        :
          void

inherited

Just overriding the function from M2M to prevent it from occuring

Inherited from: \One2MRelationship::addSelfReferencing()

The logic for dealing with adding self-referencing one-to-many relations is in the add() method

Parameters

Name	Type	Description
$lhs
$rhs
$additionalFields	array

addToResaveList(
          \SugarBean $bean
          )
        
        :
          void

staticinherited

Adds a realted Bean to the list to be resaved along with the current bean.

Inherited from: \SugarRelationship::addToResaveList()\M2MRelationship::addToResaveList()\One2MRelationship::addToResaveList()

Parameters

Name	Type	Description
$bean	\SugarBean

Details

Static

callAfterAdd(
          \SugarBean $focus, \SugarBean $related, string $link_name
              =
              ""
          )
        
        :
          void

inherited

Call the after add logic hook for a given link

Inherited from: \SugarRelationship::callAfterAdd()\M2MRelationship::callAfterAdd()\One2MRelationship::callAfterAdd()

Parameters

Name	Type	Description
$focus	\SugarBean	base bean the hooks is triggered from
$related	\SugarBean	bean being added/removed/updated from relationship
$link_name	string	name of link being triggerd

callAfterDelete(
          \SugarBean $focus, \SugarBean $related, string $link_name
              =
              ""
          )
        
        :
          void

inherited

Inherited from: \SugarRelationship::callAfterDelete()\M2MRelationship::callAfterDelete()\One2MRelationship::callAfterDelete()

Parameters

Name	Type	Description
$focus	\SugarBean
$related	\SugarBean
$link_name	string

callBeforeAdd(
          \SugarBean $focus, \SugarBean $related, string $link_name
              =
              ""
          )
        
        :
          void

inherited

Call the before add logic hook for a given link

Inherited from: \SugarRelationship::callBeforeAdd()\M2MRelationship::callBeforeAdd()\One2MRelationship::callBeforeAdd()

Parameters

Name	Type	Description
$focus	\SugarBean	base bean the hooks is triggered from
$related	\SugarBean	bean being added/removed/updated from relationship
$link_name	string	name of link being triggerd

callBeforeDelete(
          \SugarBean $focus, \SugarBean $related, string $link_name
              =
              ""
          )
        
        :
          void

inherited

Inherited from: \SugarRelationship::callBeforeDelete()\M2MRelationship::callBeforeDelete()\One2MRelationship::callBeforeDelete()

Parameters

Name	Type	Description
$focus	\SugarBean
$related	\SugarBean
$link_name	string

checkExisting(
           $row
          )
        
        :
          array | bool

inherited

Checks for an existing row who's keys match the one passed in.

Inherited from: \SugarRelationship::checkExisting()\M2MRelationship::checkExisting()\One2MRelationship::checkExisting()

Parameters

Name	Type	Description
$row

Returns

Type	Description
array \| bool	returns false if now row is found, otherwise the row is returned

getAlternateKeyFields(
          
          )
        
        :
          Array

inherited

Inherited from: \M2MRelationship::getAlternateKeyFields()\One2MRelationship::getAlternateKeyFields()

Returns

Type	Description
Array	- set of fields that uniquely identify an entry in this relationship

getCustomLogicArguments(
          \SugarBean $focus, \SugarBean $related, string $link_name
          )
        
        :
          array

inherited

Inherited from: \SugarRelationship::getCustomLogicArguments()\M2MRelationship::getCustomLogicArguments()\One2MRelationship::getCustomLogicArguments()

Parameters

Name	Type	Description
$focus	\SugarBean	base bean the hooks is triggered from
$related	\SugarBean	bean being added/removed/updated from relationship
$link_name	string	name of link being triggerd

Returns

Type	Description
array	base arguments to pass to relationship logic hooks

getFields(
          
          )
        
        :
          array

inherited

Inherited from: \M2MRelationship::getFields()\One2MRelationship::getFields()

Returns

Type	Description
array	names of fields stored on the relationship

getJoin(
          \Link2 $link,  $params
              =
              array(),  $return_array
              =
              false
          )
        
        :
          string | array

Parameters

Name	Type	Description
$link	\Link2
$params
$return_array

Returns

Type	Description
string \| array	the query to join against the related modules table for the given link.

getLHSLink(
          
          )
        
        :
          String

inherited

Inherited from: \SugarRelationship::getLHSLink()\M2MRelationship::getLHSLink()\One2MRelationship::getLHSLink()

Returns

Type	Description
String	left link in relationship.

getLHSModule(
          
          )
        
        :
          string

inherited

Inherited from: \SugarRelationship::getLHSModule()\M2MRelationship::getLHSModule()\One2MRelationship::getLHSModule()

Returns

Type	Description
string	name of left hand side module.

getLinkedDefForModuleByRelationship(
           $module
          )
        
        :
          array | bool

inherited

Find the link entry for a particular relationship and module.

Inherited from: \M2MRelationship::getLinkedDefForModuleByRelationship()\One2MRelationship::getLinkedDefForModuleByRelationship()

Parameters

Name	Type	Description
$module

Returns

Type	Description
array \| bool

getMostAppropriateLinkedDefinition(
           $links
          )
        
        :
          bool

inherited

Find the most 'appropriate' link entry for a relationship/module in which there are multiple link entries with the same relationship name.

Inherited from: \M2MRelationship::getMostAppropriateLinkedDefinition()\One2MRelationship::getMostAppropriateLinkedDefinition()

Parameters

Name	Type	Description
$links

Returns

Type	Description
bool

getOptionalWhereClause(
          \$optional_array $optional_array
          )
        
        :
          string

inherited

Inherited from: \SugarRelationship::getOptionalWhereClause()\M2MRelationship::getOptionalWhereClause()\One2MRelationship::getOptionalWhereClause()

Parameters

Name	Type	Description
$optional_array	\$optional_array	clause to add to the where query when populating this relationship. It should be in the

Returns

Type	Description
string

getQuery(
          \$link $link,  $params
              =
              array()
          )
        
        :
          string | array

Gets the query to load a link.

This is currently public, but should prob be made protected later. See Link2->getQuery

Parameters

Name	Type	Description
$link	\$link	Link Object to get query for.
$params

Returns

Type	Description
string \| array	query used to load this relationship

getRHSLink(
          
          )
        
        :
          String

inherited

Inherited from: \SugarRelationship::getRHSLink()\M2MRelationship::getRHSLink()\One2MRelationship::getRHSLink()

Returns

Type	Description
String	right link in relationship.

getRHSModule(
          
          )
        
        :
          string

inherited

Inherited from: \SugarRelationship::getRHSModule()\M2MRelationship::getRHSModule()\One2MRelationship::getRHSModule()

Returns

Type	Description
string	name of right hand side module.

getRelationshipTable(
          
          )
        
        :
          string

Returns

Type	Description
string	name of the table for this relationship

getRoleFilterForJoin(
          
          )
        
        :
          void

inherited

Inherited from: \M2MRelationship::getRoleFilterForJoin()\One2MRelationship::getRoleFilterForJoin()

getRoleWhere(
          string $table
              =
              "",  $ignore_role_filter
              =
              false
          )
        
        :
          string

inherited

Gets the relationship role column check for the where clause

Inherited from: \SugarRelationship::getRoleWhere()\M2MRelationship::getRoleWhere()\One2MRelationship::getRoleWhere()

Parameters

Name	Type	Description
$table	string
$ignore_role_filter

Returns

Type	Description
string

getRowToInsert(
           $lhs,  $rhs,  $additionalFields
              =
              array()
          )
        
        :
          void

inherited

Inherited from: \M2MRelationship::getRowToInsert()\One2MRelationship::getRowToInsert()

Parameters

Name	Type	Description
$lhs
$rhs
$additionalFields

getSubpanelQuery(
           $link, array $params
              =
              array(), bool $return_array
              =
              false
          )
        
        :
          String | Array

Similar to getQuery or Get join, except this time we are starting from the related table and searching for items with id's matching the $link->focus->id

Parameters

Name	Type	Description
$link
$params	array
$return_array	bool

Returns

Type	Description
String \| Array

isParentRelationship(
          
          )
        
        :
          bool

inherited

Inherited from: \SugarRelationship::isParentRelationship()\M2MRelationship::isParentRelationship()\One2MRelationship::isParentRelationship()

Returns

Type	Description
bool	true if the relationship is a flex / parent relationship

linkIsLHS(
           $link
          )
        
        :
          void

inherited

Inherited from: \One2MRelationship::linkIsLHS()

Parameters

Name	Type	Description
$link

load(
          \$link $link,  $params
              =
              array()
          )
        
        :
          void

Parameters

Name	Type	Description
$link	\$link	Link2 loads the relationship for this link.
$params

relationship_exists(
          \SugarBean $lhs, \SugarBean $rhs
          )
        
        :
          boolean

Check to see if the relationship already exist.

If it does return true otherwise return false

Parameters

Name	Type	Description
$lhs	\SugarBean	Left hand side of the relationship
$rhs	\SugarBean	Right hand side of the relationship

Returns

Type	Description
boolean

remove(
          \$lhs $lhs, \$rhs $rhs,  $save
              =
              true
          )
        
        :
          boolean

Parameters

Name	Type	Description
$lhs	\$lhs	SugarBean
$rhs	\$rhs	SugarBean
$save

Returns

Type	Description
boolean

removeAll(
          \$link $link
          )
        
        :
          boolean

inherited

Inherited from: \SugarRelationship::removeAll()\M2MRelationship::removeAll()\One2MRelationship::removeAll()

Parameters

Name	Type	Description
$link	\$link	Link2 removes all the beans associated with this link from the relationship

Returns

Type	Description
boolean	true if it was successful, false if it was not

removeById(
          \$rowID $rowID
          )
        
        :
          void

inherited

Inherited from: \SugarRelationship::removeById()\M2MRelationship::removeById()\One2MRelationship::removeById()

Parameters

Name	Type	Description
$rowID	\$rowID	id of SugarBean to remove from the relationship

removeRow(
          \$where $where
          )
        
        :
          bool | resource

inherited

Removes one or more rows from the relationship table

Inherited from: \SugarRelationship::removeRow()\M2MRelationship::removeRow()\One2MRelationship::removeRow()

Parameters

Name	Type	Description
$where	\$where	array of field=>value pairs to match

Returns

Type	Description
bool \| resource

removeSelfReferencing(
           $lhs,  $rhs, array $additionalFields
              =
              array()
          )
        
        :
          void

inherited

Just overriding the function from M2M to prevent it from occuring

Inherited from: \One2MRelationship::removeSelfReferencing()

Parameters

Name	Type	Description
$lhs
$rhs
$additionalFields	array

resaveRelatedBeans(
          
          )
        
        :
          void

staticinherited

Inherited from: \SugarRelationship::resaveRelatedBeans()\M2MRelationship::resaveRelatedBeans()\One2MRelationship::resaveRelatedBeans()

Details

Static

updateFields(
           $lhs,  $rhs,  $additionalFields
          )
        
        :
          void

Parameters

Name	Type	Description
$lhs
$rhs
$additionalFields

updateLinks(
           $lhs,  $lhsLinkName,  $rhs,  $rhsLinkName
          )
        
        :
          void

Parameters

Name	Type	Description
$lhs
$lhsLinkName
$rhs
$rhsLinkName

updateRow(
          \$id $id, \$values $values
          )
        
        :
          resource

inherited

Inherited from: \SugarRelationship::updateRow()\M2MRelationship::updateRow()\One2MRelationship::updateRow()

Parameters

Name	Type	Description
$id	\$id	id of row to update
$values	\$values	values to insert into row

Returns

Type	Description
resource	result of update satatement

data/Relationships/One2MBeanRelationship.php

\One2MBeanRelationshipjump to top

Properties

Methods

\One2MBeanRelationship
jump to top