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
Methods

\Components\Commerce\Affiliates\Payments::

Records of when payouts have occurred to affiliates.

Methods

Invoke via \Components\Commerce\Affiliates\Payments::method()
Click a method name to copy it.
array get($iAffiliatePaymentId)
Gets a record from the database
Parameters
$iAffiliatePaymentId
int unsigned
A record's affiliate_payment_id
Return
array getAll($arrQuery)
Return a set of records from the database
Parameters
$arrQuery
array|null
Return
Array of Payments
array getAllForAffiliate($iAffiliateId, $arrQuery)
Returns all payments for an affiliate
Parameters
$iAffiliateId
int
Affiliate id
$arrQuery
array|null
Return
Array of Payments
mixed getColumn($iAffiliatePaymentId, $strColumn)
Gets a single field from a record
Parameters
$iAffiliatePaymentId
int unsigned
A record's affiliate_payment_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
Return
int
int unsigned save($arrEntity)
Saves a record into the database
Parameters
$arrEntity
array
Return
The record's affiliate_payment_id
void saveColumn($iAffiliatePaymentId, $strColumn, $strValue)
Saves a specific column of a row into a database
Parameters
$iAffiliatePaymentId
int unsigned
A record's affiliate_payment_id
$strColumn
string
$strValue
string
array search($strSearch, $arrQuery)
Performs a search
Parameters
$strSearch
string
Search query
$arrQuery
array|null
Return
Array of Payments that match the search query.
bool delete($iAffiliatePaymentId, $bDeleteMedia)
Deletes a record from the database
Parameters
$iAffiliatePaymentId
int unsigned
A record's affiliate_payment_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_payment_id
int unsigned (10)
affiliate_payment_status
Default value: requested
affiliate_payment_date
datetime
Default value: 0000-00-00 00:00:00
affiliate_payment_bank_details
string (255)
affiliate_payment_transaction_id
string (127)
affiliate_payment_amount
decimal (8,2)
Default value: 0.00
affiliate_id
int unsigned (10)