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

\Components\Commerce\Affiliates::

Create, update and delete affiliates.

Methods

Invoke via \Components\Commerce\Affiliates::method()
Click a method name to copy it.
array currentGetAffiliation()
Returns the current affiliation
Return
Affiliate
array get($iAffiliateId)
Gets a record from the database
Parameters
$iAffiliateId
int unsigned
A record's affiliate_id
Return
Affiliates
array getAll($arrQuery)
Return a set of records from the database
Parameters
$arrQuery
array|null
Query Array
Return
Array of Affiliates
mixed getColumn($iAffiliateId, $strColumn)
Gets a single field from a record
Parameters
$iAffiliateId
int unsigned
A record's affiliate_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 unsigned save($arrEntity)
Saves a record into the database
Parameters
$arrEntity
array
Return
The record's affiliate_id
void saveColumn($iAffiliateId, $strColumn, $strValue)
Saves a specific column of a row into a database
Parameters
$iAffiliateId
int unsigned
A record's affiliate_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 Affiliates that match the search query.
bool delete($iAffiliateId, $bDeleteMedia)
Deletes a record from the database
Parameters
$iAffiliateId
int unsigned
A record's affiliate_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_id
int unsigned (10)
contact_id
int unsigned (10)
affiliate_title
string (255)
affiliate_url
string (255)
affiliate_payment_bank_details
string (255)
affiliate_is_active
0 or 1
Default value: 1
affiliate_deactivate_date
datetime
affiliate_sales_emails
string (255)
affiliate_code
string (127)
affiliate_length_type
Default value: session
affiliate_length_days
int unsigned (10)
affiliate_existing_contacts
0 or 1
affiliate_commission_visit
decimal unsigned (8,2)
affiliate_commission_contact
decimal unsigned (8,2)
affiliate_commission_sale_fixed
decimal unsigned (8,2)
affiliate_commission_sale_percent
decimal unsigned (8,2)
affiliate_cpnl
0 or 1
Default value: 1
affiliate_cpnl_statistics
0 or 1
Default value: 1
affiliate_cpnl_marketing
0 or 1
Default value: 1
affiliate_cpnl_profile
0 or 1
Default value: 1
affiliate_cpnl_visits
0 or 1
Default value: 1
affiliate_cpnl_contacts
0 or 1
affiliate_cpnl_sales
0 or 1
Default value: 1
affiliate_total_commission_contacts
decimal unsigned (8,2)
Default value: 0.00
affiliate_count_commission_contacts
int unsigned (10)
affiliate_total_commission_visits
decimal unsigned (8,2)
Default value: 0.00
affiliate_count_commission_visits
int unsigned (10)
affiliate_total_commission_sale_items
decimal unsigned (8,2)
Default value: 0.00
affiliate_count_commission_sale_items
int unsigned (10)
affiliate_total_commission
decimal unsigned (8,2)
Default value: 0.00
affiliate_total_payments
decimal unsigned (8,2)
Default value: 0.00
affiliate_total_unpaid
decimal (8,2)
Default value: 0.00