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 \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\Bleacher \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
delete()
get()
getAll()
getAllForCategory()
getColumn()
getCount()
getFromPageURI()
save()
saveColumn()
search()
Fields

\Components\Commerce\Products\Brands::

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

Methods

Invoke via \Components\Commerce\Products\Brands::method()
Click a method name to copy it.
bool delete($tProductBrandId, $bDeleteMedia)
Deletes a record from the database
Parameters
$tProductBrandId
tinyint unsigned
A record's product_brand_id
$bDeleteMedia
bool
Return
Returns true if record existed and was deleted, otherwise false
array get($tProductBrandId)
Gets a record from the database
Parameters
$tProductBrandId
tinyint unsigned
A record's product_brand_id
Return
Brands
array getAll($arrQuery)
Return a set of records from the database
Parameters
$arrQuery
array|null
Query Array
Return
Array of Brands
array getAllForCategory($arrCategoryIds, $arrQuery)
Returns all brands for a given category
Parameters
$arrCategoryIds
array|int
$arrQuery
mixed
Return
Result set
mixed getColumn($tProductBrandId, $strColumn)
Gets a single field from a record
Parameters
$tProductBrandId
tinyint unsigned
A record's product_brand_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 brand from its page URI suffix
Parameters
$strPageURI
string
Return
Brands
string|int save($arrEntity)
Saves a record into the database
Parameters
$arrEntity
mixed
Return
string|int
void saveColumn($tProductBrandId, $strColumn, $strValue)
Saves a specific column of a row into a database
Parameters
$tProductBrandId
tinyint unsigned
A record's product_brand_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 Brands that match the search query.

Database Fields

The following fields are used when retrieving and saving entities.
product_brand_id
tinyint unsigned (4)
product_brand_title
string (127)
product_brand_description
string (16777215)
product_brand_order
int (11)
product_brand_icon
string (255)
product_brand_url
string (255)
product_brand_content
string (16777215)
product_brand_is_offline
0 or 1
product_brand_uri_suffix
string (255)
product_brand_uri_suffix_is_overridden
0 or 1
product_brand_search_keywords
string (255)
product_count
int unsigned (11)