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 \Components\Customers\Contacts\Relationships\Types \Components\Customers\Groups
Marketing
\Components\Marketing\EmailMarketing \Components\Marketing\Events \Components\Marketing\Events\Attendees \Components\Marketing\Events\Locations
Commerce
\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\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\Assets\CSS \Framework\Assets\JavaScript \Framework\Caching\FileBased \Framework\Data\Util \Framework\Date \Framework\DOM\Renderer \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
.
.
.
Description
Methods
contactHasEditingRights()
get()
getAll()
getAllContactsInRelationshipWith()
getColumn()
getCount()
getRelationshipsSelectorDatasource()
save()
saveColumn()
search()
delete()
Fields

\Components\Customers\Contacts\Relationships::

Class Methods

The following methods are available on this class:
boolean contactHasEditingRights($iContactId1, $iContactId2)
Description
Determines if a contact 1 has editing rights over contact 2
Parameters
$iContactId1
int
$iContactId2
int
Return
boolean
array get($strKey)
Description
Gets a record from the database
Parameters
$strKey
mixed
Value of the primary key
Return
Relationships
array getAll($arrProperties)
Description
Return a set of records from the database
Parameters
$arrProperties
array
Properties Array
Return
Array of Relationships
array getAllContactsInRelationshipWith($iContactId, $strRelationshipTypeId)
Description
Retrieves all contacts who are in a direct relationship of type $strRelationshipTypeId with a specific contact
Parameters
$iContactId
int
$strRelationshipTypeId
string
Return
array
mixed getColumn($strKey, $strColumn)
Description
Gets a single field from a record
Parameters
$strKey
string
$strColumn
string
Return
mixed
int getCount($arrFilter)
Description
Returns the number of rows in the database
Parameters
$arrFilter
array
Return
int
array getRelationshipsSelectorDatasource($iContactId, $bAdmin, $strGroupId, $strCategoryId, $iMaxRecursionLevel, $arrProperties)
Description
Constructs the relationship selector options
Parameters
$iContactId
int
$bAdmin
bool
$strGroupId
string
$strCategoryId
string
$iMaxRecursionLevel
int
$arrProperties
array
Return
array
mixed save($arrEntity, $strReason)
Description
Saves a record into the database
Parameters
$arrEntity
array
$strReason
string
Return
mixed
mixed saveColumn($strKeyValue, $strColumn, $strValue, $strReason)
Description
Saves a specific column of a row into a database
Parameters
$strKeyValue
string
$strColumn
string
$strValue
string
$strReason
string
Return
Id
array search($strSearch, $arrProperties)
Description
Performs a search
Parameters
$strSearch
string
$arrProperties
mixed
Return
array
bool delete($strKeyValue, $bDeleteMedia, $strReason)
Description
Deletes a record from the database
Parameters
$strKeyValue
string|array
$bDeleteMedia
bool
$strReason
mixed
Return
bool

Database Fields

The following fields are used when retrieving and saving entities.
contact1_can_edit_contact2
tinyint (1)
contact2_can_edit_contact1
tinyint (1)
contact_id_1
int (10)
contact_id_2
int (10)
relationship_id
int unsigned (10)
relationship_type_id
varchar (255)