\Commerce\Sales\Items
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
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\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\UserAgent \Framework\I18N\CompanyTypes \Framework\I18N\Countries \Framework\I18N\Languages \Framework\Network\GeoIP

Items

The individual item lines within each sale.

Methods

Invoke via \Components\Commerce\Sales\Items::method()
Click a method name to copy it.
bool delete($iSaleItemId, $bDeleteMedia)
Deletes a record from the database
Parameters
$iSaleItemId
int unsigned
A record's sale_item_id
$bDeleteMedia
mixed
Return
Returns true if record existed and was deleted, otherwise false
array get($iSaleItemId)
Gets a record from the database
Parameters
$iSaleItemId
int unsigned
A record's sale_item_id
Return
Items
array getAll($arrQuery)
Return a set of records from the database
Parameters
$arrQuery
mixed
Return
Array of Items
array getAllForSale($iSaleId, $arrQuery)
Returns all items for a particular sale
Parameters
$iSaleId
mixed
$arrQuery
mixed
Return
Array of Items
mixed getColumn($iSaleItemId, $strColumn)
Gets a single field from a record
Parameters
$iSaleItemId
int unsigned
A record's sale_item_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
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 saveAllForSale($iSaleId, $arrItems)
Saves a new set of sales items for a sale
Parameters
$iSaleId
mixed
$arrItems
mixed
void saveColumn($iSaleItemId, $strColumn, $strValue)
Saves a specific column of a row into a database
Parameters
$iSaleItemId
int unsigned
A record's sale_item_id
$strColumn
mixed
$strValue
mixed
array search($strSearch, $arrQuery)
Performs a search
Parameters
$strSearch
mixed
$arrQuery
mixed
Return
Array of Items that match the search query.

Database Fields

The following fields are used when retrieving and saving entities.
sale_item_id
int unsigned (10)
sale_item_code
string (63)
sale_item_title
string (255)
sale_item_description
string (16777215)
sale_item_quantity
float
sale_item_price
decimal (10,4)
Default value: 0.0000
sale_item_price_overridden
0 or 1
sale_item_tax_percent
decimal (6,2)
Default value: 0.00
sale_item_total
decimal (10,4)
Default value: 0.0000
sale_item_total_tax
decimal (16,10)
Default value: 0.0000000000
sale_item_order_options
string (16777215)
sale_id
int unsigned (10)
product_id
int unsigned (10)
discount_id
int unsigned (10)
shipping_method_id
int (11)
adjustment_sale_id
int unsigned (10)
adjustment_item_uses_credit
0 or 1
sale_item_parent_id
int (10)
bought_for_contact_id
int (10)
sale_item_order_form_data
string (16777215)