Form
class Form extends RequestHandler
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 {@link FormAction}). This method will be passed two parameters: the raw request data, and the form object. Usually you want to save data into a {@link DataObject} by using {@link saveInto()}. If you want to process the submitted data in any way, please use {@link getData()} rather than the raw request data.
Validation
Each form needs some form of {@link 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 {@link RequiredFields}. If you want to enforce serverside-validation to be ignored for a specific {@link FormField}, you need to subclass it.
URL Handling
The form class extends {@link 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
<
form action="..."> value. For example, the edit form in the CMS would be located at "admin/EditForm". This URL will render the form without its surrounding template when called through GET instead of POST.
By appending to this URL, you can render individual form elements through the {@link FormField->FieldHolder()} method. For example, the "URLSegment" field in a standard CMS form would be accessible through "admin/EditForm/field/URLSegment/FieldHolder".
Constants
| ENC_TYPE_URLENCODED |
|
| ENC_TYPE_MULTIPART |
|
| MERGE_DEFAULT |
|
| MERGE_CLEAR_MISSING |
|
| MERGE_IGNORE_FALSEISH |
|
Config options
| default_classes | array |
Properties
| string | $class | from SS_Object | |
| boolean | $IncludeFormTag |
Methods
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .
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 {@link Object::create()}, except that classes are only overloaded if you set the $strong parameter to TRUE when using {@link Object::useCustomClass()}
This class allows you to overload classes with other classes when they are constructed using the factory method {@link 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
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 {@link 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 {@link $extension_instances}. Extension instances are initialized at constructor time, meaning if you use {@link add_extension()} afterwards, the added extension will just be added to new instances of the extended class. Use the static method {@link 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
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 {@link 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 {@link 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 {@link 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.
Add methods from the {@link ViewableData::$failover} object, as well as wrapping any methods prefixed with an underscore into a {@link ViewableData::cachedCall()}.
Method to facilitate deprecation of underscore-prefixed methods automatically being cached.
Merge some arbitrary data in with this object. This method returns a {@link 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 {@link 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
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 {@link 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.
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
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.
No description
Throws a HTTP error response encased in a {@link SS_HTTPResponse_Exception}, which is later caught in {@link RequestHandler::handleAction()} and returned to the user.
Returns the SS_HTTPRequest object that this controller is using.
Typically the request is set through {@link handleAction()} or {@link 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.
Handle a form submission. GET and POST requests behave identically.
Convert this form into a readonly form
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.
Get the {@link Validator} attached to this form.
Remove the {@link Validator} from this from.
Generate extra special fields - namely the security token field (if required).
Return all fields in a form - including fields nested in {@link CompositeFields}.
Return all fields except for the hidden fields.
Unset all form actions
No description
No description
No description
Return the attributes of the form tag - used by the templates.
No description
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 {@link 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 legend value to be inserted into the
<
legend> element in the Form.ss template.
Set the SS template that this form should use to render with. The default is "Form".
Return the template to render this form with.
Returns the encoding type for the form.
Sets the form encoding type. The most common encoding types are defined in {@link 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.
No description
Return the form's action attribute.
Set the form action attribute to a custom URL.
Returns the name of the form.
Set the HTML ID attribute of the form.
No description
Get the controller.
Get the name of the form.
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];
No description
Set a status message for the form.
Set a message to the session, for display next time this form is shown.
No description
No description
No description
Returns the DataObject that has given this form its data through {@link loadDataFrom()}.
Processing that occurs before a form is executed.
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 {@link FieldList->dataFields()}, which filters out any form-specific data like form-actions.
Call the given method on the given field.
Return a rendered version of this form.
Return a rendered version of this form, suitable for ajax post-back.
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.
No description
Return the default button that should be clicked when another one isn't available.
Disable the default button.
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.
Enable {@link SecurityToken} protection for this form instance.
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.
Return the current form action being called, if available.
Set the current form action. Should only be called by {@link Controller}.
Compiles all CSS-classes.
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
No description
Test a submission of this form.
Test an ajax submission of this form.
Details
in SS_Object at line 60
static Config_ForClass|null
config()
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .
....).
in SS_Object at line 132
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 {@link 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();
in SS_Object at line 155
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).
in SS_Object at line 190
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.
in SS_Object at line 215
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
in SS_Object at line 341
static SS_Object
strong_create()
Similar to {@link Object::create()}, except that classes are only overloaded if you set the $strong parameter to TRUE when using {@link Object::useCustomClass()}
in SS_Object at line 361
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 {@link Object::create()}
in SS_Object at line 375
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
in SS_Object at line 396
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.
in SS_Object at line 436
static
get_static($class, $name, $uncached = false)
deprecated
deprecated
in SS_Object at line 444
static
set_static($class, $name, $value)
deprecated
deprecated
in SS_Object at line 452
static
uninherited_static($class, $name, $uncached = false)
deprecated
deprecated
in SS_Object at line 460
static
combined_static($class, $name, $ceiling = false)
deprecated
deprecated
in SS_Object at line 470
static
addStaticVars($class, $properties, $replace = false)
deprecated
deprecated
in SS_Object at line 478
static
add_static_var($class, $name, $value, $replace = false)
deprecated
deprecated
in SS_Object at line 494
static
has_extension(string $classOrExtension, string $requiredExtension = null, boolean $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))
in SS_Object at line 536
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 {@link Object::$extensions} array. See {@link 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 {@link singleton()}).
in SS_Object at line 594
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 {@link Object} instances which are already created, but will have an effect on new extensions. Clears any previously created singletons through {@link singleton()} to avoid side-effects from stale extension information.
in SS_Object at line 633
static array
get_extensions(string $class, bool $includeArgumentString = false)
in SS_Object at line 655
static
get_extra_config_sources($class = null)
at line 232
__construct(Controller $controller, string $name, FieldList $fields, FieldList $actions, Validator $validator = null)
Create a new form, with the given fields an action buttons.
in SS_Object at line 725
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 {@link Extensions}, {@link Object::createMethod()} or {@link Object::addWrapperMethod()}
in SS_Object at line 792
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
in SS_Object at line 802
array
allMethodNames(bool $custom = false)
Return the names of all the methods available on this object
in SS_Object at line 963
stat($name, $uncached = false)
in SS_Object at line 970
set_stat($name, $value)
in SS_Object at line 977
uninherited($name)
in SS_Object at line 991
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 {@link DataObject} class could return false when it is deleted from the database
in SS_Object at line 998
string
parentClass()
in SS_Object at line 1008
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
in SS_Object at line 1015
string
__toString()
in SS_Object at line 1030
mixed
invokeWithExtensions(string $method, mixed $argument = null)
Calls a method if available on both this object and all applied {@link Extensions}, and then attempts to merge all results into an array
in SS_Object at line 1058
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 {@link __construct()} in {@link defineMethods()}.
in SS_Object at line 1097
Extension
getExtensionInstance(string $extension)
Get an extension instance attached to this object by name.
in SS_Object at line 1115
bool
hasExtension(string $extension)
Returns TRUE if this object instance has a specific extension applied in {@link $extension_instances}. Extension instances are initialized at constructor time, meaning if you use {@link add_extension()} afterwards, the added extension will just be added to new instances of the extended class. Use the static method {@link has_extension()} to check if a class (not an instance) has a specific extension.
Caution: Don't use singleton(
in SS_Object at line 1126
array
getExtensionInstances()
Get all extension instances for this specific object instance.
See {@link get_extensions()} to get all applied extension classes for this class (not the instance).
in SS_Object at line 1142
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
in SS_Object at line 1171
clearCache($method, $ID = false, $arguments = array())
Clears the cache for the given cacheToFile call
in ViewableData at line 72
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);".
in ViewableData at line 83
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 {@link castingObjectCreator} for more information about the constructor.
in ViewableData at line 95
bool
__isset(string $property)
Check if a field exists on this object or its failover.
in ViewableData at line 117
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 {@link ViewableData::getField()}, then fall back on a failover object.
in ViewableData at line 138
__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 {@link ViewableData::setField()} method.
in ViewableData at line 151
setFailover(ViewableData $failover)
Set a failover object to attempt to get data from if it is not present on this object.
in ViewableData at line 166
ViewableData|null
getFailover()
Get the current failover object if set
in ViewableData at line 176
bool
hasField(string $field)
Check if a field exists on this object. This should be overloaded in child classes.
in ViewableData at line 186
mixed
getField(string $field)
Get the value of a field on this object. This should be overloaded in child classes.
in ViewableData at line 196
setField(string $field, mixed $value)
Set a field on this object. This should be overloaded in child classes.
in ViewableData at line 206
defineMethods()
Add methods from the {@link ViewableData::$failover} object, as well as wrapping any methods prefixed with an underscore into a {@link ViewableData::cachedCall()}.
in ViewableData at line 236
unknown
deprecatedCachedCall($method, $args = null, $identifier = null)
Method to facilitate deprecation of underscore-prefixed methods automatically being cached.
in ViewableData at line 255
ViewableData_Customised
customise(array|ViewableData $data)
Merge some arbitrary data in with this object. This method returns a {@link 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.
in ViewableData at line 272
ViewableData
getCustomisedObj()
in ViewableData at line 279
setCustomisedObj(ViewableData $object)
in ViewableData at line 296
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 {@link 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)")
in ViewableData at line 308
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.
in ViewableData at line 331
string
castingClass(string $field)
Get the class name a field on this object will be casted to
in ViewableData at line 346
string
escapeTypeForField(string $field)
Return the string-format type for the given field.
in ViewableData at line 357
buildCastingCache(reference $cache)
Save the casting cache for this object (including data from any failovers) into a variable
in ViewableData at line 394
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
in ViewableData at line 456
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.
in ViewableData at line 503
cachedCall(string $field, array $arguments = null, string $identifier = null)
A simple wrapper around {@link ViewableData::obj()} that automatically caches the result so it can be used again without re-running the method.
in ViewableData at line 516
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.
in ViewableData at line 538
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.
in ViewableData at line 546
RAW_val($field, $arguments = null, $cache = true)
Return the value of the field without any escaping being applied.
in ViewableData at line 553
SQL_val($field, $arguments = null, $cache = true)
Return the value of a field in an SQL-safe format.
in ViewableData at line 560
JS_val($field, $arguments = null, $cache = true)
Return the value of a field in a JavaScript-save format.
in ViewableData at line 567
ATT_val($field, $arguments = null, $cache = true)
Return the value of a field escaped suitable to be inserted into an XML node attribute.
in ViewableData at line 579
array
getXMLValues($fields)
Get an array of XML-escaped values by field name
in ViewableData at line 599
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.
in ViewableData at line 611
ViewableData
Me()
When rendering some objects it is necessary to iterate over the object being rendered, to do this, you need access to itself.
in ViewableData at line 627
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.
in ViewableData at line 648
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".
in ViewableData at line 671
ViewableData_Debugger
Debug()
Return debug information about this object that can be rendered into a template
in RequestHandler at line 133
setDataModel($model)
Set the DataModel for this request.
in RequestHandler at line 158
SS_HTTPResponse|RequestHandler|string|array
handleRequest(SS_HTTPRequest $request, DataModel $model)
Handles URL requests.
- ViewableData::handleRequest() iterates through each rule in {@link 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.
in RequestHandler at line 316
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.
in RequestHandler at line 358
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.
at line 481
checkAccessAction($action)
in RequestHandler at line 472
httpError(int $errorCode, string $errorMessage = null)
Throws a HTTP error response encased in a {@link SS_HTTPResponse_Exception}, which is later caught in {@link RequestHandler::handleAction()} and returned to the user.
in RequestHandler at line 494
SS_HTTPRequest|NullHTTPRequest
getRequest()
Returns the SS_HTTPRequest object that this controller is using.
Returns a placeholder {@link NullHTTPRequest} object unless {@link handleAction()} or {@link handleRequest()} have been called, which adds a reference to an actual {@link SS_HTTPRequest} object.
in RequestHandler at line 504
setRequest(SS_HTTPRequest $request)
Typically the request is set through {@link handleAction()} or {@link handleRequest()}, but in some based we want to set it manually.
in RequestHandler at line 514
string
Link()
Returns a link to this controller. Overload with your own Link rules if they exist.
at line 293
$this
setupFormErrors()
Set up current form errors in session to the current form if appropriate.
at line 341
httpSubmission(SS_HTTPRequest $request)
Handle a form submission. GET and POST requests behave identically.
Populates the form with {@link loadDataFrom()}, calls {@link validate()}, and only triggers the requested form action/method if the form is valid.
at line 574
FormField
handleField(SS_HTTPRequest $request)
Handle a field request.
Uses {@link Form->dataFieldByName()} to find a matching field, and falls back to {@link 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.
at line 588
makeReadonly()
Convert this form into a readonly form
at line 600
$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
at line 611
bool
getRedirectToFormOnValidationError()
Get whether the user should be redirected back down to the form on the page upon validation errors
at line 623
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.
at line 634
transform(FormTransformation $trans)
at line 657
Validator
getValidator()
Get the {@link Validator} attached to this form.
at line 666
$this
setValidator(Validator $validator)
Set the {@link Validator} on this form.
at line 677
unsetValidator()
Remove the {@link Validator} from this from.
at line 686
transformTo(FormTransformation $format)
Convert this form to another format.
at line 704
FieldList
getExtraFields()
Generate extra special fields - namely the security token field (if required).
at line 729
FieldList
Fields()
Return the form's fields - used by the templates
at line 744
FieldList
HiddenFields()
Return all fields in a form - including fields nested in {@link CompositeFields}.
Useful when doing custom field layouts.
at line 752
VisibleFields()
Return all fields except for the hidden fields.
Useful when making your own simplified form layouts.
at line 762
$this
setFields(FieldList $fields)
Setter for the form fields.
at line 772
FieldList
Actions()
Return the form's action buttons - used by the templates
at line 782
$this
setActions(FieldList $actions)
Setter for the form actions.
at line 790
unsetAllActions()
Unset all form actions
at line 800
$this
setAttribute(string $name, string $value)
at line 808
string
getAttribute($name)
at line 815
array
getAttributes()
at line 843
string
getAttributesHTML(array $attrs = null)
Return the attributes of the form tag - used by the templates.
at line 885
FormAttributes()
at line 895
setTemplateHelper(string|FormTemplateHelper $helper)
Set the target of this form to any value - useful for opening the form contents in a new window or refreshing another frame
at line 905
FormTemplateHelper
getTemplateHelper()
Return a {@link FormTemplateHelper} for this form. If one has not been set, return the default helper.
at line 924
$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.
at line 936
$this
setLegend(string $legend)
Set the legend value to be inserted into the
<
legend> element in the Form.ss template.
at line 948
$this
setTemplate(string $template)
Set the SS template that this form should use to render with. The default is "Form".
at line 960
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".
at line 972
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 {@link setEncType}.
at line 993
$this
setEncType(string $encType)
Sets the form encoding type. The most common encoding types are defined in {@link ENC_TYPE_URLENCODED} and {@link ENC_TYPE_MULTIPART}.
at line 1010
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 {@link Director::direct()}. See {@link FormMethod()} to get a HTTP method for safe insertion into a
<
form> tag.
at line 1020
string
FormMethod()
Returns the form method to be used in the
<
form> tag.
See {@link FormHttpMethod()} to get the "real" method.
at line 1035
$this
setFormMethod(string $method, bool $strict = null)
Set the form method: GET, POST, PUT, DELETE.
at line 1054
$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.
at line 1062
boolean
getStrictFormMethodCheck()
at line 1072
string
FormAction()
Return the form's action attribute.
This is build by adding an executeForm get variable to the parent controller's Link() value
at line 1099
$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.
at line 1110
string
FormName()
Returns the name of the form.
at line 1120
$this
setHTMLID(string $id)
Set the HTML ID attribute of the form.
at line 1129
string
getHTMLID()
at line 1139
Controller
Controller()
deprecated
deprecated 4.0
Returns this form's controller.
at line 1150
Controller
getController()
Get the controller.
at line 1160
Form
setController(Controller $controller)
Set the controller.
at line 1171
string
getName()
Get the name of the form.
at line 1181
Form
setName(string $name)
Set the name of the form.
at line 1195
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()
at line 1206
string
Message()
The next functions store and modify the forms message attributes. messages are stored in session under $_SESSION[formname][message];
at line 1215
string
MessageType()
at line 1245
$this
setMessage(string $message, string $type, boolean $escapeHtml = true)
Set a status message for the form.
at line 1260
sessionMessage(string $message, string $type, boolean $escapeHtml = true)
Set a message to the session, for display next time this form is shown.
at line 1268
static
messageForForm($formName, $message, $type, $escapeHtml = true)
at line 1276
clearMessage()
at line 1283
resetValidation()
at line 1294
DataObject
getRecord()
Returns the DataObject that has given this form its data through {@link loadDataFrom()}.
at line 1304
string
getLegend()
Get the legend value to be inserted into the
<
legend> element in Form.ss
at line 1321
boolean
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 {@link httpSubmission()}.
Note that CSRF protection takes place in {@link httpSubmission()}, if it fails the form data will never reach this method.
at line 1400
Form
loadDataFrom(array|DataObject $data, int $mergeStrategy, 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 ({@link DatalessField}), as determined by {@link 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 {@link saveInto()}.
Escaping happens automatically on saving the data through {@link saveInto()}.
at line 1503
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.
at line 1534
array
getData()
Get the submitted data from this form through {@link FieldList->dataFields()}, which filters out any form-specific data like form-actions.
Calls {@link FormField->dataValue()} on each field, which returns a value suitable for insertion into a DataObject property.
at line 1555
mixed
callfieldmethod(array $data)
Call the given method on the given field.
at line 1586
HTML
forTemplate()
Return a rendered version of this form.
This is returned when you access a form as $FormObject rather than <% with FormObject %>
at line 1606
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.
at line 1629
HTML
formHtmlContent()
Returns an HTML rendition of this form, without the
<
form> tag itself.
Attaches 3 extra hidden files, _form_action, _form_name, _form_method, and _form_enctype. These are the attributes of the form. These fields can be used to send the form to Ajax.
at line 1649
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
at line 1668
$this
setButtonClicked(callable $funcName)
Sets the button that was clicked. This should only be called by the Controller.
at line 1677
FormAction
buttonClicked()
at line 1711
FormAction
defaultAction()
Return the default button that should be clicked when another one isn't available.
at line 1726
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.
at line 1742
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 {@link getSecurityToken()} and {@link SecurityToken->isEnabled()}.
at line 1756
Form
enableSecurityToken()
Enable {@link SecurityToken} protection for this form instance.
Check for token state with {@link getSecurityToken()} and {@link SecurityToken->isEnabled()}.
at line 1771
SecurityToken|null
getSecurityToken()
Returns the security token for this form (if any exists).
Doesn't check for {@link securityTokenEnabled()}.
Use {@link SecurityToken::inst()} to get a global token.
at line 1783
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.
at line 1794
static string
current_action()
Return the current form action being called, if available.
at line 1803
static
set_current_action(string $action)
Set the current form action. Should only be called by {@link Controller}.
at line 1812
string
extraClass()
Compiles all CSS-classes.
at line 1824
$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.
at line 1841
$this
removeExtraClass(string $class)
Remove a CSS-class from the form-container. Multiple class names can be passed through as a space delimited string
at line 1851
debug()
at line 1877
SS_HTTPResponse
testSubmission(string $action, array $data)
Test a submission of this form.
at line 1891
SS_HTTPResponse
testAjaxSubmission(string $action, array $data)
Test an ajax submission of this form.