Categories
Access, create, update and delete the categories of products that you sell online.
Methods
Invoke via \Components\Commerce\Products\Categories::method()
Click a method name to copy it.
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:
- $iProductCategoryId
int unsigned
A record's product_category_id
Return a set of records from the database
Returns all categories for a specific product
Returns all category Ids for a specific product
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.
Retrieve all parent categories for a specific product
Leaf level categories are first, then their parents.
Returns all parent category Ids for a specific product
Leaf level categories are first, then their parents.
Deletes a record from the database
Parameters:
- $iProductCategoryId
int unsigned
A record's product_category_id
Return
Returns true if record existed and was deleted, otherwise false
Returns the child categories of a given category
Useful to retrieve product sub-categories and display them using a repeater.
Returns the recursive child categories of a given category
Useful to retrieve all product sub-categories and display them using a repeater.
Gets a single field from a record
Parameters:
- $iProductCategoryId
int unsigned
A record's product_category_id
Returns the number of records in the database (matching the filter if specified)
Retrieves a category from its page URI suffix
Retrieves the parent category of a specific entity
Returns all parent categories of a specific entity
Saves a record into the database
Saves a specific column of a row into a database
Parameters:
- $iProductCategoryId
int unsigned
A record's product_category_id
Return
Array of
Categories that match the search query.
