Menu
Home
Controls API
Components API
Tutorials
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\HTML\Bleacher
\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
delete()
get()
getAll()
getColumn()
getCount()
save()
saveColumn()
search()
Fields
\Components\Commerce\Configuration\
PaymentMethods::
Access and configure the different ways you accept payment.
Methods
Invoke via
\Components\Commerce\Configuration\PaymentMethods::method()
Click a method name to copy it.
bool
delete(
$iPaymentMethodId, $bDeleteMedia
)
Deletes a record from the database
Parameters
$iPaymentMethodId
int unsigned
A record's payment_method_id
$bDeleteMedia
mixed
Return
Returns true if record existed and was deleted, otherwise false
array
get(
$iPaymentMethodId
)
Gets a record from the database
Parameters
$iPaymentMethodId
int unsigned
A record's payment_method_id
Return
PaymentMethods
array
getAll(
$arrQuery
)
Return a set of records from the database
Parameters
$arrQuery
mixed
Return
Array of
PaymentMethods
mixed
getColumn(
$iPaymentMethodId, $strColumn
)
Gets a single field from a record
Parameters
$iPaymentMethodId
int unsigned
A record's payment_method_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
string|int
save(
$arrEntity
)
Saves a record into the database
Parameters
$arrEntity
mixed
Return
string|int
void
saveColumn(
$iPaymentMethodId, $strColumn, $strValue
)
Saves a specific column of a row into a database
Parameters
$iPaymentMethodId
int unsigned
A record's payment_method_id
$strColumn
mixed
$strValue
mixed
array
search(
$strSearch, $arrQuery
)
Performs a search
Parameters
$strSearch
mixed
$arrQuery
mixed
Return
Array of
PaymentMethods
that match the search query.
Database Fields
The following fields are used when retrieving and saving entities.
payment_method_id
int unsigned (10)
payment_method_class
string (127)
payment_method_title
string (255)
payment_method_is_enabled
0 or 1
payment_method_is_enabled_public
0 or 1
Default value: 1
payment_method_is_enabled_admin
0 or 1
Default value: 1
payment_method_configuration
string (16777215)
condition_id
int unsigned (10)
payment_method_order
int unsigned (10)