Synergy 8 Digital Marketing Software PHP Component API
Components \ commerce \ affiliates administrators commissions payments \ configuration paymentmethods \ shippingmethods \ methods delivery discounts \ products brands categories \ recurringsales storedcards \ sales items \ receipts allocations \ customers \ contacts passwords referrertypes \ relationships types \ groups contacts \ marketing \ emailmarketing \ sends contacts unsubscribers \ events attendees locations \ reminders \ automation eventremindertrigger \ settings administrators components configurationitems cpanel customfields \ developer scheduledtasks threads domains \ website \ analytics sessions comments \ designs generator media pages \ posts categories Framework \ architecture publicassets \ assets css javascript \ caching filebased \ components textualids \ data util \ database mainconnection date \ dom currentcontext renderer \ html converters highlighter javascript \ http redirection request session useragent \ i18n companytypes countries languages \ network cidr dns geoip random \ reflection api \ system filenames filesystem toasts
.
.
.
quick access
description
\ methods
analyticsGetSums()
classGetFolder()
classGetFolderResources()
configGetValue()
convertTo2Char()
delete()
fieldsCustomGetAll()
fieldsCustomGetAllExt()
fieldsGetAll()
get()
getAll()
getAutoIncrementId()
getColumn()
getCount()
getStateTitlesFlat()
getTitle()
mediaFolderGet()
save()
saveColumn()
search()
fields

\Framework\I18N\Countries::

Class Methods

The following static methods are available on this class:
array analyticsGetSums($strColumn, $strDateStart, $strDateEnd, $strInterval, $arrProperties)
Description
Returns the sums of a column over a period
Parameters
$strColumn
string
$strDateStart
string
$strDateEnd
string
$strInterval
string
hour|day|month|year
$arrProperties
array
Return
array
string classGetFolder()
Description
Returns the folder where the class exists
Parameters
none
Return
string
string classGetFolderResources()
Description
Returns the folder where the class's resources exist
Parameters
none
Return
string
string configGetValue($strConfigId)
Description
Retrieves the value of a config item for the current component
Parameters
$strConfigId
string
Return
Config item value
string convertTo2Char($strCountryId)
Description
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
string
Return
Country code
bool delete($strKeyValue, $bDeleteMedia, $strReason)
Description
Deletes an entity and triggers the pre/post component events
Parameters
$strKeyValue
string
$bDeleteMedia
bool
$strReason
mixed
Return
bool
array fieldsCustomGetAll()
Description
Returns all the columns in the custom fields table
Parameters
none
Return
array
array fieldsCustomGetAllExt($bPublic, $bShowInLists, $bSearchable, $arrCustomFilter)
Description
Returns all the columns in the custom fields table
Parameters
$bPublic
mixed
$bShowInLists
mixed
$bSearchable
mixed
$arrCustomFilter
mixed
Return
array
array fieldsGetAll($bCached)
Description
Returns all the columns this component supports
Parameters
$bCached
mixed
Return
array
array get($strKey)
Description
Return the current value
Parameters
$strKey
string
Return
array
{Array} getAll($arrProperties)
Description
Return all entities in the database.
Parameters
$arrProperties
mixed
Return
Array of Countries
void getAutoIncrementId($arrEntity)
Description
Returns the last inserted id
Parameters
$arrEntity
mixed
Return
void
mixed getColumn($strKey, $strColumn)
Description
Returns a single column of an entity
Parameters
$strKey
string
$strColumn
string
Return
mixed
int getCount($arrFilter)
Description
Parameters
$arrFilter
array
Return
int
void getStateTitlesFlat($strCountryId)
Description
Returns a list of all the
Parameters
$strCountryId
mixed
Return
void
string getTitle($strKey)
Description
Returns the name of the country from a country code
Parameters
$strKey
string
Country Code
Return
Country title
string mediaFolderGet($strKey)
Description
Returns the media folder for this data adapter
Parameters
$strKey
mixed
Return
Folder
mixed save($arrEntity, $strReason)
Description
Saves an entity and triggers the pre/post component events
Parameters
$arrEntity
array
$strReason
string
Return
mixed
mixed saveColumn($strKeyValue, $strColumn, $strValue, $strReason)
Description
Changes a column of an existing entity Supports primary keys spanning on several columns if passing $strKeyValue as an associative arry
Parameters
$strKeyValue
string
$strColumn
string
$strValue
string
$strReason
string
Return
Id
array search($strSearch, $arrProperties)
Description
Performs a search
Parameters
$strSearch
string
$arrProperties
mixed
Return
array

Database Fields

The following fields are used when retrieving and saving entities.