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\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
generatePDF()
get()
getAll()
getAllForContact()
getColumn()
getCount()
getCountForContact()
getTotalsSales()
save()
saveColumn()
search()
delete()
Fields

\Components\Commerce\Sales::

Access and create sales / invoices.

Methods

Invoke via \Components\Commerce\Sales::method()
Click a method name to copy it.
string generatePDF($arrSaleIds, $bAdmin, $bWeb, $bPrint)
Generates an invoice from a sale
Parameters
$arrSaleIds
int|array
$bAdmin
bool
$bWeb
bool
$bPrint
bool
Return
PDF
array get($iSaleId)
Gets a record from the database
Parameters
$iSaleId
int unsigned
A record's sale_id
Return
Sales
array getAll($arrQuery)
Return a set of records from the database
Parameters
$arrQuery
array|null
Query Array
Return
Array of Sales
array getAllForContact($iContactId, $arrQuery)
Returns all sales for a particular contact
Parameters
$iContactId
int
$arrQuery
array|null
Query Array
Return
Array of Sales.
mixed getColumn($iSaleId, $strColumn)
Gets a single field from a record
Parameters
$iSaleId
int unsigned
A record's sale_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 getCountForContact($iContactId, $arrFilter)
Returns the number of sales for a contact
Parameters
$iContactId
int
$arrFilter
array
Return
int
float getTotalsSales($arrFilter)
Returns total sales, grouped by currency
Parameters
$arrFilter
array
Return
float
int unsigned save($arrEntity)
Saves a record into the database
Parameters
$arrEntity
array
Return
The record's sale_id
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
string
$strValue
string
array search($strSearch, $arrQuery)
Performs a search
Parameters
$strSearch
string
Search query
$arrQuery
array|null
Query Array
Return
Array of Sales that match the search query.
bool delete($iSaleId, $bDeleteMedia)
Deletes a record from the database
Parameters
$iSaleId
int unsigned
A record's sale_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.
sale_id
int unsigned (10)
sale_invoice_id
string (255)
sale_type
Default value: sale
sale_datetime
datetime
Default value: 0000-00-00 00:00:00
sale_updated_datetime
datetime
sale_title
string (255)
sale_comments
string (65535)
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
sale_shipping_method_id
int (11)
sale_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)
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 (8)
contact_state
string (127)
contact_country_id
char (3)
contact_phone_home
string (31)
contact_phone_work
string (31)
contact_phone_mobile
string (31)
contact_fax
string (31)
administrator_id
int (11)
affiliate_id
int unsigned (10)
sale_adjustment_parent_id
int unsigned (10)
sale_adjustment_reason_class_id
string (255)