Form
class Form extends RequestHandler (View source)
Base class for all forms.
The form class is an extensible base for all forms on a SilverStripe application. It can be used either by extending it, and creating processor methods on the subclass, or by creating instances of form whose actions are handled by the parent controller.
In either case, if you want to get a form to do anything, it must be inextricably tied to a controller. The constructor is passed a controller and a method on that controller. This method should return the form object, and it shouldn't require any arguments. Parameters, if necessary, can be passed using the URL or get variables. These restrictions are in place so that we can recreate the form object upon form submission, without the use of a session, which would be too resource-intensive.
You will need to create at least one method for processing the submission (through FormAction). This method will be passed two parameters: the raw request data, and the form object. Usually you want to save data into a DataObject} by using {@link saveInto(). If you want to process the submitted data in any way, please use getData() rather than the raw request data.
Validation
Each form needs some form of Validator} to trigger the {@link FormField->validate() methods for each field. You can't disable validator for security reasons, because crucial behaviour like extension checks for file uploads depend on it. The default validator is an instance of RequiredFields. If you want to enforce serverside-validation to be ignored for a specific FormField, you need to subclass it.
URL Handling
The form class extends RequestHandler, which means it can be accessed directly through a URL. This can be handy for refreshing a form by ajax, or even just displaying a single form field. You can find out the base URL for your form by looking at the
Constants
| ENC_TYPE_URLENCODED |
|
| ENC_TYPE_MULTIPART |
|
| MERGE_DEFAULT |
|
| MERGE_CLEAR_MISSING |
|
| MERGE_IGNORE_FALSEISH |
|
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 |
| public | bool | $IncludeFormTag | ||
| protected | FieldList|null | $fields | ||
| protected | FieldList|null | $actions | ||
| protected | Controller|null | $controller | ||
| protected | string|null | $name | ||
| protected | Validator|null | $validator | ||
| protected | string | $formMethod | ||
| protected | bool | $strictFormMethodCheck | ||
| protected static | string|null | $current_action | ||
| protected | DataObject|null | $record | ||
| protected | bool | $hasDefaultAction | Keeps track of whether this form has a default action or not. |
|
| protected | string|null | $target | Target attribute of form-tag. |
|
| protected | string|null | $legend | Legend value, to be inserted into the |
|
| protected | string|null | $template | The SS template to render this form HTML into. |
|
| protected | callable|null | $buttonClickedFunc | ||
| protected | string|null | $message | ||
| protected | string|null | $messageType | ||
| protected | bool | $redirectToFormOnValidationError | Should we redirect the user back down to the the form on validation errors rather then just the page |
|
| protected | bool | $security | ||
| protected | SecurityToken|null | $securityToken | ||
| protected | array | $extraClasses | ||
| protected | string|null | $encType | ||
| protected | array | $attributes | ||
| protected | bool | $securityTokenAdded |
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
Create a new form, with the given fields an action buttons.
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.
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.
Returns a link to this controller. Overload with your own Link rules if they exist.
Set up current form errors in session to the current form if appropriate.
set up the default classes for the form. This is done on construct so that the default classes can be removed after instantiation
Handle a form submission. GET and POST requests behave identically.
Returns the appropriate response up the controller chain if validate() fails (which is checked prior to executing any form actions).
Fields can have action to, let's check if anyone of the responds to $funcname them
Set whether the user should be redirected back down to the form on the page upon validation errors in the form or if they just need to redirect back to the page
Get whether the user should be redirected back down to the form on the page upon validation errors
Add a plain text error message to a field on this form. It will be saved into the session and used the next time this form is displayed.
Generate extra special fields - namely the security token field (if required).
Return all fields in a form - including fields nested in CompositeFields.
Return the attributes of the form tag - used by the templates.
Set the target of this form to any value - useful for opening the form contents in a new window or refreshing another frame
Return a FormTemplateHelper for this form. If one has not been set, return the default helper.
Set the target of this form to any value - useful for opening the form contents in a new window or refreshing another frame.
Set the SS template that this form should use to render with. The default is "Form".
Sets the form encoding type. The most common encoding types are defined in ENC_TYPE_URLENCODED} and {@link ENC_TYPE_MULTIPART.
Returns the real HTTP method for the form: GET, POST, PUT, DELETE or HEAD.
Set the form method: GET, POST, PUT, DELETE.
If set to true, enforce the matching of the form method.
Returns an object where there is a method with the same name as each data field on the form.
The next functions store and modify the forms message attributes. messages are stored in session under $_SESSION[formname][message];
Set a status message for the form.
Set a message to the session, for display next time this form is shown.
Returns the DataObject that has given this form its data through loadDataFrom().
Load data from the given DataObject or array.
Save the contents of this form into the given data object.
Get the submitted data from this form through FieldList->dataFields(), which filters out any form-specific data like form-actions.
Render this form using the given template, and return the result as a string You can pass either an SSViewer or a template name
Sets the button that was clicked. This should only be called by the Controller.
Get a list of all actions, including those in the main "fields" FieldList
Return the default button that should be clicked when another one isn't available.
Disable the requirement of a security token on this form instance. This security protects against CSRF attacks, but you should disable this if you don't want to tie a form to a session - eg a search form.
Returns the security token for this form (if any exists).
Returns the name of a field, if that's the only field that the current controller is interested in.
Set the current form action. Should only be called by Controller.
Add a CSS-class to the form-container. If needed, multiple classes can be added by delimiting a string with spaces.
Remove a CSS-class from the form-container. Multiple class names can be passed through as a space delimited string
Test an ajax submission of this form.
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(Controller $controller, string $name, FieldList $fields, FieldList $actions, Validator $validator = null)
Create a new form, with the given fields an action buttons.
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)
No description
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()
Returns a link to this controller. Overload with your own Link rules if they exist.
$this
setupFormErrors()
Set up current form errors in session to the current form if appropriate.
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
httpSubmission(SS_HTTPRequest $request)
Handle a form submission. GET and POST requests behave identically.
Populates the form with loadDataFrom()}, calls {@link validate(), and only triggers the requested form action/method if the form is valid.
protected SS_HTTPResponse|string
getValidationErrorResponse()
Returns the appropriate response up the controller chain if validate() fails (which is checked prior to executing any form actions).
By default, returns different views for ajax/non-ajax request, and handles 'application/json' requests with a JSON object containing the error messages. Behaviour can be influenced by setting $redirectToFormOnValidationError.
protected FormField
checkFieldsForAction(SS_List|array $fields, callable $funcName)
Fields can have action to, let's check if anyone of the responds to $funcname them
FormField
handleField(SS_HTTPRequest $request)
Handle a field request.
Uses Form->dataFieldByName() to find a matching field, and falls back to FieldList->fieldByName() to look for tabs instead. This means that if you have a tab and a formfield with the same name, this method gives priority to the formfield.
makeReadonly()
Convert this form into a readonly form
$this
setRedirectToFormOnValidationError(bool $bool)
Set whether the user should be redirected back down to the form on the page upon validation errors in the form or if they just need to redirect back to the page
bool
getRedirectToFormOnValidationError()
Get whether the user should be redirected back down to the form on the page upon validation errors
addErrorMessage(string $fieldName, string $message, string $messageType, bool $escapeHtml = true)
Add a plain text error message to a field on this form. It will be saved into the session and used the next time this form is displayed.
transform(FormTransformation $trans)
No description
unsetValidator()
Remove the Validator from this from.
transformTo(FormTransformation $format)
Convert this form to another format.
FieldList
getExtraFields()
Generate extra special fields - namely the security token field (if required).
FieldList
Fields()
Return the form's fields - used by the templates
FieldList
HiddenFields()
Return all fields in a form - including fields nested in CompositeFields.
Useful when doing custom field layouts.
VisibleFields()
Return all fields except for the hidden fields.
Useful when making your own simplified form layouts.
$this
setFields(FieldList $fields)
Setter for the form fields.
FieldList
Actions()
Return the form's action buttons - used by the templates
$this
setActions(FieldList $actions)
Setter for the form actions.
unsetAllActions()
Unset all form actions
$this
setAttribute(string $name, string $value)
No description
string
getAttribute($name)
No description
array
getAttributes()
No description
string
getAttributesHTML($attrs = null)
Return the attributes of the form tag - used by the templates.
FormAttributes()
No description
setTemplateHelper($helper)
Set the target of this form to any value - useful for opening the form contents in a new window or refreshing another frame
FormTemplateHelper
getTemplateHelper()
Return a FormTemplateHelper for this form. If one has not been set, return the default helper.
$this
setTarget(target $target)
Set the target of this form to any value - useful for opening the form contents in a new window or refreshing another frame.
$this
setLegend(string $legend)
Set the legend value to be inserted into the
$this
setTemplate(string $template)
Set the SS template that this form should use to render with. The default is "Form".
string
getTemplate()
Return the template to render this form with.
If the template isn't set, then default to the form class name e.g "Form".
getEncType()
Returns the encoding type for the form.
By default this will be URL encoded, unless there is a file field present in which case multipart is used. You can also set the enc type using setEncType.
$this
setEncType(string $encType)
Sets the form encoding type. The most common encoding types are defined in ENC_TYPE_URLENCODED} and {@link ENC_TYPE_MULTIPART.
string
FormHttpMethod()
Returns the real HTTP method for the form: GET, POST, PUT, DELETE or HEAD.
As most browsers only support GET and POST in form submissions, all other HTTP methods are added as a hidden field "_method" that gets evaluated in Director::direct(). See FormMethod() to get a HTTP method for safe insertion into a
string
FormMethod()
Returns the form method to be used in the
$this
setFormMethod(string $method, bool $strict = null)
Set the form method: GET, POST, PUT, DELETE.
$this
setStrictFormMethodCheck($bool)
If set to true, enforce the matching of the form method.
This will mean two things:
- GET vars will be ignored by a POST form, and vice versa
- A submission where the HTTP method used doesn't match the form will return a 400 error.
If set to false (the default), then the form method is only used to construct the default form.
bool
getStrictFormMethodCheck()
No description
string
FormAction()
Return the form's action attribute.
This is build by adding an executeForm get variable to the parent controller's Link() value
$this
setFormAction(string $path)
Set the form action attribute to a custom URL.
Note: For "normal" forms, you shouldn't need to use this method. It is recommended only for situations where you have two relatively distinct parts of the system trying to communicate via a form post.
string
FormName()
Returns the name of the form.
$this
setHTMLID(string $id)
Set the HTML ID attribute of the form.
string
getHTMLID()
No description
Controller
Controller()
deprecated
deprecated
Returns this form's controller.
Controller
getController()
Get the controller.
Form
setController(Controller $controller)
Set the controller.
string
getName()
Get the name of the form.
Form
setName(string $name)
Set the name of the form.
FieldMap()
Returns an object where there is a method with the same name as each data field on the form.
That method will return the field itself.
It means that you can execute $firstName = $form->FieldMap()->FirstName()
string
Message()
The next functions store and modify the forms message attributes. messages are stored in session under $_SESSION[formname][message];
string
MessageType()
No description
protected string
getMessageFromSession()
No description
$this
setMessage(string $message, string $type, bool $escapeHtml = true)
Set a status message for the form.
sessionMessage(string $message, string $type, bool $escapeHtml = true)
Set a message to the session, for display next time this form is shown.
static
messageForForm($formName, $message, $type, $escapeHtml = true)
No description
clearMessage()
No description
resetValidation()
No description
DataObject
getRecord()
Returns the DataObject that has given this form its data through loadDataFrom().
string
getLegend()
Get the legend value to be inserted into the
bool
validate()
Processing that occurs before a form is executed.
This includes form validation, if it fails, we redirect back to the form with appropriate error messages.
Triggered through httpSubmission().
Note that CSRF protection takes place in httpSubmission(), if it fails the form data will never reach this method.
Form
loadDataFrom(array|DataObject $data, int $mergeStrategy = 0, array $fieldList = null)
Load data from the given DataObject or array.
It will call $object->MyField to get the value of MyField. If you passed an array, it will call $object[MyField]. Doesn't save into dataless FormFields (DatalessField), as determined by FieldList->dataFields().
By default, if a field isn't set (as determined by isset()), its value will not be saved to the field, retaining potential existing values.
Passed data should not be escaped, and is saved to the FormField instances unescaped. Escaping happens automatically on saving the data through saveInto().
Escaping happens automatically on saving the data through saveInto().
saveInto(DataObjectInterface $dataObject, FieldList $fieldList = null)
Save the contents of this form into the given data object.
It will make use of setCastedField() to do this.
array
getData()
Get the submitted data from this form through FieldList->dataFields(), which filters out any form-specific data like form-actions.
Calls FormField->dataValue() on each field, which returns a value suitable for insertion into a DataObject property.
mixed
callfieldmethod(array $data)
Call the given method on the given field.
HTML
forTemplate()
Return a rendered version of this form.
This is returned when you access a form as $FormObject rather than <% with FormObject %>
HTML
forAjaxTemplate()
Return a rendered version of this form, suitable for ajax post-back.
It triggers slightly different behaviour, such as disabling the rewriting of # links.
HTML
formHtmlContent()
Returns an HTML rendition of this form, without the
HTMLText
renderWithoutActionButton(string|array $template)
Render this form using the given template, and return the result as a string You can pass either an SSViewer or a template name
$this
setButtonClicked(callable $funcName)
Sets the button that was clicked. This should only be called by the Controller.
FormAction
buttonClicked()
No description
protected array
getAllActions()
Get a list of all actions, including those in the main "fields" FieldList
FormAction
defaultAction()
Return the default button that should be clicked when another one isn't available.
Form
disableDefaultAction()
Disable the default button.
Ordinarily, when a form is processed and no action_XXX button is available, then the first button in the actions list will be pressed. However, if this is "delete", for example, this isn't such a good idea.
Form
disableSecurityToken()
Disable the requirement of a security token on this form instance. This security protects against CSRF attacks, but you should disable this if you don't want to tie a form to a session - eg a search form.
Check for token state with getSecurityToken() and SecurityToken->isEnabled().
Form
enableSecurityToken()
Enable SecurityToken protection for this form instance.
Check for token state with getSecurityToken() and SecurityToken->isEnabled().
SecurityToken|null
getSecurityToken()
Returns the security token for this form (if any exists).
Doesn't check for securityTokenEnabled().
Use SecurityToken::inst() to get a global token.
static string
single_field_required()
Returns the name of a field, if that's the only field that the current controller is interested in.
It checks for a call to the callfieldmethod action.
static string
current_action()
Return the current form action being called, if available.
static
set_current_action(string $action)
Set the current form action. Should only be called by Controller.
string
extraClass()
Compiles all CSS-classes.
$this
addExtraClass(string $class)
Add a CSS-class to the form-container. If needed, multiple classes can be added by delimiting a string with spaces.
$this
removeExtraClass(string $class)
Remove a CSS-class from the form-container. Multiple class names can be passed through as a space delimited string
debug()
No description
SS_HTTPResponse
testSubmission(string $action, array $data)
Test a submission of this form.
SS_HTTPResponse
testAjaxSubmission(string $action, array $data)
Test an ajax submission of this form.