Rules

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 Rules

Returns all the columns this component supports

array

Deletes a record from the database

Returns true if record existed and was deleted, otherwise false

Gets a record from the database

Rules

Return a set of records from the database

Array of Rules

Return all rules for a recurring event series.

array

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 Rules

Gets a single field from a record

mixed

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

int

Return day-of-week options.

array

Return the title for a day-of-week value.

string

Return interval options for recurring event schedules.

array

Render an interval in a user-readable form.

string

Return monthly repeat mode options with titles derived from an anchor date.

The weekday modes follow the anchor's weekday - an anchor on the second
Tuesday repeats on second Tuesdays. The "last" mode is only offered when the anchor sits in the final seven days of its month (where "fourth" and "last" genuinely differ), plus whenever it is the currently saved mode so an existing selection stays representable after the start date moves.

array

Render a monthly repeat mode as a phrase, e.g. "on the second Tuesday".

string

Return monthly repeat mode values.

array

Return which occurrence of its weekday within the month a day is (1-5).

int

Return the title for a weekday ordinal, e.g. 2 becomes "second".

string

Replace all rules for a recurring event series.

Saves a record into the database

string|int

Saves a specific column of a row into a database

Performs a search

Array of Rules that match the search query.