class Form extends ViewableData implements HasRequestHandler (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 {@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

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".

Traits

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

DEFAULT_NAME

Default form Name property

ENC_TYPE_URLENCODED

Form submission data is URL encoded

ENC_TYPE_MULTIPART

Form submission data is multipart form

MERGE_DEFAULT

MERGE_CLEAR_MISSING

MERGE_IGNORE_FALSEISH

MERGE_AS_INTERNAL_VALUE

MERGE_AS_SUBMITTED_VALUE

Properties

static private array $extensions

An array of extension names and parameters to be applied to this object upon construction.

from  Extensible
static private array $casting
static private string $default_cast

The default object to cast scalar fields to if casting information is not specified, and casting to an object is required.

from  ViewableData
bool $IncludeFormTag

Accessed by Form.ss; modified by {@link formHtmlContent()}.

static private array $default_classes

Methods

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

bool
hasMethod(string $method)

Return TRUE if a method exists on this object

array
allMethodNames(bool $custom = false)

Return the names of all the methods available on this object

static bool
add_extension(string $classOrExtension, string $extension = null)

Add an extension to a specific class.

static 
remove_extension(string $extension)

Remove an extension from a class.

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.

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 {@link 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

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 {@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.

getExtensionInstances()

Get all extension instances for this specific object instance.

static Injectable
create(array ...$args)

An implementation of the factory method, allows you to create an instance of a class

static Injectable
singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

static Config_ForClass
config()

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).

mixed
stat(string $name) 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

Update the config value for a given property

__construct(RequestHandler $controller = null, string $name = self::DEFAULT_NAME, FieldList $fields = null, FieldList $actions = null, Validator $validator = null)

Create a new form, with the given fields an action buttons.

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 {@link 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 {@link ViewableData::setField()} method.

setFailover(ViewableData $failover)

Set a failover object to attempt to get data from if it is not present on this object.

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.

defineMethods()

Add methods from the {@link ViewableData::$failover} object, as well as wrapping any methods prefixed with an underscore into a {@link ViewableData::cachedCall()}.

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.

bool
exists()

Return true if this object "exists" i.e. has a sensible value

string
__toString()

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.

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

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 {@link 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

getIterator()

Return a single-item iterator so you can iterate over the fields of a single record.

array
getViewerTemplates(string $suffix = '')

Find appropriate templates for SSViewer to use to render this object

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

Return the directory if the current active theme (relative to the site root).

string
CSSClasses(string $stopAtClass = self::class)

Get part of the current classes ancestry to be used as a CSS class.

Debug()

Return debug information about this object that can be rendered into a template

string
getMessage()

Returns the field message, used by form validation.

string
getMessageType()

Returns the field message type.

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.

array|null
getSchemaMessage()

Get form schema encoded message

bool
getNotifyUnsavedChanges()

No description

setNotifyUnsavedChanges(bool $flag)

No description

$this
restoreFormState()

Load form state from session state

$this
clearFormState()

Flush persistant form state details

array
getSessionData()

Return any form data stored in the session

$this
setSessionData(array $data)

Store the given form data in the session

getSessionValidationResult()

Return any ValidationResult instance stored for this object

$this
setSessionValidationResult(ValidationResult $result, bool $combineWithExisting = false)

Sets the ValidationResult in the session to be used with the next view of this form.

$this
clearMessage()

Clear form message (and in session)

$this
loadMessagesFrom(ValidationResult $result)

Populate this form with messages from the given ValidationResult.

$this
setFieldMessage(string $fieldName, string $message, string $messageType = ValidationResult::TYPE_ERROR, string $messageCast = ValidationResult::CAST_TEXT)

Set message on a given field name. This message will not persist via redirect.

callable
setValidationResponseCallback($callback)

Overrules validation error behaviour in {@link httpSubmission()} when validation has failed. Useful for optional handling of a certain accepted content type.

$this
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

transform(FormTransformation $trans)

No description

getValidator()

Get the {@link Validator} attached to this form.

$this
setValidator(Validator $validator)

Set the {@link Validator} on this form.

unsetValidator()

Remove the {@link Validator} from this from.

$this
setValidationExemptActions(array $actions)

Set actions that are exempt from validation

array
getValidationExemptActions()

Get a list of actions that are exempt from validation

bool
actionIsValidationExempt(FormAction $action)

Passed a FormAction, returns true if that action is exempt from Form validation

getExtraFields()

Generate extra special fields - namely the security token field (if required).

Fields()

Return the form's fields - used by the templates

HiddenFields()

Return all fields in a form - including fields nested in {@link CompositeFields}.

VisibleFields()

Return all fields except for the hidden fields.

$this
setFields(FieldList $fields)

Setter for the form fields.

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(string $name)

No description

array
getAttributes()

No description

string
getAttributesHTML(array $attrs = null)

Return the attributes of the form tag - used by the templates.

FormAttributes()

No description

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

getTemplateHelper()

Return a {@link FormTemplateHelper} for this form. If one has not been set, return the default helper.

$this
setTarget(string $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 element in the Form.ss template.

$this
setTemplate(string|array $template)

Set the SS template that this form should use to render with. The default is "Form".

string|array
getTemplate()

Return the template to render this form with.

array
getTemplates()

Returs the ordered list of preferred templates for rendering this form If the template isn't set, then default to the form class name e.g "Form".

getEncType()

Returns the encoding type for the form.

$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}.

string
FormHttpMethod()

Returns the real HTTP method for the form: GET, POST, PUT, DELETE or HEAD.

string
FormMethod()

Returns the form method to be used in the tag.

$this
setFormMethod(string $method, bool $strict = null)

Set the form method: GET, POST, PUT, DELETE.

$this
setStrictFormMethodCheck($bool)

If set to true (the default), enforces the matching of the form method.

bool
getStrictFormMethodCheck()

No description

string
FormAction()

Return the form's action attribute.

$this
setFormAction(string $path)

Set the form action attribute to a custom URL.

string
FormName()

Returns the name of the form.

$this
setHTMLID(string $id)

Set the HTML ID attribute of the form.

string
getHTMLID()

No description

getController()

Get the controller or parent request handler.

$this
setController(RequestHandler $controller = null)

Set the controller or parent request handler.

string
getName()

Get the name of the 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.

sessionMessage(string $message, string $type = ValidationResult::TYPE_ERROR, string|bool $cast = ValidationResult::CAST_TEXT)

Set a message to the session, for display next time this form is shown.

sessionError(string $message, string $type = ValidationResult::TYPE_ERROR, string|bool $cast = ValidationResult::CAST_TEXT)

Set an error to the session, for display next time this form is shown.

sessionFieldError(string $message, string $fieldName, string $type = ValidationResult::TYPE_ERROR, string|bool $cast = ValidationResult::CAST_TEXT)

Set an error message for a field in the session, for display next time this form is shown.

getRecord()

Returns the DataObject that has given this form its data through {@link loadDataFrom()}.

string
getLegend()

Get the legend value to be inserted into the

element in Form.ss

validationResult()

Processing that occurs before a form is executed.

$this
loadDataFrom(array|DataObject $data, int $mergeStrategy = 0, array $fieldList = null)

Load data from the given DataObject or array.

saveInto(DataObjectInterface $dataObject, FieldList $fieldList = null)

Save the contents of this form into the given data object.

array
getData()

Get the submitted data from this form through {@link FieldList->dataFields()}, which filters out any form-specific data like form-actions.

forTemplate()

Return a rendered version of this form.

forAjaxTemplate()

Return a rendered version of this form, suitable for ajax post-back.

string
formHtmlContent() deprecated

Returns an HTML rendition of this form, without the tag itself.

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

defaultAction()

Return the default button that should be clicked when another one isn't available.

disableDefaultAction()

Disable the default button.

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.

enableSecurityToken()

Enable {@link SecurityToken} protection for this form instance.

getSecurityToken()

Returns the security token for this form (if any exists).

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

getRequestHandler()

Get request handler for this form

$this
setRequestHandler(FormRequestHandler $handler)

Assign a specific request handler for this form

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 {@link Extensions}, {@link Object::createMethod()} or {@link Object::addWrapperMethod()}

Parameters

string $method
array $arguments

Return Value

mixed

Exceptions

BadMethodCallException

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

Parameters

string $method

Return Value

bool

array allMethodNames(bool $custom = false)

Return the names of all the methods available on this object

Parameters

bool $custom

include methods added dynamically at runtime

Return Value

array

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 {@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()}).

Parameters

string $classOrExtension

Class that should be extended - has to be a subclass of {@link Object}

string $extension

Subclass of {@link Extension} with optional parameters as a string, e.g. "Versioned" or "Translatable('Param')"

Return Value

bool

Flag if the extension was added

See also

http://doc.silverstripe.org/framework/en/trunk/reference/dataextension

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 {@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.

Parameters

string $extension

class name of an {@link Extension} subclass, without parameters

static array get_extensions(string $class = null, bool $includeArgumentString = false)

Parameters

string $class

If omitted, will get extensions for the current class

bool $includeArgumentString

Include the argument string in the return array, FALSE would return array("Versioned"), TRUE returns array("Versioned('Stage','Live')").

Return Value

array

Numeric array of either {@link DataExtension} class names, or eval'ed class name strings with constructor arguments.

static array|null get_extra_config_sources(string $class = null)

Get extra config sources for this class

Parameters

string $class

Name of class. If left null will return for the current class

Return Value

array|null

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))

Parameters

string $classOrExtension

Class to check extension for, or the extension name to check if the second argument is null.

string $requiredExtension

If the first argument is the parent class, this is the extension to check. If left null, the first parameter will be treated as the extension.

bool $strict

if the extension has to match the required extension and not be a subclass

Return Value

bool

Flag if the extension exists

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 {@link Extensions}, and then attempts to merge all results into an array

Parameters

string $method

the method name to call

mixed $a1
mixed $a2
mixed $a3
mixed $a4
mixed $a5
mixed $a6
mixed $a7

Return Value

array

List of results with nulls filtered out

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()}.

Parameters

string $method

the name of the method to call on each extension

mixed $a1
mixed $a2
mixed $a3
mixed $a4
mixed $a5
mixed $a6
mixed $a7

Return Value

array

Extension|null getExtensionInstance(string $extension)

Get an extension instance attached to this object by name.

Parameters

string $extension

Return Value

Extension|null

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()->hasExtension() as it will give you inconsistent results based on when the singleton was first accessed.

Parameters

string $extension

Classname of an {@link Extension} subclass without parameters

Return Value

bool

Extension[] 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).

This method also provides lazy-population of the extension_instances property.

Return Value

Extension[]

Map of {@link DataExtension} instances, keyed by classname.

static Injectable create(array ...$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'); $list = SiteTree::get();

Parameters

array ...$args

Return Value

Injectable

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).

Parameters

string $class

Optional classname to create, if the called class should not be used

Return Value

Injectable

The singleton instance

static Config_ForClass config()

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).

Return Value

Config_ForClass

mixed stat(string $name) deprecated

deprecated 5.0 Use ->config()->get() instead

Get inherited config value

Parameters

string $name

Return Value

mixed

mixed uninherited(string $name)

Gets the uninherited value for the given config option

Parameters

string $name

Return Value

mixed

$this set_stat(string $name, mixed $value) deprecated

deprecated 5.0 Use ->config()->set() instead

Update the config value for a given property

Parameters

string $name
mixed $value

Return Value

$this

__construct(RequestHandler $controller = null, string $name = self::DEFAULT_NAME, FieldList $fields = null, FieldList $actions = null, Validator $validator = null)

Create a new form, with the given fields an action buttons.

Parameters

RequestHandler $controller

Optional parent request handler

string $name

The method on the controller that will return this form object.

FieldList $fields

All of the fields in the form - a {@link FieldList} of {@link FormField} objects.

FieldList $actions

All of the action buttons in the form - a {@link FieldLis} of {@link FormAction} objects

Validator $validator

Override the default validator instance (Default: {@link RequiredFields})

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.

Parameters

string $property

Return Value

bool

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.

Parameters

string $property

Return Value

mixed

__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.

Parameters

string $property
mixed $value

setFailover(ViewableData $failover)

Set a failover object to attempt to get data from if it is not present on this object.

Parameters

ViewableData $failover

ViewableData|null getFailover()

Get the current failover object if set

Return Value

ViewableData|null

bool hasField(string $field)

Check if a field exists on this object. This should be overloaded in child classes.

Parameters

string $field

Return Value

bool

mixed getField(string $field)

Get the value of a field on this object. This should be overloaded in child classes.

Parameters

string $field

Return Value

mixed

$this setField(string $field, mixed $value)

Set a field on this object. This should be overloaded in child classes.

Parameters

string $field
mixed $value

Return Value

$this

defineMethods()

Add methods from the {@link ViewableData::$failover} object, as well as wrapping any methods prefixed with an underscore into a {@link ViewableData::cachedCall()}.

Exceptions

LogicException

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.

Parameters

array|ViewableData $data

Return Value

ViewableData_Customised

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

Return Value

bool

string __toString()

Return Value

string

the class name

ViewableData getCustomisedObj()

Return Value

ViewableData

setCustomisedObj(ViewableData $object)

Parameters

ViewableData $object

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.

Parameters

string $field

Return Value

string

Casting helper As a constructor pattern, and may include arguments.

Exceptions

Exception

string castingClass(string $field)

Get the class name a field on this object will be casted to.

Parameters

string $field

Return Value

string

string escapeTypeForField(string $field)

Return the string-format type for the given field.

Parameters

string $field

Return Value

string

'xml'|'raw'

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

Parameters

string|array|SSViewer $template

the template to render into

array $customFields

fields to customise() the object with before rendering

Return Value

DBHTMLText

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.

Parameters

string $fieldName
array $arguments
bool $cache

Cache this object

string $cacheName

a custom cache name

Return Value

object|DBField

object|DBField cachedCall(string $field, array $arguments = [], 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.

Parameters

string $field
array $arguments
string $identifier

an optional custom cache identifier

Return Value

object|DBField

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.

Parameters

string $field
array $arguments
bool $cache

Return Value

bool

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.

Parameters

string $field
array $arguments
bool $cache

Return Value

string

array getXMLValues(array $fields)

Get an array of XML-escaped values by field name

Parameters

array $fields

an array of field names

Return Value

array

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.

Return Value

ArrayIterator

array getViewerTemplates(string $suffix = '')

Find appropriate templates for SSViewer to use to render this object

Parameters

string $suffix

Return Value

array

ViewableData Me()

When rendering some objects it is necessary to iterate over the object being rendered, to do this, you need access to itself.

Return Value

ViewableData

string ThemeDir() deprecated

deprecated 4.0.0:5.0.0 Use $resourcePath or $resourceURL template helpers instead

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.

Return Value

string

URL to the current theme

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".

Parameters

string $stopAtClass

the class to stop at (default: ViewableData)

Return Value

string

ViewableData_Debugger Debug()

Return debug information about this object that can be rendered into a template

Return Value

ViewableData_Debugger

string getMessage()

Returns the field message, used by form validation.

Use {@link setError()} to set this property.

Return Value

string

string getMessageType()

Returns the field message type.

Arbitrary value which is mostly used for CSS classes in the rendered HTML, e.g "required".

Use {@link setError()} to set this property.

Return Value

string

string getMessageCast()

Casting type for this message. Will be 'text' or 'html'

Return Value

string

$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().

Parameters

string $message

Message string

string $messageType

Message type

string $messageCast

Return Value

$this

array|null getSchemaMessage()

Get form schema encoded message

Return Value

array|null

Message in array format, or null if no message

bool getNotifyUnsavedChanges()

Return Value

bool

setNotifyUnsavedChanges(bool $flag)

Parameters

bool $flag

$this restoreFormState()

Load form state from session state

Return Value

$this

$this clearFormState()

Flush persistant form state details

Return Value

$this

array getSessionData()

Return any form data stored in the session

Return Value

array

$this setSessionData(array $data)

Store the given form data in the session

Parameters

array $data

Return Value

$this

ValidationResult getSessionValidationResult()

Return any ValidationResult instance stored for this object

Return Value

ValidationResult

The ValidationResult object stored in the session

$this setSessionValidationResult(ValidationResult $result, bool $combineWithExisting = false)

Sets the ValidationResult in the session to be used with the next view of this form.

Parameters

ValidationResult $result

The result to save

bool $combineWithExisting

If true, then this will be added to the existing result.

Return Value

$this

$this clearMessage()

Clear form message (and in session)

Return Value

$this

$this loadMessagesFrom(ValidationResult $result)

Populate this form with messages from the given ValidationResult.

Note: This will not clear any pre-existing messages

Parameters

ValidationResult $result

Return Value

$this

$this setFieldMessage(string $fieldName, string $message, string $messageType = ValidationResult::TYPE_ERROR, string $messageCast = ValidationResult::CAST_TEXT)

Set message on a given field name. This message will not persist via redirect.

Parameters

string $fieldName
string $message
string $messageType
string $messageCast

Return Value

$this

callable getValidationResponseCallback()

Return Value

callable

Form setValidationResponseCallback($callback)

Overrules validation error behaviour in {@link httpSubmission()} when validation has failed. Useful for optional handling of a certain accepted content type.

The callback can opt out of handling specific responses by returning NULL, in which case the default form behaviour will kick in.

Parameters

$callback

Return Value

Form

$this makeReadonly()

Convert this form into a readonly form

Return Value

$this

$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

Parameters

bool $bool

Redirect to form on error?

Return Value

$this

bool getRedirectToFormOnValidationError()

Get whether the user should be redirected back down to the form on the page upon validation errors

Return Value

bool

transform(FormTransformation $trans)

Parameters

FormTransformation $trans

Validator getValidator()

Get the {@link Validator} attached to this form.

Return Value

Validator

$this setValidator(Validator $validator)

Set the {@link Validator} on this form.

Parameters

Validator $validator

Return Value

$this

unsetValidator()

Remove the {@link Validator} from this from.

$this setValidationExemptActions(array $actions)

Set actions that are exempt from validation

Parameters

array $actions

Return Value

$this

array getValidationExemptActions()

Get a list of actions that are exempt from validation

Return Value

array

bool actionIsValidationExempt(FormAction $action)

Passed a FormAction, returns true if that action is exempt from Form validation

Parameters

FormAction $action

Return Value

bool

FieldList getExtraFields()

Generate extra special fields - namely the security token field (if required).

Return Value

FieldList

FieldList Fields()

Return the form's fields - used by the templates

Return Value

FieldList

The form fields

FieldList HiddenFields()

Return all fields in a form - including fields nested in {@link CompositeFields}.

Useful when doing custom field layouts.

Return Value

FieldList

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.

Parameters

FieldList $fields

Return Value

$this

FieldList Actions()

Return the form's action buttons - used by the templates

Return Value

FieldList

The action list

$this setActions(FieldList $actions)

Setter for the form actions.

Parameters

FieldList $actions

Return Value

$this

unsetAllActions()

Unset all form actions

$this setAttribute(string $name, string $value)

Parameters

string $name
string $value

Return Value

$this

string getAttribute(string $name)

Parameters

string $name

Return Value

string

array getAttributes()

Return Value

array

string getAttributesHTML(array $attrs = null)

Return the attributes of the form tag - used by the templates.

Parameters

array $attrs

Custom attributes to process. Falls back to {@link getAttributes()}. If at least one argument is passed as a string, all arguments act as excludes by name.

Return Value

string

HTML attributes, ready for insertion into an HTML tag

FormAttributes()

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

Parameters

string|FormTemplateHelper $helper

FormTemplateHelper getTemplateHelper()

Return a {@link FormTemplateHelper} for this form. If one has not been set, return the default helper.

Return Value

FormTemplateHelper

$this setTarget(string $target)

Set the target of this form to any value - useful for opening the form contents in a new window or refreshing another frame.

Parameters

string $target

The value of the target

Return Value

$this

$this setLegend(string $legend)

Set the legend value to be inserted into the element in the Form.ss template.

Parameters

string $legend

Return Value

$this

$this setTemplate(string|array $template)

Set the SS template that this form should use to render with. The default is "Form".

Parameters

string|array $template

The name of the template (without the .ss extension) or array form

Return Value

$this

string|array getTemplate()

Return the template to render this form with.

Return Value

string|array

array getTemplates()

Returs the ordered list of preferred templates for rendering this form If the template isn't set, then default to the form class name e.g "Form".

Return Value

array

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}.

$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}.

Parameters

string $encType

Return Value

$this

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 HTTPRequest::detect_method()}. See {@link FormMethod()} to get a HTTP method for safe insertion into a tag.

Return Value

string

HTTP method

string FormMethod()

Returns the form method to be used in the tag.

See {@link FormHttpMethod()} to get the "real" method.

Return Value

string

Form HTTP method restricted to 'GET' or 'POST'

$this setFormMethod(string $method, bool $strict = null)

Set the form method: GET, POST, PUT, DELETE.

Parameters

string $method
bool $strict

If non-null, pass value to {@link setStrictFormMethodCheck()}.

Return Value

$this

$this setStrictFormMethodCheck($bool)

If set to true (the default), enforces 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 then the form method is only used to construct the default form.

Parameters

$bool

boolean

Return Value

$this

bool getStrictFormMethodCheck()

Return Value

bool

string FormAction()

Return the form's action attribute.

This is build by adding an executeForm get variable to the parent controller's Link() value

Return Value

string

$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.

Parameters

string $path

Return Value

$this

string FormName()

Returns the name of the form.

Return Value

string

$this setHTMLID(string $id)

Set the HTML ID attribute of the form.

Parameters

string $id

Return Value

$this

string getHTMLID()

Return Value

string

RequestHandler getController()

Get the controller or parent request handler.

Return Value

RequestHandler

$this setController(RequestHandler $controller = null)

Set the controller or parent request handler.

Parameters

RequestHandler $controller

Return Value

$this

string getName()

Get the name of the form.

Return Value

string

Form setName(string $name)

Set the name of the form.

Parameters

string $name

Return Value

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()

sessionMessage(string $message, string $type = ValidationResult::TYPE_ERROR, string|bool $cast = ValidationResult::CAST_TEXT)

Set a message to the session, for display next time this form is shown.

Parameters

string $message

the text of the message

string $type

Should be set to good, bad, or warning.

string|bool $cast

Cast type; One of the CAST_ constant definitions. Bool values will be treated as plain text flag.

sessionError(string $message, string $type = ValidationResult::TYPE_ERROR, string|bool $cast = ValidationResult::CAST_TEXT)

Set an error to the session, for display next time this form is shown.

Parameters

string $message

the text of the message

string $type

Should be set to good, bad, or warning.

string|bool $cast

Cast type; One of the CAST_ constant definitions. Bool values will be treated as plain text flag.

sessionFieldError(string $message, string $fieldName, string $type = ValidationResult::TYPE_ERROR, string|bool $cast = ValidationResult::CAST_TEXT)

Set an error message for a field in the session, for display next time this form is shown.

Parameters

string $message

the text of the message

string $fieldName

Name of the field to set the error message on it.

string $type

Should be set to good, bad, or warning.

string|bool $cast

Cast type; One of the CAST_ constant definitions. Bool values will be treated as plain text flag.

DataObject getRecord()

Returns the DataObject that has given this form its data through {@link loadDataFrom()}.

Return Value

DataObject

string getLegend()

Get the legend value to be inserted into the

element in Form.ss

Return Value

string

ValidationResult validationResult()

Processing that occurs before a form is executed.

This includes form validation, if it fails, we throw a ValidationException

This includes form validation, if it fails, we redirect back to the form with appropriate error messages. Always return true if the current form action is exempt from validation

Triggered through {@link httpSubmission()}.

Note that CSRF protection takes place in {@link httpSubmission()}, if it fails the form data will never reach this method.

Return Value

ValidationResult

$this 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 ({@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()}.

Parameters

array|DataObject $data
int $mergeStrategy

For every field, {@link $data} is interrogated whether it contains a relevant property/key, and what that property/key's value is.

By default, if {@link $data} does contain a property/key, the fields value is always replaced by {@link $data}'s value, even if that value is null/false/etc. Fields which don't match any property/key in {@link $data} are "left alone", meaning they retain any previous value.

You can pass a bitmask here to change this behaviour.

Passing MERGE_CLEAR_MISSING means that any fields that don't match any property/key in {@link $data} are cleared.

Passing MERGE_IGNORE_FALSEISH means that any false-ish value in {@link $data} won't replace a field's value.

Passing MERGE_AS_INTERNAL_VALUE forces the data to be parsed using the internal representation of the matching form field. This is helpful if you are loading an array of values retrieved from Form::getData() and you do not want them parsed as submitted data. MERGE_AS_SUBMITTED_VALUE does the opposite and forces the data to be parsed as it would be submitted from a form.

For backwards compatibility reasons, this parameter can also be set to === true, which is the same as passing MERGE_CLEAR_MISSING

array $fieldList

An optional list of fields to process. This can be useful when you have a form that has some fields that save to one object, and some that save to another.

Return Value

$this

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.

Parameters

DataObjectInterface $dataObject

The object to save data into

FieldList $fieldList

An optional list of fields to process. This can be useful when you have a form that has some fields that save to one object, and some that save to another.

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.

Return Value

array

DBHTMLText forTemplate()

Return a rendered version of this form.

This is returned when you access a form as $FormObject rather than <% with FormObject %>

Return Value

DBHTMLText

DBHTMLText 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.

Return Value

DBHTMLText

string formHtmlContent() deprecated

deprecated 5.0

Returns an HTML rendition of this form, without the 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.

Return Value

string

DBHTMLText 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

Parameters

string|array $template

Return Value

DBHTMLText

FormAction defaultAction()

Return the default button that should be clicked when another one isn't available.

Return Value

FormAction

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.

Return Value

Form

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()}.

Return Value

Form

Form enableSecurityToken()

Enable {@link SecurityToken} protection for this form instance.

Check for token state with {@link getSecurityToken()} and {@link SecurityToken->isEnabled()}.

Return Value

Form

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.

Return Value

SecurityToken|null

string extraClass()

Compiles all CSS-classes.

Return Value

string

$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.

Parameters

string $class

A string containing a classname or several class names delimited by a single space.

Return Value

$this

$this removeExtraClass(string $class)

Remove a CSS-class from the form-container. Multiple class names can be passed through as a space delimited string

Parameters

string $class

Return Value

$this

debug()

RequestHandler getRequestHandler()

Get request handler for this form

Return Value

RequestHandler

$this setRequestHandler(FormRequestHandler $handler)

Assign a specific request handler for this form

Parameters

FormRequestHandler $handler

Return Value

$this