CompositeField
class CompositeField extends FormField (View source)
Base class for all fields that contain other fields.
Implements sequentialisation - so that when we're saving / loading data, we can populate a tabbed form properly. All of the children are stored in $this->children
Traits
This trait can be applied to a ViewableData class to add the logic to render attributes in an SS template.
Form component which contains a castable message
Allows an object to have extensions applied to it.
A class that can be instantiated or replaced via DI
Provides extensions to this object to integrate it with standard config API methods.
Allows an object to declare a set of custom methods
Constants
| SCHEMA_DATA_TYPE_STRING |
|
| SCHEMA_DATA_TYPE_HIDDEN |
|
| SCHEMA_DATA_TYPE_TEXT |
|
| SCHEMA_DATA_TYPE_HTML |
|
| SCHEMA_DATA_TYPE_INTEGER |
|
| SCHEMA_DATA_TYPE_DECIMAL |
|
| SCHEMA_DATA_TYPE_MULTISELECT |
|
| SCHEMA_DATA_TYPE_SINGLESELECT |
|
| SCHEMA_DATA_TYPE_DATE |
|
| SCHEMA_DATA_TYPE_DATETIME |
|
| SCHEMA_DATA_TYPE_TIME |
|
| SCHEMA_DATA_TYPE_BOOLEAN |
|
| SCHEMA_DATA_TYPE_CUSTOM |
|
| SCHEMA_DATA_TYPE_STRUCTURAL |
|
Config options
| extensions | array | An array of extension names and parameters to be applied to this object upon construction. |
from Extensible |
| unextendable_classes | array | Classes that cannot be extended |
from Extensible |
| casting | from FormField | ||
| default_cast | string | The default object to cast scalar fields to if casting information is not specified, and casting to an object is required. |
from ViewableData |
| casting_cache | array | from ViewableData | |
| url_segment | string|null | Optional url_segment for this request handler |
from RequestHandler |
| url_handlers | The default URL handling rules. This specifies that the next component of the URL corresponds to a method to be called on this RequestHandlingData object. |
from RequestHandler | |
| allowed_actions | Define a list of action handling methods that are allowed to be called directly by URLs. |
from RequestHandler | |
| default_classes | array | from FormField |
Properties
| protected static | array | $extra_methods | Custom method sources |
from CustomMethods |
| protected | array | $extra_method_registers | Name of methods to invoke by defineMethods for this instance |
from CustomMethods |
| protected static | array | $built_in_methods | Non-custom methods |
from CustomMethods |
| protected | Extension[] | $extension_instances | from Extensible | |
| protected | callable[][] | $beforeExtendCallbacks | List of callbacks to call prior to extensions having extend called on them, each grouped by methodName. |
from Extensible |
| protected | callable[][] | $afterExtendCallbacks | List of callbacks to call after extensions having extend called on them, each grouped by methodName. |
from Extensible |
| 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 | 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 | array | $attributes | List of attributes to render on the frontend |
from AttributesHTML |
| protected | string | $message | from FormMessage | |
| protected | string | $messageType | from FormMessage | |
| protected | string | $messageCast | Casting for message |
from FormMessage |
| protected | Form | $form | from FormField | |
| protected | string | $inputType | This is INPUT's type attribute value. |
from FormField |
| protected | string | $name | from FormField | |
| protected | null|string | $title | from FormField | |
| protected | mixed | $value | from FormField | |
| protected | string | $extraClass | from FormField | |
| protected | string | $description | Adds a title attribute to the markup. |
from FormField |
| protected | array | $extraClasses | Extra CSS classes for the FormField container. |
from FormField |
| protected | string | $rightTitle | Right-aligned, contextual label for the field. |
from FormField |
| protected | string | $leftTitle | Left-aligned, contextual label for the field. |
from FormField |
| protected | FieldList | $containerFieldList | Stores a reference to the FieldList that contains this object. |
from FormField |
| protected | bool | $readonly | Set to true when this field is a readonly field |
|
| protected | bool | $disabled | from FormField | |
| protected | bool | $autofocus | from FormField | |
| protected | string | $customValidationMessage | Custom validation message for the field. |
from FormField |
| 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. |
from FormField |
| 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. |
from FormField |
| protected | string | $smallFieldHolderTemplate | from FormField | |
| protected | $schemaDataType | |||
| protected | $schemaComponent | |||
| protected | array | $schemaData | Structured schema data representing the FormField. |
from FormField |
| protected | array | $schemaState | Structured schema state representing the FormField's current data and validation. |
from FormField |
| protected | FieldList | $children | ||
| protected | int | $columnCount | ||
| protected | string | $tag | ||
| protected | string | $legend |
Methods
Attempts to locate and call a method dynamically added to a class at runtime if a default cannot be located
Adds any methods from Extension instances attached to this object.
Register an callback to invoke that defines extra methods
Return TRUE if a method exists on this object
Get meta-data details on a named method
Return the names of all the methods available on this object
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 callback as a method.
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.
Adds any methods from Extension instances attached to this object.
Add an extension to a specific class.
No description
Get extra config sources for this class
Return TRUE if a class has a specified extension.
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.
An implementation of the factory method, allows you to create an instance of a class
Creates a class instance by the "singleton" design pattern.
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).
Gets the uninherited value for the given config option
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.
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.
Return true if this object "exists" i.e. has a sensible value
Return the "casting helper" (a piece of PHP code that when evaluated creates a casted value object) for a field on this object. This helper will be a subclass of DBField.
Get the class name a field on this object will be casted to.
Return the string-format type for the given field.
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
Store a value in the field cache
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.
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.
Find appropriate templates for SSViewer to use to render this object
When rendering some objects it is necessary to iterate over the object being rendered, to do this, you need access to itself.
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 HTTPResponse_Exception, which is later caught in RequestHandler::handleAction() and returned to the user.
Returns the 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.
Safely get the value of the BackURL param, if provided via querystring / posted var
Redirect back. Uses either the HTTP-Referer or a manually set request-variable called "BackURL".
Retrieve the value of an HTML attribute
Get the default attributes when rendering this object.
Allows customization through an 'updateAttributes' hook on the base class.
Custom attributes to process. Falls back to getAttributes().
Casting type for this message. Will be 'text' or 'html'
Sets the error message to be displayed on the form field.
Get casting helper for message cast, or null if not known
Takes a field name and converts camelcase to spaced words. Also resolves combined field names with dot syntax to spaced words.
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.
Returns the field value suitable for insertion into the data object.
Gets the contextual label than can be used for additional field description.
Compiles all CSS-classes. Optionally includes a "form-group--no-label" class if no title was set on the FormField.
Check if a CSS-class has been added to the form container.
Add one or more CSS-classes to the FormField container.
Remove one or more CSS-classes from the FormField container.
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.
Set value assigned from a submitted form postback.
Return true if security token protection is enabled on the parent Form.
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).
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 FieldHolder.
Returns an array of templates to use for rendering SmallFieldHolder.
Generate an array of class name strings to use for rendering this form field into HTML.
Return a readonly version of this field. Keeps the composition but returns readonly versions of all the child FormField objects.
Return a disabled version of this field. Keeps the composition but returns disabled versions of all the child FormField objects.
Returns whether the current field has the given class added
Describe this field, provide help text for it.
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.
Sets the component type the FormField will be rendered as on the front-end.
Gets the type of front-end component the FormField will be rendered as.
Sets the schema data used for rendering the field on the front-end.
Gets the schema data used to render the FormField on the front-end.
Sets the schema data used for rendering the field on the front-end.
Gets the schema state used to render the FormField on the front-end.
Return list of validation rules. Each rule is a key value pair.
Add all of the non-composite fields contained within this field to the list.
Remove a field from this CompositeField by Name.
Find the numerical position of a field within the children collection. Doesn't work recursively.
Details
mixed
__call(string $method, array $arguments)
Attempts 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()
protected
defineMethods()
Adds any methods from Extension instances attached to this object.
All these methods can then be called directly on the instance (transparently mapped through __call()}), or called explicitly through {@link extend().
protected
registerExtraMethodCallback(string $name, callable $callback)
Register an callback to invoke that defines extra methods
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
protected array
getExtraMethodConfig(string $method)
Get meta-data details on a named method
array
allMethodNames(bool $custom = false)
Return the names of all the methods available on this object
protected array
findMethodsFromExtension(object $extension)
deprecated
deprecated
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
addCallbackMethod(string $method, callable $callback)
Add callback as a method.
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.
protected
constructExtensions()
deprecated
deprecated
No description
protected
defineExtensionMethods()
Adds any methods from Extension instances attached to this object.
All these methods can then be called directly on the instance (transparently mapped through __call()}), or called explicitly through {@link extend().
static bool
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.
Note: This will not remove extensions from parent classes, and must be called directly on the class assigned the extension.
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 = null, bool $includeArgumentString = false)
No description
static array|null
get_extra_config_sources(string $class = null)
Get extra config sources for this class
static bool
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))
array
invokeWithExtensions(string $method, mixed $a1 = null, mixed $a2 = null, mixed $a3 = null, mixed $a4 = null, mixed $a5 = null, mixed $a6 = null, mixed $a7 = 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|null
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(
Extension[]
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).
This method also provides lazy-population of the extension_instances property.
static Injectable
create(mixed ...$args)
An implementation of the factory method, allows you to create an instance of a class
This method will defer class substitution to the Injector API, which can be customised via the Config API to declare substitution classes.
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::class); $list = SiteTree::get();
static Injectable
singleton(string $class = null)
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 Config_ForClass
config()
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).
mixed
stat(string $name)
deprecated
deprecated
Get inherited config value
mixed
uninherited(string $name)
Gets the uninherited value for the given config option
$this
set_stat(string $name, mixed $value)
deprecated
deprecated
Update the config value for a given property
__construct($children = null)
Creates a new field.
bool
__isset(string $property)
Check if a field exists on this object or its failover.
Note that, unlike the core isset() implementation, this will return true if the property is defined and set to null.
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.
$this
setField(string $field, mixed $value)
Set a field on this object. This should be overloaded in child classes.
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.
bool
exists()
Return true if this object "exists" i.e. has a sensible value
This method should be overridden 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
__toString()
No description
ViewableData
getCustomisedObj()
No description
setCustomisedObj(ViewableData $object)
No description
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. This helper will be a subclass of DBField.
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.
DBHTMLText
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 string
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 $this
objCacheSet(string $key, mixed $value)
Store a value in the field cache
protected $this
objCacheClear()
Clear object cache
object|DBField
obj(string $fieldName, array $arguments = [], 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.
object|DBField
cachedCall(string $field, array $arguments = [], 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 = [], 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.
string
XML_val(string $field, array $arguments = [], bool $cache = false)
Get the string value of a field on this object that has been suitable escaped to be inserted directly into a template.
array
getXMLValues(array $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.
array
getViewerTemplates(string $suffix = '')
Find appropriate templates for SSViewer to use to render 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()
deprecated
deprecated
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 = self::class)
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
HTTPResponse|RequestHandler|string|array
handleRequest(HTTPRequest $request)
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 array
findAction(HTTPRequest $request)
No description
protected string
addBackURLParam(string $link)
No description
protected HTTPResponse
handleAction($request, $action)
Given a request, and an action name, call that action name on this RequestHandler
Must not raise 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 string
definingClassForAction(string $actionOrigCasing)
Return the class that defines the given action, so that we know where to check allowed_actions.
bool
checkAccessAction(string $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 HTTPResponse_Exception, which is later caught in RequestHandler::handleAction() and returned to the user.
HTTPRequest
getRequest()
Returns the 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 HTTPRequest object.
$this
setRequest(HTTPRequest $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
HTTPResponse
redirect(string $url, int $code = 302)
Redirect to the given URL.
string
getBackURL()
Safely get the value of the BackURL param, if provided via querystring / posted var
string
getReferer()
Get referer
HTTPResponse
redirectBack()
Redirect back. Uses either the HTTP-Referer or a manually set request-variable called "BackURL".
This variable is needed in scenarios where HTTP-Referer is not sent (e.g when calling a page by location.href in IE). If none of the two variables is available, it will redirect to the base URL (see Director::baseURL()).
$this
setAttribute($name, $value)
Set an HTML attribute
mixed|null
getAttribute(string $name)
Retrieve the value of an HTML attribute
abstract protected array
getDefaultAttributes()
Get the default attributes when rendering this object.
Called by getAttributes()
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
getMessage()
Returns the field message, used by form validation.
Use setError() to set this property.
string
getMessageType()
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.
string
getMessageCast()
Casting type for this message. Will be 'text' or 'html'
$this
setMessage(string $message, string $messageType = ValidationResult::TYPE_ERROR, string $messageCast = ValidationResult::CAST_TEXT)
Sets the error message to be displayed on the form field.
Allows HTML content, so remember to use Convert::raw2xml().
protected string
getMessageCastingHelper()
Get casting helper for message cast, or null if not known
array|null
getSchemaMessage()
Get form schema encoded message
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'
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 name (ID) for the element.
If the CompositeField doesn't have a name, but we still want the ID/name to be set. This code generates the ID from the nested children.
string
getInputType()
Returns the field input name.
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)
Set the title of this formfield.
Note: This expects escaped HTML.
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|DBField $rightTitle)
Sets the right title for this formfield
string
LeftTitle()
No description
$this
setLeftTitle(string $leftTitle)
No description
string
extraClass()
Compiles all CSS-classes. Optionally includes a "form-group--no-label" 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.
bool
hasExtraClass(string $class)
Check if a CSS-class has been added to the form container.
$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.
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, array|DataObject $data = null)
Set the field value.
If a FormField requires specific behaviour for loading content from either the database or a submitted form value they should override setSubmittedValue() instead.
$this
setSubmittedValue(mixed $value, array|DataObject $data = null)
Set value assigned from a submitted form postback.
Can be overridden to handle custom behaviour for user-localised data formats.
$this
setName(string $name)
Set the field name.
$this
setInputType(string $type)
Set the field input type.
$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
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.
DBHTMLText
Field(array $properties = [])
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.
DBHTMLText
FieldHolder(array $properties = [])
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 = [])
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.
protected array
_templates(string $customTemplate = null, string $customTemplateSuffix = null)
Generate an array of class name strings to use for rendering this form field into HTML.
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.
bool
isAutofocus()
No description
$this
setAutofocus(bool $autofocus)
Sets a autofocus flag on this FormField.
FormField
performReadonlyTransformation()
Return a readonly version of this field. Keeps the composition but returns readonly versions of all the child FormField objects.
FormField
performDisabledTransformation()
Return a disabled version of this field. Keeps the composition but returns disabled versions of all the child FormField objects.
mixed
transform(FormTransformation $transformation)
No description
bool
hasClass(string $class)
Returns whether the current field has the given class added
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.
bool
validate(Validator $validator)
Validate this field
$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
$this
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.
FormField
setSchemaComponent(string $componentType)
Sets the component type the FormField will be rendered as on the front-end.
string
getSchemaComponent()
Gets the type of front-end component the FormField will be rendered as.
FormField
setSchemaData(array $schemaData = [])
Sets the schema data used for rendering the field on the front-end.
Merges the passed array with the current $schemaData or getSchemaDataDefaults().
Any passed keys that are not defined in getSchemaDataDefaults() are ignored.
If you want to pass around ad hoc data use the data array e.g. pass ['data' => ['myCustomKey' => 'yolo']].
array
getSchemaData()
Gets the schema data used to render the FormField on the front-end.
string
getSchemaDataType()
No description
array
getSchemaDataDefaults()
Merge child field data into this form
FormField
setSchemaState(array $schemaState = [])
Sets the schema data used for rendering the field on the front-end.
Merges the passed array with the current $schemaState or getSchemaStateDefaults().
Any passed keys that are not defined in getSchemaStateDefaults() are ignored.
If you want to pass around ad hoc data use the data array e.g. pass ['data' => ['myCustomKey' => 'yolo']].
array
getSchemaState()
Gets the schema state used to render the FormField on the front-end.
array
getSchemaStateDefaults()
Gets the defaults for $schemaState.
The keys defined here are immutable, meaning undefined keys passed to setSchemaState() are ignored.
Instead the data array should be used to pass around ad hoc data.
Includes validation data if the field is associated to a Form,
and Form->validate() has been called.
array
getSchemaValidation()
Return list of validation rules. Each rule is a key value pair.
The key is the rule name. The value is any information the frontend
validation handler can understand, or just true to enable.
Tip|null
getTitleTip()
No description
FormField
setTitleTip(Tip|null $tip)
No description
FieldList
FieldList()
Returns all the sub-fields, suitable for <% loop FieldList %>
FieldList
getChildren()
Accessor method for $this->children
$this
setChildren(FieldList $children)
No description
$this
setTag(string $tag)
No description
string
getTag()
No description
$this
setLegend(string $legend)
No description
string
getLegend()
No description
collateDataFields(array $list, bool $saveableOnly = false)
Add all of the non-composite fields contained within this field to the list.
Sequentialisation is used when connecting the form to its data source
setColumnCount($columnCount)
No description
getColumnCount()
No description
fieldByName($name)
No description
push(FormField $field)
Add a new child field to the end of the set.
unshift(FormField $field)
Add a new child field to the beginning of the set.
false|FormField
insertBefore(string $insertBefore, FormField $field, bool $appendIfMissing = true)
No description
false|FormField
insertAfter(string $insertAfter, FormField $field, bool $appendIfMissing = true)
No description
removeByName(string $fieldName, bool $dataFieldOnly = false)
Remove a field from this CompositeField by Name.
The field could also be inside a CompositeField.
bool
replaceField($fieldName, $newField, bool $dataFieldOnly = true)
No description
__clone()
No description
IsReadonly()
No description
int
fieldPosition(string|FormField $field)
Find the numerical position of a field within the children collection. Doesn't work recursively.
bool
makeFieldReadonly(string|FormField $field)
Transform the named field into a readonly field.