Components \ commerce \ affiliates administrators commissions payments \ configuration paymentmethods \ shippingmethods \ methods delivery discounts \ products brands categories \ recurringsales storedcards \ sales items \ receipts allocations \ customers \ contacts passwords referrertypes \ relationships types \ groups contacts \ marketing \ emailmarketing \ sends contacts unsubscribers \ events attendees locations \ reminders \ automation eventremindertrigger \ settings administrators components configurationitems cpanel customfields \ developer scheduledtasks threads domains \ website \ analytics sessions comments \ designs generator media pages \ posts categories Framework \ architecture publicassets \ assets css javascript \ caching filebased \ components textualids \ data util \ database mainconnection date \ dom currentcontext renderer \ html converters highlighter javascript \ http redirection request session useragent \ i18n companytypes countries languages \ network cidr dns geoip random \ reflection api \ system filenames filesystem toasts
.
.
.
quick access
\ methods

\Components\Commerce\Products\Categories::

Access, create, update and delete the categories of products that you sell online.

Class Methods

The following static methods are available on this class:
string configGetValue($strConfigId)
Description
Retrieves the value of a config item for the current component
Parameters
$strConfigId
string
Return
Config item value
bool delete($strKeyValue, $bDeleteMedia, $strReason)
Description
Deletes an entity and triggers the pre/post component events
Parameters
$strKeyValue
string
$bDeleteMedia
bool
$strReason
mixed
Return
bool
array get($strKey)
Description
Returns an entity
Parameters
$strKey
mixed
Value of the primary key
Return
{Array} getAll($arrProperties)
Description
Return all entities in the database.
Parameters
$arrProperties
mixed
Return
Array of Categories
array getAllForProduct($iProductId)
Description
Returns all categories for a specific product
Parameters
$iProductId
int
Return
array
array getAllRecursiveForProduct($iProductId)
Description
Retrieve all parent categories for a specific product
Parameters
$iProductId
int
Return
array
array getByProductCategoryTitle($strTitle)
Description
Returns an entity
Parameters
$strTitle
mixed
Return
Entity
void getChildren($iId, $arrProperties)
Description
Parameters
$iId
mixed
$arrProperties
mixed
Return
void
mixed getColumn($strKey, $strColumn)
Description
Returns a single column of an entity
Parameters
$strKey
string
$strColumn
string
Return
mixed
int getCount($arrFilter)
Description
Returns a count of all rows in the data adapter
Parameters
$arrFilter
array
Return
int
void getFromPageURI($strPageURI)
Description
Retrieves a category from its page URI suffix
Parameters
$strPageURI
string
Return
void
array getParentsRecursive($iEntityId)
Description
Returns all parent categories of a specific entity
Parameters
$iEntityId
int
Return
array
string mediaFolderGet($strKey)
Description
Returns the media folder for this data adapter
Parameters
$strKey
mixed
Return
Folder
mixed save($arrEntity, $strReason)
Description
Saves an entity and triggers the pre/post component events
Parameters
$arrEntity
array
$strReason
string
Return
mixed
mixed saveColumn($strKeyValue, $strColumn, $strValue, $strReason)
Description
Changes a column of an existing entity Supports primary keys spanning on several columns if passing $strKeyValue as an associative arry
Parameters
$strKeyValue
string
$strColumn
string
$strValue
string
$strReason
string
Return
Id
array search($strSearch, $arrProperties)
Description
Performs a search
Parameters
$strSearch
string
$arrProperties
mixed
Return
array

Database Fields

The following fields are used when retrieving and saving entities.
product_category_content
text
product_category_created_datetime
datetime
product_category_description
text
product_category_group_visibility
text
product_category_group_visibility_inherited
text
product_category_icon
varchar (127)
product_category_id
int unsigned (11)
product_category_is_offline
tinyint unsigned (1)
product_category_modified_datetime
datetime
product_category_order
int (11)
product_category_parent_id
int unsigned (11)
product_category_search_keywords
varchar (255)
product_category_title
varchar (127)
product_category_uri_suffix
varchar (255)
product_category_uri_suffix_is_overriden
tinyint unsigned (1)
product_category_xero_account
varchar (255)