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
addContactToGroup()
get()
getAll()
getAllForContact()
getAllIdsForContact()
getChildren()
getColumn()
getContactsInGroup()
getContactsInGroupCount()
getCount()
isContactInGroup()
removeContactFromGroup()
save()
saveColumn()
search()
delete()
Fields

\Components\Customers\Groups::

Groups are collections of contacts used to segment your database for marketing and management.

Class Methods

The following methods are available on this class:
void addContactToGroup($iContactId, $arrGroupIds)
Description
Adds a contact to a group
Parameters
$iContactId
int
$arrGroupIds
string|array
Return
void
array get($strKey)
Description
Gets a record from the database
Parameters
$strKey
mixed
Value of the primary key
Return
Groups
array getAll($arrProperties)
Description
Return a set of records from the database
Parameters
$arrProperties
array
Properties Array
Return
Array of Groups
array getAllForContact($iContactId)
Description
Returns all groups for a contact
Parameters
$iContactId
int
Return
array
array getAllIdsForContact($iContactId)
Description
Returns all group ids for a contact
Parameters
$iContactId
int
Return
array
array getChildren($strGroupId, $arrProperties)
Description
Returns all groups nested directly under a group
Parameters
$strGroupId
string
$arrProperties
mixed
Return
array
mixed getColumn($strKey, $strColumn)
Description
Gets a single field from a record
Parameters
$strKey
string
$strColumn
string
Return
mixed
array getContactsInGroup($arrGroupIds, $arrProperties)
Description
Returns all of the contacts in a specific group
Parameters
$arrGroupIds
string|array
$arrProperties
array
Return
array
int getContactsInGroupCount($arrGroupIds, $arrFilter)
Description
Returns the number of contacts in a group
Parameters
$arrGroupIds
string|array
$arrFilter
array
Return
int
int getCount($arrFilter)
Description
Returns the number of rows in the database
Parameters
$arrFilter
array
Return
int
bool isContactInGroup($iContactId, $arrGroupIds)
Description
Determines whether a contact is a part of a group
Parameters
$iContactId
int
$arrGroupIds
string|array
Return
Is contact in group
void removeContactFromGroup($iContactId, $arrGroupIds)
Description
Removes a contact from a group
Parameters
$iContactId
int
$arrGroupIds
string|array
Return
void
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.
group_contact_count
int unsigned (10)
group_date
datetime
group_description
text
group_id
varchar (255)
group_is_joinable
tinyint unsigned (1)
group_is_unsubscribable
tinyint (1)
group_marketing_link
varchar (255)
group_networking
tinyint unsigned (1)
group_networking_security_filtering
tinyint unsigned (1)
group_networking_security_is_contact
tinyint unsigned (1)
group_networking_security_is_contact_of_group
tinyint unsigned (1)
group_order
smallint unsigned (5)
group_parent_id
varchar (255)
group_table
varchar (64)
group_title
varchar (255)