Menu
Home
Controls API
Components API
Tutorials
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()
getColumn()
getCount()
save()
saveColumn()
search()
delete()
Fields
\Components\Commerce\Affiliates\
Commissions::
Recorded commission values for affiliates over time.
Methods
Invoke via
\Components\Commerce\Affiliates\Commissions::method()
Click a method name to copy it.
array
get(
$iAffiliateCommissionId
)
Gets a record from the database
Parameters
$iAffiliateCommissionId
int
A record's affiliate_commission_id
Return
Commissions
array
getAll(
$arrQuery
)
Return a set of records from the database
Parameters
$arrQuery
array|null
Query Array
Return
Array of
Commissions
mixed
getColumn(
$iAffiliateCommissionId, $strColumn
)
Gets a single field from a record
Parameters
$iAffiliateCommissionId
int
A record's affiliate_commission_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
int
save(
$arrEntity
)
Saves a record into the database
Parameters
$arrEntity
array
Return
The record's affiliate_commission_id
void
saveColumn(
$iAffiliateCommissionId, $strColumn, $strValue
)
Saves a specific column of a row into a database
Parameters
$iAffiliateCommissionId
int
A record's affiliate_commission_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
Commissions
that match the search query.
bool
delete(
$iAffiliateCommissionId, $bDeleteMedia
)
Deletes a record from the database
Parameters
$iAffiliateCommissionId
int
A record's affiliate_commission_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.
affiliate_commission_id
int (11)
affiliate_commission_date
datetime
affiliate_commission_fixed
decimal unsigned (8,2)
affiliate_commission_percent
decimal unsigned (8,2)
affiliate_commission_include_tax
0 or 1
Default value: 1
affiliate_commission_entity_type
affiliate_commission_entity_id
int (11)
affiliate_commission_value
decimal (8,2)
Default value: 0.00
affiliate_id
int (11)
affiliate_commission_parent_id
int (11)