\Customers\Contacts\Relationships
Templating
Global Functions
Website
\Components\Website\Designs \Components\Website\Media \Components\Website\Pages \Components\Website\Pages\Forms \Components\Website\Posts \Components\Website\Posts\Categories
Customers
\Components\Customers\Contacts \Components\Customers\Contacts\Relationships
DESCRIPTION
METHODS
contactHasEditingRights()
delete()
get()
getAll()
getAllCompaniesInRelationshipWith()
getAllContactsInRelationshipWith()
getAllForContact()
getColumn()
getCount()
save()
saveColumn()
search()
\Components\Customers\Contacts\Relationships\Types \Components\Customers\Groups
Marketing
\Components\Marketing\EmailMarketing \Components\Marketing\Events \Components\Marketing\Events\Attendees \Components\Marketing\Events\Categories \Components\Marketing\Events\Locations
Commerce
\Components\Commerce\Carts \Components\Commerce\Carts\Current \Components\Commerce\Configuration\PaymentMethods \Components\Commerce\Configuration\ShippingMethods \Components\Commerce\Discounts \Components\Commerce\Products \Components\Commerce\Products\Brands \Components\Commerce\Products\Categories \Components\Commerce\Products\Inventory \Components\Commerce\Sales \Components\Commerce\Sales\Items \Components\Commerce\Sales\Receipts \Components\Commerce\Sales\Receipts\Allocations
Settings
\Components\Settings\Administrators \Components\Settings\CustomFields \Components\Settings\Domains
Other Apps
\Components\Website\Comments \Components\Commerce\Affiliates \Components\Commerce\Affiliates\Administrators \Components\Commerce\Affiliates\Commissions \Components\Commerce\Affiliates\Payments \Components\Commerce\RecurringSales \Components\Commerce\RecurringSales\StoredCards
Framework
\Framework\Caching \Framework\Data\Util \Framework\DOM\CurrentContext \Framework\HTML\Converters \Framework\HTTP\Cookies \Framework\HTTP\Redirection \Framework\HTTP\Request \Framework\HTTP\Session \Framework\HTTP\UserAgent \Framework\I18N\CompanyTypes \Framework\I18N\Countries \Framework\I18N\Languages \Framework\Network\GeoIP

Relationships

Use this API to create, update and delete relationships between contacts.

Methods

Invoke via \Components\Customers\Contacts\Relationships::method()
Click a method name to copy it.
- ` boolean contactHasEditingRights($iContactId1, $iContactId2) `
Determines if a contact 1 has editing rights over contact 2
Parameters:
- $iContactId1
mixed
- $iContactId2
mixed
Return
boolean
- ` bool delete($iRelationshipId, $bDeleteMedia) `
Deletes a record from the database
Parameters:
- $iRelationshipId
int unsigned
A record's relationship_id
- $bDeleteMedia
mixed
Return
Returns true if record existed and was deleted, otherwise false
- ` array get($iRelationshipId) `
Gets a record from the database
Parameters:
- $iRelationshipId
int unsigned
A record's relationship_id
Return
Relationships
- ` array getAll($arrQuery) `
Return a set of records from the database
Parameters:
- $arrQuery
mixed
Return
Array of Relationships
- ` array getAllCompaniesInRelationshipWith($iContactId) `
Retrieves all companies that are related to a contactid
Parameters:
- $iContactId
mixed
Return
array
- ` array getAllContactsInRelationshipWith($iContactId, $strRelationshipTypeId) `
Retrieves all contacts who are in a direct relationship of type $strRelationshipTypeId with a specific contact
Parameters:
- $iContactId
mixed
- $strRelationshipTypeId
mixed
Return
array
- ` array getAllForContact($iContactId, $strRelationshipType, $arrQuery) `
Retrieves all direct relationships for a specific contact
Parameters:
- $iContactId
mixed
- $strRelationshipType
mixed
- $arrQuery
mixed
Return
Array of Relationships
- ` mixed getColumn($iRelationshipId, $strColumn) `
Gets a single field from a record
Parameters:
- $iRelationshipId
int unsigned
A record's relationship_id
- $strColumn
mixed
Return
mixed
- ` int getCount($arrFilter) `
Returns the number of records in the database (matching the filter if specified)
Parameters:
- $arrFilter
mixed
Return
int
- ` string|int save($arrEntity) `
Saves a record into the database
Parameters:
- $arrEntity
mixed
Return
string|int
- ` void saveColumn($iRelationshipId, $strColumn, $strValue) `
Saves a specific column of a row into a database
Parameters:
- $iRelationshipId
int unsigned
A record's relationship_id
- $strColumn
mixed
- $strValue
mixed
- ` array search($strSearch, $arrQuery) `
Performs a search
Parameters:
- $strSearch
mixed
- $arrQuery
mixed
Return
Array of Relationships that match the search query.

Database Fields

The following fields are used when retrieving and saving entities:
- `relationship_id`
int unsigned (10)
- `contact_id_1`
int (10)
- `contact_id_2`
int (10)
- `contact1_can_edit_contact2`
0 or 1
- `contact2_can_edit_contact1`
0 or 1
- `relationship_type_id`
string (255)