Components \ commerce \ affiliates administrators commissions payments \ configuration paymentmethods \ shippingmethods \ methods delivery discounts \ products brands categories \ recurringsales storedcards \ sales items \ receipts allocations \ customers \ contacts passwords referrertypes \ relationships types \ groups contacts \ marketing \ emailmarketing \ sends contacts unsubscribers \ events attendees locations \ reminders \ automation eventremindertrigger \ settings administrators components configurationitems cpanel customfields \ developer scheduledtasks threads domains \ website \ analytics sessions comments \ designs generator media pages \ posts categories Framework \ architecture publicassets \ assets css javascript \ caching filebased \ components textualids \ data util \ database mainconnection date \ dom currentcontext renderer \ html converters highlighter javascript \ http redirection request session useragent \ i18n companytypes countries languages \ network cidr dns geoip random \ reflection api \ system filenames filesystem 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:
int addContactToGroup($iContactId, $strGroupId)
Description
Adds a contact to a group
Parameters
$iContactId
int
$strGroupId
string
Return
Rows affected
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
void getContactsInGroup($strGroupId, $arrProperties)
Description
Returns all of the contacts in a specific group
Parameters
$strGroupId
string
$arrProperties
array
Return
void
int getCount($arrFilter)
Description
Returns a count of all rows in the data adapter
Parameters
$arrFilter
array
Return
int
bool isContactInGroup($iContactId, $strGroupId)
Description
Determines whether a contact is a part of a group
Parameters
$iContactId
int
$strGroupId
string
Return
Is contact in group
string mediaFolderGet($strKey)
Description
Returns the media folder for this data adapter
Parameters
$strKey
mixed
Return
Folder
int removeContactFromGroup($iContactId, $strGroupId, $bRecursive)
Description
Removes a contact from a group
Parameters
$iContactId
int
$strGroupId
string
$bRecursive
mixed
Return
Rows affected
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')