Discounts
Allow you to create discounts on products, categories and brands.
Methods
Invoke via \Components\Commerce\Discounts::method()
Click a method name to copy it.
Activates a discount with a specific code
Removes all discounts that have been activated by code
Returns whether a discount with a specific id has been applied
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.
Returns all the columns this component supports
Gets a record from the database
Parameters:
- $iDiscountId
int
A record's discount_id
Return a set of records from the database
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.
Deletes a record from the database
Parameters:
- $iDiscountId
int
A record's discount_id
Return
Returns true if record existed and was deleted, otherwise false
Retrieves the number of discounts which require a code and enabled for public
Gets a single field from a record
Parameters:
- $iDiscountId
int
A record's discount_id
Retrieves the contact id on which discounts are currently meant to be applied to.
This is useful for custom algorithm discounts
Returns the number of records in the database (matching the filter if specified)
Saves a record into the database
Saves a specific column of a row into a database
Parameters:
- $iDiscountId
int
A record's discount_id
Return
Array of
Discounts that match the search query.
