FormField
class FormField extends RequestHandler (View source)
Represents a field in a form.
A FieldList contains a number of FormField objects which make up the whole of a form.
In addition to single fields, FormField objects can be "composite", for example, the TabSet field. Composite fields let us define complex forms without having to resort to custom HTML.
To subclass:
Define a dataValue() method that returns a value suitable for inserting into a single database field.
For example, you might tidy up the format of a date or currency field. Define saveInto() to totally customise saving.
For example, data might be saved to the filesystem instead of the data record, or saved to a component of the data record instead of the data record itself.
Properties
| public | string | $class | from SS_Object | |
| protected | array | $extension_instances | from SS_Object | |
| protected | $beforeExtendCallbacks | List of callbacks to call prior to extensions having extend called on them, each grouped by methodName. |
from SS_Object | |
| protected | $afterExtendCallbacks | List of callbacks to call after extensions having extend called on them, each grouped by methodName. |
from SS_Object | |
| protected | ViewableData | $failover | A failover object to attempt to get data from if it is not present on this object. |
from ViewableData |
| protected | ViewableData | $customisedObject | from ViewableData | |
| protected | SS_HTTPRequest | $request | from RequestHandler | |
| protected | $model | The DataModel for this request |
from RequestHandler | |
| protected | bool | $brokenOnConstruct | This variable records whether RequestHandler::construct() was called or not. Useful for checking if subclasses have called parent::construct() |
from RequestHandler |
| protected | Form | $form | ||
| protected | string | $name | ||
| protected | null|string | $title | ||
| protected | mixed | $value | ||
| protected | string | $message | ||
| protected | string | $messageType | ||
| protected | string | $extraClass | ||
| protected | string | $description | Adds a title attribute to the markup. |
|
| protected | array | $extraClasses | Extra CSS classes for the FormField container. |
|
| public | bool | $dontEscape | ||
| protected | string | $rightTitle | Right-aligned, contextual label for the field. |
|
| protected | string | $leftTitle | Left-aligned, contextual label for the field. |
|
| protected | FieldList | $containerFieldList | Stores a reference to the FieldList that contains this object. |
|
| protected | bool | $readonly | ||
| protected | bool | $disabled | ||
| protected | string | $customValidationMessage | Custom validation message for the field. |
|
| protected | string | $template | Name of the template used to render this form field. If not set, then will look up the class ancestry for the first matching template where the template name equals the class name. |
|
| protected | string | $fieldHolderTemplate | Name of the template used to render this form field. If not set, then will look up the class ancestry for the first matching template where the template name equals the class name. |
|
| protected | string | $smallFieldHolderTemplate | ||
| protected | array | $attributes | All attributes on the form field (not the field holder). |
Methods
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).
Allows user code to hook into Object::extend prior to control being delegated to extensions. Each callback will be reset once called.
Allows user code to hook into Object::extend after control being delegated to extensions. Each callback will be reset once called.
An implementation of the factory method, allows you to create an instance of a class
Creates a class instance by the "singleton" design pattern.
Create an object from a string representation. It treats it as a PHP constructor without the 'new' keyword. It also manages to construct the object without the use of eval().
Parses a class-spec, such as "Versioned('Stage','Live')", as passed to create_from_string().
Similar to Object::create(), except that classes are only overloaded if you set the $strong parameter to TRUE when using Object::useCustomClass()
This class allows you to overload classes with other classes when they are constructed using the factory method Object::create()
If a class has been overloaded, get the class name it has been overloaded with - otherwise return the class name
Get the value of a static property of a class, even in that property is declared protected (but not private), without any inheritance, merging or parent lookup if it doesn't exist on the given class.
Return TRUE if a class has a specified extension.
Add an extension to a specific class.
No description
Creates a new field.
Attemps to locate and call a method dynamically added to a class at runtime if a default cannot be located
Return the names of all the methods available on this object
Add methods from the ViewableData::$failover object, as well as wrapping any methods prefixed with an underscore into a ViewableData::cachedCall().
Add all the methods from an object property (which is an Extension) to this object.
Add all the methods from an object property (which is an Extension) to this object.
Add a wrapper method - a method which points to another method with a different name. For example, Thumbnail(x) can be wrapped to generateThumbnail(x)
Add an extra method using raw PHP code passed as a string
Check if this class is an instance of a specific class, or has that class as one of its parents
Calls a method if available on both this object and all applied Extensions, and then attempts to merge all results into an array
Run the given function on all of this object's extensions. Note that this method originally returned void, so if you wanted to return results, you're hosed
Get an extension instance attached to this object by name.
Returns TRUE if this object instance has a specific extension applied in $extension_instances. Extension instances are initialized at constructor time, meaning if you use add_extension() afterwards, the added extension will just be added to new instances of the extended class. Use the static method has_extension() to check if a class (not an instance) has a specific extension.
Get all extension instances for this specific object instance.
Cache the results of an instance method in this object to a file, or if it is already cache return the cached results
Clears the cache for the given cacheToFile call
Loads a cache from the filesystem if a valid on is present and within the specified lifetime
Save a piece of cached data to the file system
Strip a file name of special characters so it is suitable for use as a cache file name
Converts a field spec into an object creator. For example: "Int" becomes "new Int($fieldName);" and "Varchar(50)" becomes "new Varchar($fieldName, 50);".
Convert a field schema (e.g. "Varchar(50)") into a casting object creator array that contains both a className and castingHelper constructor code. See castingObjectCreator for more information about the constructor.
Check if a field exists on this object or its failover.
Get the value of a property/field on this object. This will check if a method called get{$property} exists, then check if a field is available using ViewableData::getField(), then fall back on a failover object.
Set a property/field on this object. This will check for the existence of a method called set{$property}, then use the ViewableData::setField() method.
Set a failover object to attempt to get data from if it is not present on this object.
Check if a field exists on this object. This should be overloaded in child classes.
Get the value of a field on this object. This should be overloaded in child classes.
Set a field on this object. This should be overloaded in child classes.
Method to facilitate deprecation of underscore-prefixed methods automatically being cached.
Merge some arbitrary data in with this object. This method returns a ViewableData_Customised instance with references to both this and the new custom data.
Get the class a field on this object would be casted to, as well as the casting helper for casting a field to an object (see ViewableData::castingHelper() for information on casting helpers).
Return the "casting helper" (a piece of PHP code that when evaluated creates a casted value object) for a field on this object.
Get the class name a field on this object will be casted to
Return the string-format type for the given field.
Save the casting cache for this object (including data from any failovers) into a variable
Render this object into the template, and get the result as a string. You can pass one of the following as the $template parameter:
- a template name (e.g. Page)
- an array of possible template names - the first valid one will be used
- an SSViewer instance
Generate the cache name for a field
Get the value of a field on this object, automatically inserting the value into any available casting objects that have been specified.
A simple wrapper around ViewableData::obj() that automatically caches the result so it can be used again without re-running the method.
Checks if a given method/field has a valid value. If the result is an object, this will return the result of the exists method, otherwise will check if the result is not just an empty paragraph tag.
Get the string value of a field on this object that has been suitable escaped to be inserted directly into a template.
Return the value of the field without any escaping being applied.
Return the value of a field in an SQL-safe format.
Return the value of a field in a JavaScript-save format.
Return the value of a field escaped suitable to be inserted into an XML node attribute.
Get an array of XML-escaped values by field name
Return a single-item iterator so you can iterate over the fields of a single record.
When rendering some objects it is necessary to iterate over the object being rendered, to do this, you need access to itself.
Return the directory if the current active theme (relative to the site root).
Get part of the current classes ancestry to be used as a CSS class.
Return debug information about this object that can be rendered into a template
Given a request, and an action name, call that action name on this RequestHandler
Get a array of allowed actions defined on this controller, any parent classes or extensions.
Checks if this request handler has a specific action, even if the current user cannot access it.
Return the class that defines the given action, so that we know where to check allowed_actions.
Check that the given action is allowed to be called from a URL.
Throws a HTTP error response encased in a SS_HTTPResponse_Exception, which is later caught in RequestHandler::handleAction() and returned to the user.
Returns the SS_HTTPRequest object that this controller is using.
Typically the request is set through handleAction() or handleRequest(), but in some based we want to set it manually.
Takes a field name and converts camelcase to spaced words. Also resolves combined field names with dot syntax to spaced words.
Construct and return HTML tag.
Set up the default classes for the form. This is done on construct so that the default classes can be removed after instantiation
Returns the current FormTemplateHelper on either the parent Form or the global helper set through the Injector layout.
Gets the contextual label than can be used for additional field description.
Compiles all CSS-classes. Optionally includes a "nolabel" class if no title was set on the FormField.
Remove one or more CSS-classes from the FormField container.
Set an HTML attribute on the field element, mostly an input tag.
Get an HTML attribute defined by the field, or added through setAttribute().
Allows customization through an 'updateAttributes' hook on the base class.
Custom attributes to process. Falls back to getAttributes().
Returns a version of a title suitable for insertion into an HTML attribute.
Returns a version of a title suitable for insertion into an HTML attribute.
Return true if security token protection is enabled on the parent Form.
Sets the error message to be displayed on the form field.
Set the custom error message to show instead of the default format.
Get the custom error message for this form field. If a custom message has not been defined then just return blank. The default error is defined on Validator.
Set name of template (without path or extension) for the holder, which in turn is responsible for rendering Field().
Set name of template (without path or extension) for the small holder, which in turn is responsible for rendering Field().
Returns a restricted field holder used within things like FieldGroups.
Returns an array of templates to use for rendering FieldHolder.
Returns an array of templates to use for rendering SmallFieldHolder.
This function is used by the template processor. If you refer to a field as a $ variable, it will return the $Field value.
Returns another instance of this field, but "cast" to a different class. The logic tries to retain all of the instance properties, and may be overloaded by subclasses to set additional ones.
Determine if the value of this formfield accepts front-end submitted values and is saveable.
Details
static Config_ForClass|null
config()
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).
protected
beforeExtending(string $method, callable $callback)
Allows user code to hook into Object::extend prior to control being delegated to extensions. Each callback will be reset once called.
protected
afterExtending(string $method, callable $callback)
Allows user code to hook into Object::extend after control being delegated to extensions. Each callback will be reset once called.
static SS_Object
create()
An implementation of the factory method, allows you to create an instance of a class
This method first for strong class overloads (singletons & DB interaction), then custom class overloads. If an overload is found, an instance of this is returned rather than the original class. To overload a class, use Object::useCustomClass()
This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create('SiteTree'); $list = SiteTree::get();
static SS_Object
singleton()
Creates a class instance by the "singleton" design pattern.
It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).
static
create_from_string($classSpec, $firstArg = null)
Create an object from a string representation. It treats it as a PHP constructor without the 'new' keyword. It also manages to construct the object without the use of eval().
Construction itself is done with Object::create(), so that Object::useCustomClass() calls are respected.
Object::create_from_string("Versioned('Stage','Live')") will return the result of
Versioned::create('Stage', 'Live);
It is designed for simple, clonable objects. The first time this method is called for a given string it is cached, and clones of that object are returned.
If you pass the $firstArg argument, this will be prepended to the constructor arguments. It's impossible to pass null as the firstArg argument.
Object::create_from_string("Varchar(50)", "MyField") will return the result of
Vachar::create('MyField', '50');
Arguments are always strings, although this is a quirk of the current implementation rather than something that can be relied upon.
static
parse_class_spec($classSpec)
Parses a class-spec, such as "Versioned('Stage','Live')", as passed to create_from_string().
Returns a 2-elemnent array, with classname and arguments
static SS_Object
strong_create()
Similar to Object::create(), except that classes are only overloaded if you set the $strong parameter to TRUE when using Object::useCustomClass()
static
useCustomClass(string $oldClass, string $newClass, bool $strong = false)
This class allows you to overload classes with other classes when they are constructed using the factory method Object::create()
static string
getCustomClass(string $class)
If a class has been overloaded, get the class name it has been overloaded with - otherwise return the class name
static any
static_lookup($class, $name, null $default = null)
Get the value of a static property of a class, even in that property is declared protected (but not private), without any inheritance, merging or parent lookup if it doesn't exist on the given class.
static
get_static($class, $name, $uncached = false)
deprecated
deprecated
No description
static
set_static($class, $name, $value)
deprecated
deprecated
No description
static
uninherited_static($class, $name, $uncached = false)
deprecated
deprecated
No description
static
combined_static($class, $name, $ceiling = false)
deprecated
deprecated
No description
static
addStaticVars($class, $properties, $replace = false)
deprecated
deprecated
No description
static
add_static_var($class, $name, $value, $replace = false)
deprecated
deprecated
No description
static
has_extension(string $classOrExtension, string $requiredExtension = null, bool $strict = false)
Return TRUE if a class has a specified extension.
This supports backwards-compatible format (static Object::has_extension($requiredExtension)) and new format ($object->has_extension($class, $requiredExtension))
static
add_extension(string $classOrExtension, string $extension = null)
Add an extension to a specific class.
The preferred method for adding extensions is through YAML config, since it avoids autoloading the class, and is easier to override in more specific configurations.
As an alternative, extensions can be added to a specific class directly in the Object::$extensions array. See SiteTree::$extensions for examples. Keep in mind that the extension will only be applied to new instances, not existing ones (including all instances created through singleton()).
static
remove_extension(string $extension)
Remove an extension from a class.
Keep in mind that this won't revert any datamodel additions of the extension at runtime, unless its used before the schema building kicks in (in your _config.php). Doesn't remove the extension from any Object instances which are already created, but will have an effect on new extensions. Clears any previously created singletons through singleton() to avoid side-effects from stale extension information.
static array
get_extensions(string $class, bool $includeArgumentString = false)
No description
static
get_extra_config_sources($class = null)
No description
__construct(string $name, null|string $title = null, mixed $value = null)
Creates a new field.
mixed
__call(string $method, array $arguments)
Attemps to locate and call a method dynamically added to a class at runtime if a default cannot be located
You can add extra methods to a class using Extensions}, {@link Object::createMethod() or Object::addWrapperMethod()
bool
hasMethod(string $method)
Return TRUE if a method exists on this object
This should be used rather than PHP's inbuild method_exists() as it takes into account methods added via extensions
array
allMethodNames(bool $custom = false)
Return the names of all the methods available on this object
defineMethods()
Add methods from the ViewableData::$failover object, as well as wrapping any methods prefixed with an underscore into a ViewableData::cachedCall().
protected array
findMethodsFromExtension(object $extension)
No description
protected
addMethodsFrom(string $property, string|int $index = null)
Add all the methods from an object property (which is an Extension) to this object.
protected
removeMethodsFrom(string $property, string|int $index = null)
Add all the methods from an object property (which is an Extension) to this object.
protected
addWrapperMethod(string $method, string $wrap)
Add a wrapper method - a method which points to another method with a different name. For example, Thumbnail(x) can be wrapped to generateThumbnail(x)
protected
createMethod(string $method, string $code)
Add an extra method using raw PHP code passed as a string
stat($name, $uncached = false)
No description
set_stat($name, $value)
No description
uninherited($name)
No description
bool
exists()
Return true if this object "exists" i.e. has a sensible value
This method should be overriden in subclasses to provide more context about the classes state. For example, a DataObject class could return false when it is deleted from the database
string
parentClass()
No description
bool
is_a(string $class)
Check if this class is an instance of a specific class, or has that class as one of its parents
string
__toString()
No description
mixed
invokeWithExtensions(string $method, mixed $argument = null)
Calls a method if available on both this object and all applied Extensions, and then attempts to merge all results into an array
array
extend(string $method, mixed $a1 = null, mixed $a2 = null, mixed $a3 = null, mixed $a4 = null, mixed $a5 = null, mixed $a6 = null, mixed $a7 = null)
Run the given function on all of this object's extensions. Note that this method originally returned void, so if you wanted to return results, you're hosed
Currently returns an array, with an index resulting every time the function is called. Only adds returns if they're not NULL, to avoid bogus results from methods just defined on the parent extension. This is important for permission-checks through extend, as they use min() to determine if any of the returns is FALSE. As min() doesn't do type checking, an included NULL return would fail the permission checks.
The extension methods are defined during __construct()} in {@link defineMethods().
Extension
getExtensionInstance(string $extension)
Get an extension instance attached to this object by name.
bool
hasExtension(string $extension)
Returns TRUE if this object instance has a specific extension applied in $extension_instances. Extension instances are initialized at constructor time, meaning if you use add_extension() afterwards, the added extension will just be added to new instances of the extended class. Use the static method has_extension() to check if a class (not an instance) has a specific extension.
Caution: Don't use singleton(
array
getExtensionInstances()
Get all extension instances for this specific object instance.
See get_extensions() to get all applied extension classes for this class (not the instance).
mixed
cacheToFile(string $method, int $lifetime = 3600, string $ID = false, array $arguments = array())
Cache the results of an instance method in this object to a file, or if it is already cache return the cached results
clearCache($method, $ID = false, $arguments = array())
Clears the cache for the given cacheToFile call
protected mixed
loadCache(string $cache, int $lifetime = 3600)
Loads a cache from the filesystem if a valid on is present and within the specified lifetime
protected
saveCache(string $cache, mixed $data)
Save a piece of cached data to the file system
protected string
sanitiseCachename(string $name)
Strip a file name of special characters so it is suitable for use as a cache file name
static string
castingObjectCreator(string $fieldSchema)
Converts a field spec into an object creator. For example: "Int" becomes "new Int($fieldName);" and "Varchar(50)" becomes "new Varchar($fieldName, 50);".
static array
castingObjectCreatorPair(string $fieldSchema)
Convert a field schema (e.g. "Varchar(50)") into a casting object creator array that contains both a className and castingHelper constructor code. See castingObjectCreator for more information about the constructor.
bool
__isset(string $property)
Check if a field exists on this object or its failover.
mixed
__get(string $property)
Get the value of a property/field on this object. This will check if a method called get{$property} exists, then check if a field is available using ViewableData::getField(), then fall back on a failover object.
__set(string $property, mixed $value)
Set a property/field on this object. This will check for the existence of a method called set{$property}, then use the ViewableData::setField() method.
setFailover(ViewableData $failover)
Set a failover object to attempt to get data from if it is not present on this object.
ViewableData|null
getFailover()
Get the current failover object if set
bool
hasField(string $field)
Check if a field exists on this object. This should be overloaded in child classes.
mixed
getField(string $field)
Get the value of a field on this object. This should be overloaded in child classes.
setField(string $field, mixed $value)
Set a field on this object. This should be overloaded in child classes.
unknown
deprecatedCachedCall($method, $args = null, string $identifier = null)
Method to facilitate deprecation of underscore-prefixed methods automatically being cached.
ViewableData_Customised
customise(array|ViewableData $data)
Merge some arbitrary data in with this object. This method returns a ViewableData_Customised instance with references to both this and the new custom data.
Note that any fields you specify will take precedence over the fields on this object.
ViewableData
getCustomisedObj()
No description
setCustomisedObj(ViewableData $object)
No description
array
castingHelperPair(string $field)
Get the class a field on this object would be casted to, as well as the casting helper for casting a field to an object (see ViewableData::castingHelper() for information on casting helpers).
The returned array contains two keys:
- className: the class the field would be casted to (e.g. "Varchar")
- castingHelper: the casting helper for casting the field (e.g. "return new Varchar($fieldName)")
string
castingHelper(string $field)
Return the "casting helper" (a piece of PHP code that when evaluated creates a casted value object) for a field on this object.
string
castingClass(string $field)
Get the class name a field on this object will be casted to
string
escapeTypeForField(string $field)
Return the string-format type for the given field.
buildCastingCache(reference $cache)
Save the casting cache for this object (including data from any failovers) into a variable
HTMLText
renderWith(string|array|SSViewer $template, array $customFields = null)
Render this object into the template, and get the result as a string. You can pass one of the following as the $template parameter:
- a template name (e.g. Page)
- an array of possible template names - the first valid one will be used
- an SSViewer instance
protected
objCacheName(string $fieldName, array $arguments)
Generate the cache name for a field
protected mixed
objCacheGet(string $key)
Get a cached value from the field cache
protected
objCacheSet(string $key, mixed $value)
Store a value in the field cache
obj(string $fieldName, array $arguments = null, bool $forceReturnedObject = true, bool $cache = false, string $cacheName = null)
Get the value of a field on this object, automatically inserting the value into any available casting objects that have been specified.
cachedCall(string $field, array $arguments = null, string $identifier = null)
A simple wrapper around ViewableData::obj() that automatically caches the result so it can be used again without re-running the method.
bool
hasValue(string $field, array $arguments = null, bool $cache = true)
Checks if a given method/field has a valid value. If the result is an object, this will return the result of the exists method, otherwise will check if the result is not just an empty paragraph tag.
XML_val($field, $arguments = null, $cache = false)
Get the string value of a field on this object that has been suitable escaped to be inserted directly into a template.
RAW_val($field, $arguments = null, $cache = true)
Return the value of the field without any escaping being applied.
SQL_val($field, $arguments = null, $cache = true)
Return the value of a field in an SQL-safe format.
JS_val($field, $arguments = null, $cache = true)
Return the value of a field in a JavaScript-save format.
ATT_val($field, $arguments = null, $cache = true)
Return the value of a field escaped suitable to be inserted into an XML node attribute.
array
getXMLValues($fields)
Get an array of XML-escaped values by field name
ArrayIterator
getIterator()
Return a single-item iterator so you can iterate over the fields of a single record.
This is useful so you can use a single record inside a <% control %> block in a template - and then use to access individual fields on this object.
ViewableData
Me()
When rendering some objects it is necessary to iterate over the object being rendered, to do this, you need access to itself.
string
ThemeDir(string $subtheme = false)
Return the directory if the current active theme (relative to the site root).
This method is useful for things such as accessing theme images from your template without hardcoding the theme
page - e.g. 
.
This method should only be used when a theme is currently active. However, it will fall over to the current project directory.
string
CSSClasses(string $stopAtClass = 'ViewableData')
Get part of the current classes ancestry to be used as a CSS class.
This method returns an escaped string of CSS classes representing the current classes ancestry until it hits a stop point - e.g. "Page DataObject ViewableData".
ViewableData_Debugger
Debug()
Return debug information about this object that can be rendered into a template
setDataModel($model)
Set the DataModel for this request.
SS_HTTPResponse|RequestHandler|string|array
handleRequest(SS_HTTPRequest $request, DataModel $model)
Handles URL requests.
- ViewableData::handleRequest() iterates through each rule in self::$url_handlers.
- If the rule matches, the named method will be called.
- If there is still more URL to be processed, then handleRequest() is called on the object that that method returns.
Once all of the URL has been processed, the final result is returned. However, if the final result is an array, this array is interpreted as being additional template data to customise the 2nd to last result with, rather than an object in its own right. This is most frequently used when a Controller's action will return an array of data with which to customise the controller.
protected
findAction($request)
No description
protected SS_HTTPResponse
handleAction($request, $action)
Given a request, and an action name, call that action name on this RequestHandler
Must not raise SS_HTTPResponse_Exceptions - instead it should return
array|null
allowedActions(string $limitToClass = null)
Get a array of allowed actions defined on this controller, any parent classes or extensions.
Caution: Since 3.1, allowed_actions definitions only apply to methods on the controller they're defined on, so it is recommended to use the $class argument when invoking this method.
bool
hasAction(string $action)
Checks if this request handler has a specific action, even if the current user cannot access it.
Includes class ancestry and extensions in the checks.
protected
definingClassForAction($actionOrigCasing)
Return the class that defines the given action, so that we know where to check allowed_actions.
checkAccessAction($action)
Check that the given action is allowed to be called from a URL.
It will interrogate self::$allowed_actions to determine this.
httpError(int $errorCode, string $errorMessage = null)
Throws a HTTP error response encased in a SS_HTTPResponse_Exception, which is later caught in RequestHandler::handleAction() and returned to the user.
SS_HTTPRequest|NullHTTPRequest
getRequest()
Returns the SS_HTTPRequest object that this controller is using.
Returns a placeholder NullHTTPRequest object unless handleAction()} or {@link handleRequest() have been called, which adds a reference to an actual SS_HTTPRequest object.
setRequest($request)
Typically the request is set through handleAction() or handleRequest(), but in some based we want to set it manually.
string
Link(string $action = null)
Return a link to this field.
static string
name_to_label(string $fieldName)
Takes a field name and converts camelcase to spaced words. Also resolves combined field names with dot syntax to spaced words.
Examples:
- 'TotalAmount' will return 'Total Amount'
- 'Organisation.ZipCode' will return 'Organisation Zip Code'
static string
create_tag(string $tag, array $attributes, null|string $content = null)
Construct and return HTML tag.
protected
setupDefaultClasses()
Set up the default classes for the form. This is done on construct so that the default classes can be removed after instantiation
string
ID()
Returns the HTML ID of the field.
The ID is generated as FormName_FieldName. All Field functions should ensure that this ID is included in the field.
string
HolderID()
Returns the HTML ID for the form field holder element.
FormTemplateHelper
getTemplateHelper()
Returns the current FormTemplateHelper on either the parent Form or the global helper set through the Injector layout.
To customize a single FormField}, use {@link setTemplate and provide a custom template name.
string
getName()
Returns the field name.
string
Message()
Returns the field message, used by form validation.
Use setError() to set this property.
string
MessageType()
Returns the field message type.
Arbitrary value which is mostly used for CSS classes in the rendered HTML, e.g "required".
Use setError() to set this property.
mixed
Value()
Returns the field value.
saveInto(DataObjectInterface $record)
Method to save this form field into the given DataObject.
By default, makes use of $this->dataValue()
mixed
dataValue()
Returns the field value suitable for insertion into the data object.
string
Title()
Returns the field label - used by templates.
$this
setTitle(string $title)
No description
string
RightTitle()
Gets the contextual label than can be used for additional field description.
Can be shown to the right or under the field in question.
$this
setRightTitle(string $rightTitle)
No description
string
LeftTitle()
No description
$this
setLeftTitle(string $leftTitle)
No description
string
extraClass()
Compiles all CSS-classes. Optionally includes a "nolabel" class if no title was set on the FormField.
Uses Message()} and {@link MessageType() to add validation error classes which can be used to style the contained tags.
$this
addExtraClass(string $class)
Add one or more CSS-classes to the FormField container.
Multiple class names should be space delimited.
$this
removeExtraClass(string $class)
Remove one or more CSS-classes from the FormField container.
$this
setAttribute(string $name, string $value)
Set an HTML attribute on the field element, mostly an input tag.
Some attributes are best set through more specialized methods, to avoid interfering with built-in behaviour:
Caution: this doesn't work on most fields which are composed of more than one HTML form field.
null|string
getAttribute($name)
Get an HTML attribute defined by the field, or added through setAttribute().
Caution: this doesn't work on all fields, see setAttribute().
array
getAttributes()
Allows customization through an 'updateAttributes' hook on the base class.
Existing attributes are passed in as the first argument and can be manipulated, but any attributes added through a subclass implementation won't be included.
string
getAttributesHTML(array $attributes = null)
Custom attributes to process. Falls back to getAttributes().
If at least one argument is passed as a string, all arguments act as excludes, by name.
string
attrTitle()
Returns a version of a title suitable for insertion into an HTML attribute.
string
attrValue()
Returns a version of a title suitable for insertion into an HTML attribute.
$this
setValue(mixed $value)
Set the field value.
$this
setName(string $name)
Set the field name.
$this
setForm(Form $form)
Set the container form.
This is called automatically when fields are added to forms.
Form
getForm()
Get the currently used form.
bool
securityTokenEnabled()
Return true if security token protection is enabled on the parent Form.
$this
setError(string $message, string $messageType)
Sets the error message to be displayed on the form field.
Allows HTML content, so remember to use Convert::raw2xml().
$this
setCustomValidationMessage(string $customValidationMessage)
Set the custom error message to show instead of the default format.
Different from setError() as that appends it to the standard error messaging.
string
getCustomValidationMessage()
Get the custom error message for this form field. If a custom message has not been defined then just return blank. The default error is defined on Validator.
$this
setTemplate(string $template)
Set name of template (without path or extension).
Caution: Not consistently implemented in all subclasses, please check the Field() method on the subclass for support.
string
getTemplate()
No description
string
getFieldHolderTemplate()
No description
$this
setFieldHolderTemplate(string $fieldHolderTemplate)
Set name of template (without path or extension) for the holder, which in turn is responsible for rendering Field().
Caution: Not consistently implemented in all subclasses, please check the Field() method on the subclass for support.
string
getSmallFieldHolderTemplate()
No description
$this
setSmallFieldHolderTemplate(string $smallFieldHolderTemplate)
Set name of template (without path or extension) for the small holder, which in turn is responsible for rendering Field().
Caution: Not consistently implemented in all subclasses, please check the Field() method on the subclass for support.
string
Field(array $properties = array())
Returns the form field.
Although FieldHolder is generally what is inserted into templates, all of the field holder templates make use of $Field. It's expected that FieldHolder will give you the "complete" representation of the field on the form, whereas Field will give you the core editing widget, such as an input tag.
string
FieldHolder(array $properties = array())
Returns a "field holder" for this field.
Forms are constructed by concatenating a number of these field holders.
The default field holder is a label and a form field inside a div.
string
SmallFieldHolder(array $properties = array())
Returns a restricted field holder used within things like FieldGroups.
array
getTemplates()
Returns an array of templates to use for rendering FieldHolder.
array
getFieldHolderTemplates()
Returns an array of templates to use for rendering FieldHolder.
array
getSmallFieldHolderTemplates()
Returns an array of templates to use for rendering SmallFieldHolder.
bool
isComposite()
Returns true if this field is a composite field.
To create composite field types, you should subclass CompositeField.
bool
hasData()
Returns true if this field has its own data.
Some fields, such as titles and composite fields, don't actually have any data. It doesn't make sense for data-focused methods to look at them. By overloading hasData() to return false, you can prevent any data-focused methods from looking at it.
bool
isReadonly()
No description
$this
setReadonly(bool $readonly)
Sets a read-only flag on this FormField.
Use performReadonlyTransformation() to transform this instance.
Setting this to false has no effect on the field.
bool
isDisabled()
No description
$this
setDisabled(bool $disabled)
Sets a disabled flag on this FormField.
Use performDisabledTransformation() to transform this instance.
Setting this to false has no effect on the field.
FormField
performReadonlyTransformation()
Returns a read-only version of this field.
FormField
performDisabledTransformation()
Return a disabled version of this field.
Tries to find a class of the class name of this field suffixed with "_Disabled", failing that, finds a method setDisabled().
mixed
transform(FormTransformation $transformation)
No description
int
hasClass(string $class)
No description
string
Type()
Returns the field type.
The field type is the class name with the word Field dropped off the end, all lowercase.
It's handy for assigning HTML classes. Doesn't signify the input type attribute.
string
createTag(string $tag, array $attributes, null|string $content = null)
deprecated
deprecated
No description
bool
validate(Validator $validator)
Abstract method each FormField subclass must implement, determines whether the field is valid or not based on the value.
$this
setDescription(string $description)
Describe this field, provide help text for it.
By default, renders as a span class="description" underneath the form field.
string
getDescription()
No description
string
debug()
No description
string
forTemplate()
This function is used by the template processor. If you refer to a field as a $ variable, it will return the $Field value.
bool
Required()
No description
FieldList
setContainerFieldList(FieldList $containerFieldList)
Set the FieldList that contains this field.
FieldList
getContainerFieldList()
Get the FieldList that contains this field.
null|FieldList
rootFieldList()
No description
FormField
castedCopy(mixed $classOrCopy)
Returns another instance of this field, but "cast" to a different class. The logic tries to retain all of the instance properties, and may be overloaded by subclasses to set additional ones.
Assumes the standard FormField parameter signature with its name as the only mandatory argument. Mainly geared towards creating _Readonly or _Disabled subclasses of the same type, or casting to a ReadonlyField.
Does not copy custom field templates, since they probably won't apply to the new instance.
bool
canSubmitValue()
Determine if the value of this formfield accepts front-end submitted values and is saveable.