\Website\Posts\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
DESCRIPTION
METHODS
delete()
get()
getAll()
getAllForPost()
getChildren()
getColumn()
getCount()
getForPage()
save()
saveColumn()
search()
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 \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

Use this API to create, update and delete website post categories.

Methods

Invoke via \Components\Website\Posts\Categories::method()
Click a method name to copy it.
- ` bool delete($iPostCategoryId, $bDeleteMedia) `
Deletes a record from the database
Parameters:
- $iPostCategoryId
int unsigned
A record's post_category_id
- $bDeleteMedia
mixed
Return
Returns true if record existed and was deleted, otherwise false
- ` array get($iPostCategoryId) `
Gets a record from the database
Parameters:
- $iPostCategoryId
int unsigned
A record's post_category_id
Return
Categories
- ` array getAll($arrQuery) `
Return a set of records from the database
Parameters:
- $arrQuery
mixed
Return
Array of Categories
- ` array getAllForPost($iPostId, $bNoPrimary, $arrQuery) `
Returns all categories for a post
Parameters:
- $iPostId
mixed
- $bNoPrimary
mixed
- $arrQuery
mixed
Return
Array of Categories
- ` array getChildren($iId, $arrQuery) `
Returns the child categories of a given post category

Useful to retrieve post sub-categories and display them using a repeater.
Parameters:
- $iId
mixed
- $arrQuery
mixed
Return
Array of Categories
- ` mixed getColumn($iPostCategoryId, $strColumn) `
Gets a single field from a record
Parameters:
- $iPostCategoryId
int unsigned
A record's post_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 getForPage($strPageId) `
Returns a post category from its page / URL

For example, getForPage('/blog/') would return the blog category.
Parameters:
- $strPageId
mixed
Return
Categories
- ` string|int save($arrEntity) `
Saves a record into the database
Parameters:
- $arrEntity
mixed
Return
string|int
- ` void saveColumn($iPostCategoryId, $strColumn, $strValue) `
Saves a specific column of a row into a database
Parameters:
- $iPostCategoryId
int unsigned
A record's post_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:
- `post_category_id`
int unsigned (10)
- `post_category_parent_id`
int unsigned (10)
- `post_category_title`
string (63)
- `post_category_is_primary`
0 or 1
Default value: 1
- `post_category_order`
int unsigned (10)
- `post_count`
int unsigned (10)
- `page_id`
string (255)