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\Configuration\ShippingMethods::

Configure how you will deliver your products to your customers.

Methods

Invoke via \Components\Commerce\Configuration\ShippingMethods::method()
Click a method name to copy it.
array get($iShippingMethodId)
Gets a record from the database
Parameters
$iShippingMethodId
int unsigned
A record's shipping_method_id
array getAll($arrQuery)
Return a set of records from the database
Parameters
$arrQuery
array|null
Return
Array of ShippingMethods
array getAllEnabledAndValidForCurrentCart($arrQuery)
Returns only shipping methods that are valid for the current shopping cart
Parameters
$arrQuery
array|null
Return
array
array getAllEnabledWithConfig($arrQuery)
Returns all enabled shipping methods with unserialized configuration items
Parameters
$arrQuery
mixed
Return
Array of ShippingMethods
mixed getColumn($iShippingMethodId, $strColumn)
Gets a single field from a record
Parameters
$iShippingMethodId
int unsigned
A record's shipping_method_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 shipping_method_id
void saveColumn($iShippingMethodId, $strColumn, $strValue)
Saves a specific column of a row into a database
Parameters
$iShippingMethodId
int unsigned
A record's shipping_method_id
$strColumn
string
$strValue
string
array search($strSearch, $arrQuery)
Performs a search
Parameters
$strSearch
string
Search query
$arrQuery
array|null
Return
Array of ShippingMethods that match the search query.
bool delete($iShippingMethodId, $bDeleteMedia)
Deletes a record from the database
Parameters
$iShippingMethodId
int unsigned
A record's shipping_method_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.
shipping_method_id
int unsigned (10)
shipping_method_class
string (127)
shipping_method_title
string (255)
shipping_method_is_enabled
0 or 1
shipping_method_configuration
string (65535)
shipping_method_pricing_class
string (127)
shipping_method_pricing_configuration
string (65535)
shipping_method_order
int unsigned (10)