Components \ commerce \ affiliates administrators commissions payments \ configuration paymentmethods \ shippingmethods \ methods delivery discounts \ products brands categories \ recurringsales storedcards \ sales items \ receipts allocations \ customers \ contacts passwords referrertypes \ relationships types \ groups contacts \ marketing \ emailmarketing \ sends contacts unsubscribers \ events attendees locations \ reminders \ automation eventremindertrigger \ settings administrators components configurationitems cpanel customfields \ developer scheduledtasks threads domains \ website \ analytics sessions comments \ designs generator media pages \ posts categories Framework \ architecture publicassets \ assets css javascript \ caching filebased \ components textualids \ data util \ database mainconnection date \ dom currentcontext renderer \ html converters highlighter javascript \ http redirection request session useragent \ i18n companytypes countries languages \ network cidr dns geoip random \ reflection api \ system filenames filesystem toasts
.
.
.
quick access
\ methods

\Components\Commerce\Sales::

Access and create sales / invoices.

Class Methods

The following static methods are available on this class:
string configGetValue($strConfigId)
Description
Retrieves the value of a config item for the current component
Parameters
$strConfigId
string
Return
Config item value
bool delete($strKeyValue, $bDeleteMedia, $strReason)
Description
Deletes an entity and triggers the pre/post component events
Parameters
$strKeyValue
string
$bDeleteMedia
bool
$strReason
mixed
Return
bool
string generatePDF($arrSaleIds, $bAdmin, $bWeb, $bPrint)
Description
Generates an invoice from a sale
Parameters
$arrSaleIds
int|array
$bAdmin
bool
$bWeb
bool
$bPrint
bool
Return
PDF
array get($strKey)
Description
Returns an entity
Parameters
$strKey
mixed
Value of the primary key
Return
{Array} getAll($arrProperties)
Description
Return all entities in the database.
Parameters
$arrProperties
mixed
Return
Array of Sales
array getAllForContact($iContactId, $arrProperties)
Description
Returns all sales for a particular contact
Parameters
$iContactId
int
$arrProperties
array
Return
Array of Sales.
mixed getColumn($strKey, $strColumn)
Description
Returns a single column of an entity
Parameters
$strKey
string
$strColumn
string
Return
mixed
int getCount($arrFilter)
Description
Returns a count of all rows in the data adapter
Parameters
$arrFilter
array
Return
int
int getCountForContact($iContactId, $arrFilter)
Description
Returns the number of sales for a contact
Parameters
$iContactId
int
$arrFilter
array
Return
int
float getTotalsSales($arrFilter)
Description
Returns total sales, grouped by currency
Parameters
$arrFilter
array
Return
float
string mediaFolderGet($strKey)
Description
Returns the media folder for this data adapter
Parameters
$strKey
mixed
Return
Folder
mixed save($arrEntity, $strReason)
Description
Saves an entity and triggers the pre/post component events
Parameters
$arrEntity
array
$strReason
string
Return
mixed
mixed saveColumn($strKeyValue, $strColumn, $strValue, $strReason)
Description
Changes a column of an existing entity Supports primary keys spanning on several columns if passing $strKeyValue as an associative arry
Parameters
$strKeyValue
string
$strColumn
string
$strValue
string
$strReason
string
Return
Id
array search($strSearch, $arrProperties)
Description
Performs a search
Parameters
$strSearch
string
$arrProperties
mixed
Return
array

Database Fields

The following fields are used when retrieving and saving entities.
administrator_id
int (11)
affiliate_id
int unsigned (10)
contact_address
varchar (127)
contact_company
varchar (127)
contact_company_number
varchar (127)
contact_company_number_type
enum ('ABN','ACN','CIK','Company No','SIRET','SIREN')
contact_country_id
char (3)
contact_email
varchar (127)
contact_fax
varchar (31)
contact_first_name
varchar (63)
contact_id
int (10)
contact_last_name
varchar (63)
contact_phone_home
varchar (31)
contact_phone_mobile
varchar (31)
contact_phone_work
varchar (31)
contact_postcode
varchar (8)
contact_state
varchar (127)
contact_suburb_city
varchar (127)
contact_type
enum ('Individual','Company')
Default value: Individual
payment_method_id
int unsigned (10)
recurring_sale_id
int (11)
sale_account_id
int (11)
sale_adjustment_parent_id
int unsigned (10)
sale_adjustment_reason_class_id
varchar (255)
sale_billing_type
enum ('','Client','Reseller')
sale_comments
text
sale_country_id
varchar (3)
Default value: AUS
sale_currency_id
varchar (3)
Default value: AUD
sale_datetime
datetime
Default value: 0000-00-00 00:00:00
sale_id
int unsigned (10)
sale_invoice_id
varchar (255)
sale_month
date
sale_month_end
date
sale_receipt_balance
decimal (10,4)
sale_receipt_status
enum ('unpaid','partial','paid','overpaid')
Default value: unpaid
sale_shipping_administrator_id
int (11)
sale_shipping_company_id
int (11)
sale_shipping_consignment_number
varchar (255)
sale_shipping_datetime
datetime
sale_shipping_method_data
text
sale_shipping_method_id
int (11)
sale_shipping_status
varchar (255)
sale_tax_label
varchar (15)
sale_title
varchar (255)
sale_total
decimal (10,4)
Default value: 0.0000
sale_total_tax
decimal (16,10)
Default value: 0.0000000000
sale_type
enum ('sale','adjustment')
Default value: sale
sale_updated_datetime
datetime
sale_website_id
int (11)
sale_xero_id
varchar (255)
sale_xero_was_remote_origin
int (11)