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()
convertTo2Char()
get()
getAll()
getColumn()
getCount()
getStateTitlesFlat()
getTitle()
save()
saveColumn()
search()
Fields
\Framework\I18N\
Countries::
List of supported countries and working with their country codes.
Methods
Invoke via
\Framework\I18N\Countries::method()
Click a method name to copy it.
bool
delete(
$strKeyValue, $bDeleteMedia, $strReason
)
Deletes a record from the database
Parameters
$strKeyValue
mixed
$bDeleteMedia
mixed
$strReason
mixed
Return
Returns true if record existed and was deleted, otherwise false
string
convertTo2Char(
$strCountryId
)
Converts a 3 letter country id to an 2 letter country code
ISO 3166-1 alpha-3 to ISO 3166-1 alpha-2
Parameters
$strCountryId
mixed
Return
Country code
array
get(
$strKey
)
Return the current value
Parameters
$strKey
mixed
Return
array
array
getAll(
$arrQuery
)
Return a set of records from the database
Parameters
$arrQuery
mixed
Return
Array of
Countries
mixed
getColumn(
$strKey, $strColumn
)
Gets a single field from a record
Parameters
$strKey
mixed
$strColumn
mixed
Return
mixed
int
getCount(
$arrFilter
)
Parameters
$arrFilter
mixed
Return
int
void
getStateTitlesFlat(
$strCountryId
)
Returns a list of all states for a country
Parameters
$strCountryId
mixed
string
getTitle(
$strKey
)
Returns the name of the country from a country code
Parameters
$strKey
mixed
Return
Country title
string|int
save(
$arrEntity, $strReason
)
Saves a record into the database
Parameters
$arrEntity
mixed
$strReason
mixed
Return
string|int
void
saveColumn(
$strKeyValue, $strColumn, $strValue, $strReason
)
Saves a specific column of a row into a database
Parameters
$strKeyValue
mixed
$strColumn
mixed
$strValue
mixed
$strReason
mixed
array
search(
$strSearch, $arrQuery
)
Performs a search
Parameters
$strSearch
mixed
$arrQuery
mixed
Return
Array of
Countries
that match the search query.
Database Fields
The following fields are used when retrieving and saving entities.