Templating
Global Functions
Website
\Components\Website\Designs \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\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 \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\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
Description
Methods
get()
getAll()
getAllForProduct()
getAllIdsForProduct()
getAllRecursiveForProduct()
getAllRecursiveIdsForProduct()
getByProductCategoryTitle()
getChildren()
getColumn()
getCount()
getFromPageURI()
getParentsRecursive()
save()
saveColumn()
search()
delete()
Fields

\Components\Commerce\Products\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.
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
array|null
Query Array
Return
Array of Categories
array getAllForProduct($iProductId)
Returns all categories for a specific product
Parameters
$iProductId
int
Return
Array of Categories
array getAllIdsForProduct($iProductId)
Returns all category Ids for a specific product
Parameters
$iProductId
int
Return
array
array getAllRecursiveForProduct($iProductId)
Retrieve all parent categories for a specific product
Parameters
$iProductId
int
Return
array
array getAllRecursiveIdsForProduct($iProductId)
Returns all parent category Ids for a specific product
Parameters
$iProductId
int
Return
array
array getByProductCategoryTitle($strTitle)
Returns an entity
Parameters
$strTitle
mixed
Return
Entity
void getChildren($iId, $arrQuery)
Parameters
$iId
mixed
$arrQuery
mixed
mixed getColumn($iProductCategoryId, $strColumn)
Gets a single field from a record
Parameters
$iProductCategoryId
int unsigned
A record's product_category_id
$strColumn
string
Return
mixed
int getCount($arrFilter)
Returns the number of records in the database (matching the filter if specified)
Parameters
$arrFilter
array|null
Filter Array
Return
int
array getFromPageURI($strPageURI)
Retrieves a category from its page URI suffix
Parameters
$strPageURI
string
Return
Categories
array getParentsRecursive($iEntityId)
Returns all parent categories of a specific entity
Parameters
$iEntityId
int
Return
array
int unsigned save($arrEntity)
Saves a record into the database
Parameters
$arrEntity
array
Return
The record's product_category_id
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
string
$strValue
string
array search($strSearch, $arrQuery)
Performs a search
Parameters
$strSearch
string
Search query
$arrQuery
array|null
Query Array
Return
Array of Categories that match the search query.
bool delete($iProductCategoryId, $bDeleteMedia)
Deletes a record from the database
Parameters
$iProductCategoryId
int unsigned
A record's product_category_id
$bDeleteMedia
bool
Return
Returns true if record existed and was deleted, otherwise false

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 (65535)
product_category_icon
string (255)
product_category_content
string (65535)
product_category_is_offline
0 or 1
product_category_group_visibility
string (65535)
product_category_group_visibility_inherited
string (65535)
product_category_uri_suffix
string (255)
product_category_uri_suffix_is_overridden
0 or 1
product_category_search_keywords
string (255)
product_category_parent_id
int unsigned (11)
product_count
int unsigned (11)