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
\ methods

\Components\Settings\CustomFields::

Class Methods

The following static methods are available on this class:
string configGetValue($strConfigId)
Description
Retrieves the value of a config item for the current component
Parameters
$strConfigId
string
Return
Config item value
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 get($strKey)
Description
Returns an entity
Parameters
$strKey
mixed
Value of the primary key
Return
{Array} getAll($arrProperties)
Description
Return all entities in the database.
Parameters
$arrProperties
mixed
Return
Array of CustomFields
array|null getByComponentAndField($strComponent, $strField)
Description
Returns a custom field from its component and field name
Parameters
$strComponent
string
$strField
string
Return
array|null
mixed getColumn($strKey, $strColumn)
Description
Returns a single column of an entity
Parameters
$strKey
string
$strColumn
string
Return
mixed
int getCount($arrFilter)
Description
Returns a count of all rows in the data adapter
Parameters
$arrFilter
array
Return
int
string|null getForm($strComponent, $strField)
Description
Returns the form for a custom field
Parameters
$strComponent
string
$strField
string
Return
string|null
array|null getOptions($strComponent, $strField)
Description
If the custom field contains options, return them as an array
Parameters
$strComponent
string
$strField
string
Return
array|null
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
string uniquifyDataColumns($strForm, $strSuffix)
Description
Suffix all datacolumn's in the supplied form with the supplied string, allowing the custom field form to be unique when included in certain contexts such as Automation conditions.
Parameters
$strForm
string
The form to uniquify.
$strSuffix
string
The string to append to all form datacolumn's.
Return
The uniquified form.
string uniquifyIDs($strForm, $strSuffix)
Description
Suffix all id's in the supplied form with the supplied Id, allowing the custom field form to be unique when included in certain contexts such as Automation conditions.
Parameters
$strForm
string
The form to uniquify.
$strSuffix
string
The string to append to all form id's.
Return
The uniquified form.

Database Fields

The following fields are used when retrieving and saving entities.
custom_field_component
varchar (255)
custom_field_id
int (11)
custom_field_is_editable
tinyint unsigned (1)
Default value: 1
custom_field_table
varchar (255)
field_description
varchar (255)
field_display
text
field_form
text
field_id
varchar (255)
field_is_mandatory
tinyint (1)
field_is_public
tinyint unsigned (1)
field_is_searchable
tinyint unsigned (1)
field_is_shown_in_checkout
tinyint unsigned (1)
field_is_shown_in_lists
tinyint unsigned (1)
field_is_shown_in_manual_sales
tinyint unsigned (1)
field_label
varchar (255)
field_order
smallint unsigned (5)
field_type
varchar (255)
field_type_options
text