\Commerce\Sales
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 \Components\Marketing\Events\Recurring \Components\Marketing\Events\Recurring\Rules \Components\Marketing\SMSMarketing
Commerce
\Components\Commerce\Carts \Components\Commerce\Carts\Current \Components\Commerce\Discounts \Components\Commerce\Products \Components\Commerce\Products\Brands \Components\Commerce\Products\Categories \Components\Commerce\Products\Inventory \Components\Commerce\RecurringSales\Items \Components\Commerce\Sales
METHODS
\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\DOM\CurrentContext \Framework\HTML\Converters \Framework\HTTP\Cookies \Framework\HTTP\Redirection \Framework\HTTP\Request \Framework\HTTP\Session \Framework\HTTP\TabState \Framework\HTTP\UserAgent \Framework\I18N\CompanyTypes \Framework\I18N\Countries \Framework\I18N\Languages

Sales

Access and create sales / invoices.

Methods

Invoke via \Components\Commerce\Sales::method()
Click a method name to copy it.
- ` \Iterator dbGetAllIterable($arrQuery) `
Returns the raw rows dbGetAll() would return as an iterator, without building them all into an array

The dbGetAll() counterpart of getAllIterable(), for scans over every stored row of a large table (eg: the site-wide content scans in \Framework\Developer\Refactoring). Rows are as stored - JSON fields are not decoded - and are not entity-cached. Because it bypasses getAll(), components that override getAll() are iterated; search queries and components overriding dbGetAll() are refused.
Parameters:
- $arrQuery
mixed
Return
Yields Sales
- ` array fieldsGetAll($bCached) `
Returns all the columns this component supports
Parameters:
- $bCached
mixed
Return
array
- ` string generatePDF($arrSaleIds, $bAdmin, $bWeb, $bPrint) `
Generates an invoice from a sale
Parameters:
- $arrSaleIds
mixed
- $bAdmin
mixed
- $bWeb
mixed
- $bPrint
mixed
Return
PDF
- ` array get($iSaleId) `
Gets a record from the database
Parameters:
- $iSaleId
int unsigned
A record's sale_id
Return
- ` array getAll($arrQuery) `
Return a set of records from the database
Parameters:
- $arrQuery
mixed
Return
Array of Sales
- ` array getAllForContact($iContactId, $arrQuery) `
Returns all sales for a particular contact
Parameters:
- $iContactId
mixed
- $arrQuery
mixed
Return
Array of Sales.
- ` \Iterator getAllIterable($arrQuery) `
Returns the entities getAll() would return as an iterator, without building them all into an array

For result sets too large to hold as arrays (eg: every recipient of a marketing send) - only the database driver's compact buffer of the result is held, a fraction of getAll()'s memory. Runs the same SQL as getAll(), and runs it now, as getAll() would; rows are decoded as you iterate.
Search queries are not supported, rows are not entity-cached, and components that override getAll() or dbGetAll() (eg: merging in defaults) are refused rather than iterated without their extra rows.
Parameters:
- $arrQuery
mixed
Return
Yields Sales
- ` mixed getColumn($iSaleId, $strColumn) `
Gets a single field from a record
Parameters:
- $iSaleId
int unsigned
A record's sale_id
- $strColumn
mixed
Return
mixed
- ` int getCount($arrFilter) `
Returns the number of records in the database (matching the filter if specified)
Parameters:
- $arrFilter
mixed
Return
int
- ` int getCountForContact($iContactId, $arrFilter) `
Returns the number of sales for a contact
Parameters:
- $iContactId
mixed
- $arrFilter
mixed
Return
int
- ` bool delete($iSaleId, $bDeleteMedia) `
Deletes a record from the database
Parameters:
- $iSaleId
int unsigned
A record's sale_id
- $bDeleteMedia
mixed
Return
Returns true if record existed and was deleted, otherwise false
- ` array getShippingData($arrSale) `
Returns a sale's shipping details as an array

shipping_method_data is null for a sale without shipping; templates that unserialize() it directly raise a PHP 8.1 deprecation on every such invoice.
Parameters:
- $arrSale
mixed
Return
array
- ` float getTotalsSales($arrFilter) `
Returns total sales, grouped by currency
Parameters:
- $arrFilter
mixed
Return
float
- ` string|int save($arrEntity) `
Saves a record into the database
Parameters:
- $arrEntity
mixed
Return
string|int
- ` void saveColumn($iSaleId, $strColumn, $strValue) `
Saves a specific column of a row into a database
Parameters:
- $iSaleId
int unsigned
A record's sale_id
- $strColumn
mixed
- $strValue
mixed
- ` array search($strSearch, $arrQuery) `
Performs a search
Parameters:
- $strSearch
mixed
- $arrQuery
mixed
Return
Array of Sales that match the search query.

Database Fields

The following fields are used when retrieving and saving entities:
- `sale_id`
int unsigned (10)
- `checkout_attempt_id`
string (36)
- `sale_checkout_attempt_data`
string (16777215)
- `sale_invoice_id`
string (255)
- `sale_type`
Default value: sale
- `sale_datetime`
datetime
Default value: current_timestamp()
- `sale_updated_datetime`
datetime
- `sale_title`
string (255)
- `sale_comments`
string (16777215)
- `sale_currency_id`
string (3)
Default value: AUD
- `sale_country_id`
string (3)
Default value: AUS
- `sale_tax_label`
string (15)
- `sale_total_tax`
decimal (16,10)
Default value: 0.0000000000
- `sale_total`
decimal (10,4)
Default value: 0.0000
- `sale_receipt_status`
Default value: unpaid
- `sale_receipt_balance`
decimal (10,4)
- `sale_receipt_rounding`
decimal (10,4)
Default value: 0.0000
- `shipping_method_id`
int (11)
- `shipping_method_data`
string (65535)
- `sale_created_at_url`
string (255)
- `sale_created_by_ip_address`
string (40)
- `sale_view_token`
string (32)
- `payment_method_id`
int unsigned (10)
- `sale_shipping_status`
string (255)
- `sale_shipping_datetime`
datetime
- `sale_shipping_administrator_id`
int (11)
- `sale_shipping_consignment_number`
string (255)
- `sale_shipping_company_id`
int (11)
- `sale_surcharge_data`
string (16777215)
- `contact_id`
int (10)
- `contact_type`
Default value: Individual
- `contact_company`
string (127)
- `contact_company_number_type`
- `contact_company_number`
string (127)
- `contact_first_name`
string (63)
- `contact_last_name`
string (63)
- `contact_email`
string (127)
- `contact_address`
string (127)
- `contact_suburb_city`
string (127)
- `contact_postcode`
string (16)
- `contact_state`
string (127)
- `contact_country_id`
char (3)
- `contact_phone_home`
string (31)
- `contact_phone_work`
string (31)
- `contact_phone_mobile`
string (31)
- `sale_created_by_contact_id`
int (11)
- `administrator_id`
int (11)
- `affiliate_id`
int unsigned (10)
- `sale_adjustment_parent_id`
int unsigned (10)
- `sale_adjustment_reason_class_id`
string (255)
- `analytics_session_id`
int unsigned (10)