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 \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\HTML\Bleacher \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
delete()
get()
getAll()
getColumn()
getCount()
save()
saveColumn()
search()
Fields

\Components\Customers\Contacts\Relationships\Types::

Use this API to create, update and delete contacts.

Methods

Invoke via \Components\Customers\Contacts\Relationships\Types::method()
Click a method name to copy it.
bool delete($strRelationshipTypeId, $bDeleteMedia)
Deletes a record from the database
Parameters
$strRelationshipTypeId
string
A record's relationship_type_id
$bDeleteMedia
bool
Return
Returns true if record existed and was deleted, otherwise false
array get($strRelationshipTypeId)
Return the current value
Parameters
$strRelationshipTypeId
string
A record's relationship_type_id
Return
array
array getAll($arrQuery)
Return a set of records from the database
Parameters
$arrQuery
array|null
Query Array
Return
Array of Types
mixed getColumn($strRelationshipTypeId, $strColumn)
Gets a single field from a record
Parameters
$strRelationshipTypeId
string
A record's relationship_type_id
$strColumn
string
Return
mixed
int getCount($arrFilter)
Parameters
$arrFilter
array|null
Filter Array
Return
int
string|int save($arrEntity)
Saves a record into the database
Parameters
$arrEntity
mixed
Return
string|int
void saveColumn($strRelationshipTypeId, $strColumn, $strValue)
Saves a specific column of a row into a database
Parameters
$strRelationshipTypeId
string
A record's relationship_type_id
$strColumn
string
$strValue
string
array search($strSearch, $arrQuery)
Performs a search
Parameters
$strSearch
string
Search query
$arrQuery
array|null
Query Array
Return
Array of Types that match the search query.

Database Fields

The following fields are used when retrieving and saving entities.
relationship_type_id
string (255)
relationship_type_category
string (3)
relationship_type_title
string (255)
relationship_type_is_reciprocal
0 or 1
relationship_type_grants_invoice_access
0 or 1