\Commerce\Products\Categories
Templating
Global Functions
Website
\Components\Website\Designs \Components\Website\Media \Components\Website\Pages \Components\Website\Pages\Forms \Components\Website\Posts \Components\Website\Posts\Categories
Customers
\Components\Customers\Contacts \Components\Customers\Contacts\Relationships \Components\Customers\Contacts\Relationships\Types \Components\Customers\Groups
Marketing
\Components\Marketing\EmailMarketing \Components\Marketing\Events \Components\Marketing\Events\Attendees \Components\Marketing\Events\Categories \Components\Marketing\Events\Locations
Commerce
\Components\Commerce\Carts \Components\Commerce\Carts\Current \Components\Commerce\Configuration\PaymentMethods \Components\Commerce\Configuration\ShippingMethods \Components\Commerce\Discounts \Components\Commerce\Products \Components\Commerce\Products\Brands \Components\Commerce\Products\Categories
DESCRIPTION
METHODS
delete()
get()
getAll()
getAllForProduct()
getAllIdsForProduct()
getAllRecursiveForProduct()
getAllRecursiveIdsForProduct()
getChildren()
getChildrenRecursive()
getColumn()
getCount()
getFromPageURI()
getParent()
getParentsRecursive()
save()
saveColumn()
search()
\Components\Commerce\Products\Inventory \Components\Commerce\Sales \Components\Commerce\Sales\Items \Components\Commerce\Sales\Receipts \Components\Commerce\Sales\Receipts\Allocations
Settings
\Components\Settings\Administrators \Components\Settings\CustomFields \Components\Settings\Domains
Other Apps
\Components\Website\Comments \Components\Commerce\Affiliates \Components\Commerce\Affiliates\Administrators \Components\Commerce\Affiliates\Commissions \Components\Commerce\Affiliates\Payments \Components\Commerce\RecurringSales \Components\Commerce\RecurringSales\StoredCards
Framework
\Framework\Caching \Framework\Data\Util \Framework\DOM\CurrentContext \Framework\HTML\Converters \Framework\HTTP\Cookies \Framework\HTTP\Redirection \Framework\HTTP\Request \Framework\HTTP\Session \Framework\HTTP\UserAgent \Framework\I18N\CompanyTypes \Framework\I18N\Countries \Framework\I18N\Languages \Framework\Network\GeoIP

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.
- ` bool delete($iProductCategoryId, $bDeleteMedia) `
Deletes a record from the database
Parameters:
- $iProductCategoryId
int unsigned
A record's product_category_id
- $bDeleteMedia
mixed
Return
Returns true if record existed and was deleted, otherwise false
- ` array get($iProductCategoryId) `
Gets a record from the database
Parameters:
- $iProductCategoryId
int unsigned
A record's product_category_id
Return
Categories
- ` array getAll($arrQuery) `
Return a set of records from the database
Parameters:
- $arrQuery
mixed
Return
Array of Categories
- ` array getAllForProduct($iProductId, $arrQuery) `
Returns all categories for a specific product
Parameters:
- $iProductId
mixed
- $arrQuery
mixed
Return
Array of Categories
- ` array getAllIdsForProduct($iProductId) `
Returns all category Ids for a specific product
Parameters:
- $iProductId
mixed
Return
array
- ` array getAllRecursiveForProduct($iProductId) `
Retrieve all parent categories for a specific product

Leaf level categories are first, then their parents.
Parameters:
- $iProductId
mixed
Return
array
- ` array getAllRecursiveIdsForProduct($iProductId) `
Returns all parent category Ids for a specific product

Leaf level categories are first, then their parents.
Parameters:
- $iProductId
mixed
Return
array
- ` array getChildren($iId, $arrQuery) `
Returns the child categories of a given category

Useful to retrieve product sub-categories and display them using a repeater.
Parameters:
- $iId
mixed
- $arrQuery
mixed
Return
Array of Categories
- ` array getChildrenRecursive($iId, $arrQuery) `
Returns the recursive child categories of a given category

Useful to retrieve all product sub-categories and display them using a repeater.
Parameters:
- $iId
mixed
- $arrQuery
mixed
Return
Array of Categories
- ` mixed getColumn($iProductCategoryId, $strColumn) `
Gets a single field from a record
Parameters:
- $iProductCategoryId
int unsigned
A record's product_category_id
- $strColumn
mixed
Return
mixed
- ` int getCount($arrFilter) `
Returns the number of records in the database (matching the filter if specified)
Parameters:
- $arrFilter
mixed
Return
int
- ` array getFromPageURI($strPageURI) `
Retrieves a category from its page URI suffix
Parameters:
- $strPageURI
mixed
Return
Categories
- ` array|null getParent($iEntityId) `
Retrieves the parent category of a specific entity
Parameters:
- $iEntityId
mixed
Return
array|null
- ` array getParentsRecursive($iEntityId) `
Returns all parent categories of a specific entity
Parameters:
- $iEntityId
mixed
Return
array
- ` string|int save($arrEntity) `
Saves a record into the database
Parameters:
- $arrEntity
mixed
Return
string|int
- ` void saveColumn($iProductCategoryId, $strColumn, $strValue) `
Saves a specific column of a row into a database
Parameters:
- $iProductCategoryId
int unsigned
A record's product_category_id
- $strColumn
mixed
- $strValue
mixed
- ` array search($strSearch, $arrQuery) `
Performs a search
Parameters:
- $strSearch
mixed
- $arrQuery
mixed
Return
Array of Categories that match the search query.

Database Fields

The following fields are used when retrieving and saving entities:
- `product_category_id`
int unsigned (11)
- `product_category_title`
string (127)
- `product_category_created_datetime`
datetime
- `product_category_modified_datetime`
datetime
- `product_category_order`
int (11)
- `product_category_description`
string (16777215)
- `product_category_icon`
string (255)
- `product_category_content`
string (16777215)
- `product_category_is_offline`
0 or 1
- `product_category_group_visibility`
string (16777215)
- `product_category_group_visibility_inherited`
string (16777215)
- `product_category_uri_suffix`
string (255)
- `product_category_uri_suffix_is_overridden`
0 or 1
- `product_category_search_keywords`
string (255)
- `product_category_search_title`
string (255)
- `product_category_search_title_is_overridden`
0 or 1
- `product_category_parent_id`
int unsigned (11)
- `product_count`
int unsigned (11)