Groups

Adds a contact to a group

Returns the raw rows dbGetAll() would return as an iterator, without building them all into an array

The dbGetAll() counterpart of getAllIterable(), for scans over every stored row of a large table (eg: the site-wide content scans in \Framework\Developer\Refactoring). Rows are as stored - JSON fields are not decoded - and are not entity-cached. Because it bypasses getAll(), components that override getAll() are iterated; search queries and components overriding dbGetAll() are refused.

Yields Groups

Returns all the columns this component supports

array

Gets a record from the database

Groups

Return a set of records from the database

Array of Groups

Returns all groups for a contact

Array of Groups

Returns all group ids for a contact

array

Deletes a record from the database

Returns true if record existed and was deleted, otherwise false

Returns the entities getAll() would return as an iterator, without building them all into an array

For result sets too large to hold as arrays (eg: every recipient of a marketing send) - only the database driver's compact buffer of the result is held, a fraction of getAll()'s memory. Runs the same SQL as getAll(), and runs it now, as getAll() would; rows are decoded as you iterate.
Search queries are not supported, rows are not entity-cached, and components that override getAll() or dbGetAll() (eg: merging in defaults) are refused rather than iterated without their extra rows.

Yields Groups

Returns all groups nested directly under a group

Array of Groups

Gets a single field from a record

mixed

Returns all of the contacts in a specific group

array

Returns the number of contacts in a group

int

Returns the number of records in the database (matching the filter if specified)

int

Determines whether a contact is a part of a group

Is contact in group

Removes a contact from a group

Saves a record into the database

string|int

Saves a specific column of a row into a database

Performs a search

Array of Groups that match the search query.