The name of the cache provider to use.
The TTL for the cache storage.
The string to use as the key for this Item in the cache, the value of the idFieldName will be appended.
The name of the database provider to use when querying the database for this item.
Hash array specification of the fields on the database table for this item class, where each key is the field name and the value is a hash array with the following keys:
formItemA hash array containing the specification of this field when used in forms. Used by ItemAdmin.
selectTypeWhen using the
type, the select type, from one of the following available values:
itemsWhen using the
type, a hash array of the items available to be selected, where each key is the field value, and each value is a hash array with the following possible keys:
titleThe title of the select option
subTitleThe subtitle of the select option
isMultiLanguageWhether this field stores multi-language data, meaning there are more than one actual fields on the database, one for each available language. As configured in the Locale module's setup key
prefixThe prefix string to add when humanizing the field value. For example:
USDfor american dollar quantities like
postfixThe postfix string to add when humanizing the field value. For example:
ºfor values in degrees like
multiplierA multiplier to apply when humanizing the field value.
decimalsThe number of decimals to show when humanizing the field value
humanizeMethodNameA method name to call to humanize the field value. It will receive the Item object as the first and only parameter. If this returns something other than null, the returned value will be used and any other humanizing method and configs like
decimals, etc will be omitted.
humanizePreMethodNameA method name to call with the field value before any other humanization is done. It will receive the Item object as the first and only parameter.
humanizePostMethodNameA method name to call with the field value after any other humanization is done. It will receive the already treated value as the first parameter and the Item object as the second.
validationMethodAn anonymous function to validate the received value for this field, or an array where the first element is the class name, and the second the method name, just like the
call_user_funcPHP function would expect it. Must return an AjaxResponseJson object. Used for example in ItemAdmin.
The name of the field on the table that uniquely identifies this item on the database table with a numeric id. It should be an auto-increment field.
The method to use when loading this item from the database via an index. Possible values:
queryDatabaseCacheLoad the item from the database using cache.
queryDatabaseLoad the item from the database without using cache.
Hash array specification of the fields for this item type that are not fields on the database, but instead fields that interact with the database in a special way. For example, a
locationmeta field might interact with the database by setting the
cityIdnon-meta fields. Each key is the field name, and each value a hash array with following possible keys:
formItemA hash array containing the specification of this field for forms, used by ItemAdmin, just like the
formItemkey in the
FORM_ITEM_META_TYPE_LOCATION, a hash array where each item represents one level of the multilevel select, the key is the level name and the value is a hash array with the following keys:
titleThe title of the level
fieldNameThe name of the field on the table that stores this level value
The name of the database table where this items are stored.