\Components\Commerce\Affiliates \Components\Commerce\Affiliates\Administrators \Components\Commerce\Affiliates\Commissions \Components\Commerce\Affiliates\Payments \Components\Commerce\Configuration\PaymentMethods \Components\Commerce\Configuration\ShippingMethods \Components\Commerce\Discounts \Components\Commerce\Products \Components\Commerce\Products\Brands \Components\Commerce\Products\Categories \Components\Commerce\RecurringSales \Components\Commerce\RecurringSales\StoredCards \Components\Commerce\Sales \Components\Commerce\Sales\Items \Components\Commerce\Sales\Receipts \Components\Commerce\Sales\Receipts\Allocations \Components\Customers\Contacts \Components\Customers\Contacts\Relationships \Components\Customers\Contacts\Relationships\Types \Components\Customers\Groups \Components\Customers\Groups\Contacts \Components\Marketing\EmailMarketing \Components\Marketing\Events \Components\Marketing\Events\Attendees \Components\Marketing\Events\Locations \Components\Settings\Administrators \Components\Settings\Domains \Components\Website\Analytics\Sessions \Components\Website\Comments \Components\Website\Designs \Components\Website\Media \Components\Website\Pages \Components\Website\Pages\Forms \Components\Website\Posts \Components\Website\Posts\Categories \Framework\Architecture\PublicAssets \Framework\Assets\CSS \Framework\Assets\JavaScript \Framework\Caching\FileBased \Framework\Data\Util \Framework\Database\MainConnection \Framework\Date \Framework\DOM\Renderer \Framework\HTML\Converters \Framework\HTML\Highlighter \Framework\HTML\JavaScript \Framework\HTTP\Redirection \Framework\HTTP\Request \Framework\HTTP\Session \Framework\HTTP\UserAgent \Framework\I18N\CompanyTypes \Framework\I18N\Countries \Framework\I18N\Languages \Framework\Network\CIDR \Framework\Network\DNS \Framework\Network\GeoIP \Framework\Random \Framework\System\FileNames \Framework\System\FileSystem \Framework\Toasts
.
.
.
quick access
\ methods

\Components\Customers\Groups::

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

Class Methods

The following static 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
string configGetValue($strConfigId)
Description
Retrieves the value of a config item for the current component
Parameters
$strConfigId
string
Return
Config item value
bool delete($strKeyValue, $bDeleteMedia, $strReason)
Description
Deletes an entity and triggers the pre/post component events
Parameters
$strKeyValue
string
$bDeleteMedia
bool
$strReason
mixed
Return
bool
array get($strKey)
Description
Returns an entity
Parameters
$strKey
mixed
Value of the primary key
Return
{Array} getAll($arrProperties)
Description
Return all entities in the database.
Parameters
$arrProperties
mixed
Return
Array of Groups
mixed getColumn($strKey, $strColumn)
Description
Returns a single column of an entity
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 a count of all rows in the data adapter
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
string mediaFolderGet($strKey)
Description
Returns the media folder for this data adapter
Parameters
$strKey
mixed
Return
Folder
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 an entity and triggers the pre/post component events
Parameters
$arrEntity
array
$strReason
string
Return
mixed
mixed saveColumn($strKeyValue, $strColumn, $strValue, $strReason)
Description
Changes a column of an existing entity Supports primary keys spanning on several columns if passing $strKeyValue as an associative arry
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

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_rpl_page
varchar (255)
group_rpl_product_id
int (11)
group_table
varchar (64)
group_title
varchar (255)
group_unit_hours
int (11)
group_unit_page
varchar (255)
group_unit_product_id
int (11)
group_unit_type
enum ('','Core','Elective')