Templating
Global Functions
Website
\Components\Website\Designs \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\Caching\FileBased \Framework\Data\Util \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
Methods

\Components\Customers\Groups::

Use this API to create, update and delete groups; and manage their contacts.

Methods

Invoke via \Components\Customers\Groups::method()
Click a method name to copy it.
void addContactToGroup($iContactId, $arrGroupIds)
Adds a contact to a group
Parameters
$iContactId
int
$arrGroupIds
string|array
array get($strGroupId)
Gets a record from the database
Parameters
$strGroupId
string
A record's group_id
Return
array getAll($arrQuery)
Return a set of records from the database
Parameters
$arrQuery
array|null
Return
Array of Groups
array getAllForContact($iContactId)
Returns all groups for a contact
Parameters
$iContactId
int
Return
Array of Groups
array getAllIdsForContact($iContactId)
Returns all group ids for a contact
Parameters
$iContactId
int
Return
array
array getChildren($strGroupId, $arrQuery)
Returns all groups nested directly under a group
Parameters
$strGroupId
string
$arrQuery
mixed
Return
Array of Groups
mixed getColumn($strGroupId, $strColumn)
Gets a single field from a record
Parameters
$strGroupId
string
A record's group_id
$strColumn
string
Return
mixed
array getContactsInGroup($arrGroupIds, $arrQuery)
Returns all of the contacts in a specific group
Parameters
$arrGroupIds
string|array
$arrQuery
array|null
Return
array
int getContactsInGroupCount($arrGroupIds, $arrFilter)
Returns the number of contacts in a group
Parameters
$arrGroupIds
string|array
$arrFilter
array
Return
int
int getCount($arrFilter)
Returns the number of records in the database (matching the filter if specified)
Parameters
$arrFilter
array|null
Return
int
bool isContactInGroup($iContactId, $arrGroupIds)
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)
Removes a contact from a group
Parameters
$iContactId
int
$arrGroupIds
string|array
string save($arrEntity)
Saves a record into the database
Parameters
$arrEntity
array
Return
The record's group_id
void saveColumn($strGroupId, $strColumn, $strValue)
Saves a specific column of a row into a database
Parameters
$strGroupId
string
A record's group_id
$strColumn
string
$strValue
string
array search($strSearch, $arrQuery)
Performs a search
Parameters
$strSearch
string
Search query
$arrQuery
array|null
Return
Array of Groups that match the search query.
bool delete($strGroupId, $bDeleteMedia)
Deletes a record from the database
Parameters
$strGroupId
string
A record's group_id
$bDeleteMedia
bool
Return
Returns true if record existed and was deleted, otherwise false

Database Fields

The following fields are used when retrieving and saving entities.
group_id
string (255)
group_date
datetime
group_title
string (255)
group_description
string (65535)
group_table
string (64)
group_is_unsubscribable
0 or 1
group_contact_count
int unsigned (10)
group_marketing_link
string (255)
group_order
int unsigned
group_parent_id
string (255)