class Form extends RequestHandler (View source)

Base class for all forms.

The form class is an extensible base for all forms on a SilverStripe application. It can be used either by extending it, and creating processor methods on the subclass, or by creating instances of form whose actions are handled by the parent controller.

In either case, if you want to get a form to do anything, it must be inextricably tied to a controller. The constructor is passed a controller and a method on that controller. This method should return the form object, and it shouldn't require any arguments. Parameters, if necessary, can be passed using the URL or get variables. These restrictions are in place so that we can recreate the form object upon form submission, without the use of a session, which would be too resource-intensive.

You will need to create at least one method for processing the submission (through FormAction). This method will be passed two parameters: the raw request data, and the form object. Usually you want to save data into a DataObject} by using {@link saveInto(). If you want to process the submitted data in any way, please use getData() rather than the raw request data.

Validation

Each form needs some form of Validator} to trigger the {@link FormField->validate() methods for each field. You can't disable validator for security reasons, because crucial behaviour like extension checks for file uploads depend on it. The default validator is an instance of RequiredFields. If you want to enforce serverside-validation to be ignored for a specific FormField, you need to subclass it.

URL Handling

The form class extends RequestHandler, which means it can be accessed directly through a URL. This can be handy for refreshing a form by ajax, or even just displaying a single form field. You can find out the base URL for your form by looking at the

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

Properties

public string $class from  SS_Object
protected array $extension_instances from  SS_Object
protected $beforeExtendCallbacks

List of callbacks to call prior to extensions having extend called on them, each grouped by methodName.

from  SS_Object
protected $afterExtendCallbacks

List of callbacks to call after extensions having extend called on them, each grouped by methodName.

from  SS_Object
protected ViewableData $failover

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

from  ViewableData
protected ViewableData $customisedObject from  ViewableData
protected SS_HTTPRequest $request from  RequestHandler
protected $model

The DataModel for this request

from  RequestHandler
protected bool $brokenOnConstruct

This variable records whether RequestHandler::construct() was called or not. Useful for checking if subclasses have called parent::construct()

from  RequestHandler
public bool $IncludeFormTag
protected FieldList|null $fields
protected FieldList|null $actions
protected Controller|null $controller
protected string|null $name
protected Validator|null $validator
protected string $formMethod
protected bool $strictFormMethodCheck
protected static string|null $current_action
protected DataObject|null $record
protected bool $hasDefaultAction

Keeps track of whether this form has a default action or not.

protected string|null $target

Target attribute of form-tag.

protected string|null $legend

Legend value, to be inserted into the

element before the
in Form.ss template.
protected string|null $template

The SS template to render this form HTML into.

protected callable|null $buttonClickedFunc
protected string|null $message
protected string|null $messageType
protected bool $redirectToFormOnValidationError

Should we redirect the user back down to the the form on validation errors rather then just the page

protected bool $security
protected SecurityToken|null $securityToken
protected array $extraClasses
protected string|null $encType
protected array $attributes
protected bool $securityTokenAdded

Methods

public static 
config()

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

protected
beforeExtending(string $method, callable $callback)

Allows user code to hook into Object::extend prior to control being delegated to extensions. Each callback will be reset once called.

protected
afterExtending(string $method, callable $callback)

Allows user code to hook into Object::extend after control being delegated to extensions. Each callback will be reset once called.

public static 
create()

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

public static 
singleton()

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

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

public static 
parse_class_spec($classSpec)

Parses a class-spec, such as "Versioned('Stage','Live')", as passed to create_from_string().

public static 
strong_create()

Similar to Object::create(), except that classes are only overloaded if you set the $strong parameter to TRUE when using Object::useCustomClass()

public static 
useCustomClass(string $oldClass, string $newClass, bool $strong = false)

This class allows you to overload classes with other classes when they are constructed using the factory method Object::create()

public 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

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

public static 
get_static($class, $name, $uncached = false) deprecated

No description

public static 
set_static($class, $name, $value) deprecated

No description

public static 
uninherited_static($class, $name, $uncached = false) deprecated

No description

public static 
combined_static($class, $name, $ceiling = false) deprecated

No description

public static 
addStaticVars($class, $properties, $replace = false) deprecated

No description

public static 
add_static_var($class, $name, $value, $replace = false) deprecated

No description

public static 
has_extension(string $classOrExtension, string $requiredExtension = null, bool $strict = false)

Return TRUE if a class has a specified extension.

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

Add an extension to a specific class.

public static 
remove_extension(string $extension)

Remove an extension from a class.

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

No description

public static 
get_extra_config_sources($class = null)

No description

public
__construct(Controller $controller, string $name, FieldList $fields, FieldList $actions, Validator $validator = null)

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

public
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

public
bool
hasMethod(string $method)

Return TRUE if a method exists on this object

public
array
allMethodNames(bool $custom = false)

Return the names of all the methods available on this object

public
defineMethods()

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

protected
array
findMethodsFromExtension(object $extension)

No description

protected
addMethodsFrom(string $property, string|int $index = null)

Add all the methods from an object property (which is an Extension) to this object.

protected
removeMethodsFrom(string $property, string|int $index = null)

Add all the methods from an object property (which is an Extension) to this object.

protected
addWrapperMethod(string $method, string $wrap)

Add a wrapper method - a method which points to another method with a different name. For example, Thumbnail(x) can be wrapped to generateThumbnail(x)

protected
createMethod(string $method, string $code)

Add an extra method using raw PHP code passed as a string

public
stat($name, $uncached = false)

No description

public
set_stat($name, $value)

No description

public
uninherited($name)

No description

public
bool
exists()

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

public
string
parentClass()

No description

public
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

public
string
__toString()

No description

public
mixed
invokeWithExtensions(string $method, mixed $argument = null)

Calls a method if available on both this object and all applied Extensions, and then attempts to merge all results into an array

public
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

public
getExtensionInstance(string $extension)

Get an extension instance attached to this object by name.

public
bool
hasExtension(string $extension)

Returns TRUE if this object instance has a specific extension applied in $extension_instances. Extension instances are initialized at constructor time, meaning if you use add_extension() afterwards, the added extension will just be added to new instances of the extended class. Use the static method has_extension() to check if a class (not an instance) has a specific extension.

public
array
getExtensionInstances()

Get all extension instances for this specific object instance.

public
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

public
clearCache($method, $ID = false, $arguments = array())

Clears the cache for the given cacheToFile call

protected
mixed
loadCache(string $cache, int $lifetime = 3600)

Loads a cache from the filesystem if a valid on is present and within the specified lifetime

protected
saveCache(string $cache, mixed $data)

Save a piece of cached data to the file system

protected
string
sanitiseCachename(string $name)

Strip a file name of special characters so it is suitable for use as a cache file name

public 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);".

public static 
array
castingObjectCreatorPair(string $fieldSchema)

Convert a field schema (e.g. "Varchar(50)") into a casting object creator array that contains both a className and castingHelper constructor code. See castingObjectCreator for more information about the constructor.

public
bool
__isset(string $property)

Check if a field exists on this object or its failover.

public
mixed
__get(string $property)

Get the value of a property/field on this object. This will check if a method called get{$property} exists, then check if a field is available using ViewableData::getField(), then fall back on a failover object.

public
__set(string $property, mixed $value)

Set a property/field on this object. This will check for the existence of a method called set{$property}, then use the ViewableData::setField() method.

public
setFailover(ViewableData $failover)

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

public
getFailover()

Get the current failover object if set

public
bool
hasField(string $field)

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

public
mixed
getField(string $field)

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

public
setField(string $field, mixed $value)

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

public
unknown
deprecatedCachedCall($method, $args = null, string $identifier = null)

Method to facilitate deprecation of underscore-prefixed methods automatically being cached.

public
customise(array|ViewableData $data)

Merge some arbitrary data in with this object. This method returns a ViewableData_Customised instance with references to both this and the new custom data.

public
getCustomisedObj()

No description

public
setCustomisedObj(ViewableData $object)

No description

public
array
castingHelperPair(string $field)

Get the class a field on this object would be casted to, as well as the casting helper for casting a field to an object (see ViewableData::castingHelper() for information on casting helpers).

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

public
string
castingClass(string $field)

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

public
string
escapeTypeForField(string $field)

Return the string-format type for the given field.

public
buildCastingCache(reference $cache)

Save the casting cache for this object (including data from any failovers) into a variable

public
renderWith(string|array|SSViewer $template, array $customFields = null)

Render this object into the template, and get the result as a string. You can pass one of the following as the $template parameter:

  • a template name (e.g. Page)
  • an array of possible template names - the first valid one will be used
  • an SSViewer instance

protected
objCacheName(string $fieldName, array $arguments)

Generate the cache name for a field

protected
mixed
objCacheGet(string $key)

Get a cached value from the field cache

protected
objCacheSet(string $key, mixed $value)

Store a value in the field cache

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

public
cachedCall(string $field, array $arguments = null, string $identifier = null)

A simple wrapper around ViewableData::obj() that automatically caches the result so it can be used again without re-running the method.

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

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

public
RAW_val($field, $arguments = null, $cache = true)

Return the value of the field without any escaping being applied.

public
SQL_val($field, $arguments = null, $cache = true)

Return the value of a field in an SQL-safe format.

public
JS_val($field, $arguments = null, $cache = true)

Return the value of a field in a JavaScript-save format.

public
ATT_val($field, $arguments = null, $cache = true)

Return the value of a field escaped suitable to be inserted into an XML node attribute.

public
array
getXMLValues($fields)

Get an array of XML-escaped values by field name

public
getIterator()

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

public
Me()

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

public
string
ThemeDir(string $subtheme = false)

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

public
string
CSSClasses(string $stopAtClass = 'ViewableData')

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

public
Debug()

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

public
setDataModel($model)

Set the DataModel for this request.

public
handleRequest(SS_HTTPRequest $request, DataModel $model)

Handles URL requests.

protected
findAction($request)

No description

protected
handleAction($request, $action)

Given a request, and an action name, call that action name on this RequestHandler

public
array|null
allowedActions(string $limitToClass = null)

Get a array of allowed actions defined on this controller, any parent classes or extensions.

public
bool
hasAction(string $action)

Checks if this request handler has a specific action, even if the current user cannot access it.

protected
definingClassForAction($actionOrigCasing)

Return the class that defines the given action, so that we know where to check allowed_actions.

public
checkAccessAction($action)

No description

public
httpError(int $errorCode, string $errorMessage = null)

Throws a HTTP error response encased in a SS_HTTPResponse_Exception, which is later caught in RequestHandler::handleAction() and returned to the user.

public
getRequest()

Returns the SS_HTTPRequest object that this controller is using.

public
setRequest($request)

Typically the request is set through handleAction() or handleRequest(), but in some based we want to set it manually.

public
string
Link()

Returns a link to this controller. Overload with your own Link rules if they exist.

public
$this
setupFormErrors()

Set up current form errors in session to the current form if appropriate.

protected
setupDefaultClasses()

set up the default classes for the form. This is done on construct so that the default classes can be removed after instantiation

public
httpSubmission(SS_HTTPRequest $request)

Handle a form submission. GET and POST requests behave identically.

protected
getValidationErrorResponse()

Returns the appropriate response up the controller chain if validate() fails (which is checked prior to executing any form actions).

protected
checkFieldsForAction(SS_List|array $fields, callable $funcName)

Fields can have action to, let's check if anyone of the responds to $funcname them

public
handleField(SS_HTTPRequest $request)

Handle a field request.

public
makeReadonly()

Convert this form into a readonly form

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

public
bool
getRedirectToFormOnValidationError()

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

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

public
transform(FormTransformation $trans)

No description

public
getValidator()

Get the Validator attached to this form.

public
$this
setValidator(Validator $validator)

Set the Validator on this form.

public
unsetValidator()

Remove the Validator from this from.

public
transformTo(FormTransformation $format)

Convert this form to another format.

public
getExtraFields()

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

public
Fields()

Return the form's fields - used by the templates

public
HiddenFields()

Return all fields in a form - including fields nested in CompositeFields.

public
VisibleFields()

Return all fields except for the hidden fields.

public
$this
setFields(FieldList $fields)

Setter for the form fields.

public
Actions()

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

public
$this
setActions(FieldList $actions)

Setter for the form actions.

public
unsetAllActions()

Unset all form actions

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

No description

public
string
getAttribute($name)

No description

public
array
getAttributes()

No description

public
string
getAttributesHTML($attrs = null)

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

public
FormAttributes()

No description

public
setTemplateHelper($helper)

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

public
getTemplateHelper()

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

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

public
$this
setLegend(string $legend)

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

public
$this
setTemplate(string $template)

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

public
string
getTemplate()

Return the template to render this form with.

public
getEncType()

Returns the encoding type for the form.

public
$this
setEncType(string $encType)

Sets the form encoding type. The most common encoding types are defined in ENC_TYPE_URLENCODED} and {@link ENC_TYPE_MULTIPART.

public
string
FormHttpMethod()

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

public
string
FormMethod()

Returns the form method to be used in the tag.

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

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

public
$this
setStrictFormMethodCheck($bool)

If set to true, enforce the matching of the form method.

public
bool
getStrictFormMethodCheck()

No description

public
string
FormAction()

Return the form's action attribute.

public
$this
setFormAction(string $path)

Set the form action attribute to a custom URL.

public
string
FormName()

Returns the name of the form.

public
$this
setHTMLID(string $id)

Set the HTML ID attribute of the form.

public
string
getHTMLID()

No description

public
Controller() deprecated

Returns this form's controller.

public
getController()

Get the controller.

public
setController(Controller $controller)

Set the controller.

public
string
getName()

Get the name of the form.

public
setName(string $name)

Set the name of the form.

public
FieldMap()

Returns an object where there is a method with the same name as each data field on the form.

public
string
Message()

The next functions store and modify the forms message attributes. messages are stored in session under $_SESSION[formname][message];

public
string
MessageType()

No description

protected
string
getMessageFromSession()

No description

public
$this
setMessage(string $message, string $type, bool $escapeHtml = true)

Set a status message for the form.

public
sessionMessage(string $message, string $type, bool $escapeHtml = true)

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

public static 
messageForForm($formName, $message, $type, $escapeHtml = true)

No description

public
clearMessage()

No description

public
resetValidation()

No description

public
getRecord()

Returns the DataObject that has given this form its data through loadDataFrom().

public
string
getLegend()

Get the legend value to be inserted into the

element in Form.ss

public
bool
validate()

Processing that occurs before a form is executed.

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

Load data from the given DataObject or array.

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

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

public
array
getData()

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

public
mixed
callfieldmethod(array $data)

Call the given method on the given field.

public
HTML
forTemplate()

Return a rendered version of this form.

public
HTML
forAjaxTemplate()

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

public
HTML
formHtmlContent()

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

public
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

public
$this
setButtonClicked(callable $funcName)

Sets the button that was clicked. This should only be called by the Controller.

public
buttonClicked()

No description

protected
array
getAllActions()

Get a list of all actions, including those in the main "fields" FieldList

public
defaultAction()

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

public
disableDefaultAction()

Disable the default button.

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

public
enableSecurityToken()

Enable SecurityToken protection for this form instance.

public
getSecurityToken()

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

public static 
string
single_field_required()

Returns the name of a field, if that's the only field that the current controller is interested in.

public static 
string
current_action()

Return the current form action being called, if available.

public static 
set_current_action(string $action)

Set the current form action. Should only be called by Controller.

public
string
extraClass()

Compiles all CSS-classes.

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

public
$this
removeExtraClass(string $class)

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

public
debug()

No description

public
testSubmission(string $action, array $data)

Test a submission of this form.

public
testAjaxSubmission(string $action, array $data)

Test an ajax submission of this form.

Details

static Config_ForClass|null config()

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

Return Value

Config_ForClass|null

protected beforeExtending(string $method, callable $callback)

Allows user code to hook into Object::extend prior to control being delegated to extensions. Each callback will be reset once called.

Parameters

string $method

The name of the method to hook into

callable $callback

The callback to execute

protected afterExtending(string $method, callable $callback)

Allows user code to hook into Object::extend after control being delegated to extensions. Each callback will be reset once called.

Parameters

string $method

The name of the method to hook into

callable $callback

The callback to execute

static SS_Object create()

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

This method first for strong class overloads (singletons & DB interaction), then custom class overloads. If an overload is found, an instance of this is returned rather than the original class. To overload a class, use Object::useCustomClass()

This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create('SiteTree'); $list = SiteTree::get();

Return Value

SS_Object

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

Return Value

SS_Object

The singleton instance

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.

Parameters

$classSpec
$firstArg

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

Parameters

$classSpec

static SS_Object strong_create()

Similar to Object::create(), except that classes are only overloaded if you set the $strong parameter to TRUE when using Object::useCustomClass()

Return Value

SS_Object

static useCustomClass(string $oldClass, string $newClass, bool $strong = false)

This class allows you to overload classes with other classes when they are constructed using the factory method Object::create()

Parameters

string $oldClass

the class to replace

string $newClass

the class to replace it with

bool $strong

allows you to enforce a certain class replacement under all circumstances. This is used in singletons and DB interaction classes

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

Parameters

string $class

the class to check

Return Value

string

the class that would be created if you called Object::create() with the class

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.

Parameters

$class
  • The class to get the static from
$name
  • The property to get from the class
null $default
  • The value to return if property doesn't exist on class

Return Value

any
  • The value of the static property $name on class $class, or $default if that property is not defined

static get_static($class, $name, $uncached = false) deprecated

deprecated

No description

Parameters

$class
$name
$uncached

static set_static($class, $name, $value) deprecated

deprecated

No description

Parameters

$class
$name
$value

static uninherited_static($class, $name, $uncached = false) deprecated

deprecated

No description

Parameters

$class
$name
$uncached

static combined_static($class, $name, $ceiling = false) deprecated

deprecated

No description

Parameters

$class
$name
$ceiling

static addStaticVars($class, $properties, $replace = false) deprecated

deprecated

No description

Parameters

$class
$properties
$replace

static add_static_var($class, $name, $value, $replace = false) deprecated

deprecated

No description

Parameters

$class
$name
$value
$replace

static has_extension(string $classOrExtension, string $requiredExtension = null, bool $strict = false)

Return TRUE if a class has a specified extension.

This supports backwards-compatible format (static Object::has_extension($requiredExtension)) and new format ($object->has_extension($class, $requiredExtension))

Parameters

string $classOrExtension

if 1 argument supplied, the class name of the extension to check for; if 2 supplied, the class name to test

string $requiredExtension

used only if 2 arguments supplied

bool $strict

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

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

Add an extension to a specific class.

The preferred method for adding extensions is through YAML config, since it avoids autoloading the class, and is easier to override in more specific configurations.

As an alternative, extensions can be added to a specific class directly in the Object::$extensions array. See SiteTree::$extensions for examples. Keep in mind that the extension will only be applied to new instances, not existing ones (including all instances created through singleton()).

Parameters

string $classOrExtension

Class that should be extended - has to be a subclass of Object

string $extension

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

See also

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

static remove_extension(string $extension)

Remove an extension from a class.

Keep in mind that this won't revert any datamodel additions of the extension at runtime, unless its used before the schema building kicks in (in your _config.php). Doesn't remove the extension from any Object instances which are already created, but will have an effect on new extensions. Clears any previously created singletons through singleton() to avoid side-effects from stale extension information.

Add support for removing extensions with parameters

Parameters

string $extension

Classname of an Extension subclass, without parameters

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

No description

Parameters

string $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 DataExtension classnames, or eval'ed classname strings with constructor arguments.

static get_extra_config_sources($class = null)

No description

Parameters

$class

__construct(Controller $controller, string $name, FieldList $fields, FieldList $actions, Validator $validator = null)

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

Parameters

Controller $controller

The parent controller, necessary to create the appropriate form action tag.

string $name

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

FieldList $fields

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

FieldList $actions

All of the action buttons in the form - a FieldLis of FormAction objects

Validator $validator

Override the default validator instance (Default: RequiredFields)

mixed __call(string $method, array $arguments)

Attemps to locate and call a method dynamically added to a class at runtime if a default cannot be located

You can add extra methods to a class using Extensions}, {@link Object::createMethod() or Object::addWrapperMethod()

Parameters

string $method
array $arguments

Return Value

mixed

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

defineMethods()

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

protected array findMethodsFromExtension(object $extension)

No description

Parameters

object $extension

Return Value

array

protected addMethodsFrom(string $property, string|int $index = null)

Add all the methods from an object property (which is an Extension) to this object.

Parameters

string $property

the property name

string|int $index

an index to use if the property is an array

protected removeMethodsFrom(string $property, string|int $index = null)

Add all the methods from an object property (which is an Extension) to this object.

Parameters

string $property

the property name

string|int $index

an index to use if the property is an array

protected addWrapperMethod(string $method, string $wrap)

Add a wrapper method - a method which points to another method with a different name. For example, Thumbnail(x) can be wrapped to generateThumbnail(x)

Parameters

string $method

the method name to wrap

string $wrap

the method name to wrap to

protected createMethod(string $method, string $code)

Add an extra method using raw PHP code passed as a string

Parameters

string $method

the method name

string $code

the PHP code - arguments will be in an array called $args, while you can access this object by using $obj. Note that you cannot call protected methods, as the method is actually an external function

stat($name, $uncached = false)

No description

Parameters

$name
$uncached

See also

SS_Object::get_static

set_stat($name, $value)

No description

Parameters

$name
$value

See also

SS_Object::set_static

uninherited($name)

No description

Parameters

$name

See also

SS_Object::uninherited_static

bool exists()

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

This method should be overriden in subclasses to provide more context about the classes state. For example, a DataObject class could return false when it is deleted from the database

Return Value

bool

string parentClass()

No description

Return Value

string

this classes parent class

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

Parameters

string $class

Return Value

bool

string __toString()

No description

Return Value

string

the class name

mixed invokeWithExtensions(string $method, mixed $argument = null)

Calls a method if available on both this object and all applied Extensions, and then attempts to merge all results into an array

integrate inheritance rules

Parameters

string $method

the method name to call

mixed $argument

a single argument to pass

Return Value

mixed

array extend(string $method, mixed $a1 = null, mixed $a2 = null, mixed $a3 = null, mixed $a4 = null, mixed $a5 = null, mixed $a6 = null, mixed $a7 = null)

Run the given function on all of this object's extensions. Note that this method originally returned void, so if you wanted to return results, you're hosed

Currently returns an array, with an index resulting every time the function is called. Only adds returns if they're not NULL, to avoid bogus results from methods just defined on the parent extension. This is important for permission-checks through extend, as they use min() to determine if any of the returns is FALSE. As min() doesn't do type checking, an included NULL return would fail the permission checks.

The extension methods are defined during __construct()} in {@link defineMethods().

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

Get an extension instance attached to this object by name.

Parameters

string $extension

Return Value

Extension

bool hasExtension(string $extension)

Returns TRUE if this object instance has a specific extension applied in $extension_instances. Extension instances are initialized at constructor time, meaning if you use add_extension() afterwards, the added extension will just be added to new instances of the extended class. Use the static method has_extension() to check if a class (not an instance) has a specific extension.

Caution: Don't use singleton()->hasExtension() as it will give you inconsistent results based on when the singleton was first accessed.

Parameters

string $extension

Classname of an Extension subclass without parameters

Return Value

bool

array getExtensionInstances()

Get all extension instances for this specific object instance.

See get_extensions() to get all applied extension classes for this class (not the instance).

Return Value

array

Map of DataExtension instances, keyed by classname.

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

Parameters

string $method

the method name to cache

int $lifetime

the cache lifetime in seconds

string $ID

custom cache ID to use

array $arguments

an optional array of arguments

Return Value

mixed

the cached data

clearCache($method, $ID = false, $arguments = array())

Clears the cache for the given cacheToFile call

Parameters

$method
$ID
$arguments

protected mixed loadCache(string $cache, int $lifetime = 3600)

Loads a cache from the filesystem if a valid on is present and within the specified lifetime

Parameters

string $cache

the cache name

int $lifetime

the lifetime (in seconds) of the cache before it is invalid

Return Value

mixed

protected saveCache(string $cache, mixed $data)

Save a piece of cached data to the file system

Parameters

string $cache

the cache name

mixed $data

data to save (must be serializable)

protected string sanitiseCachename(string $name)

Strip a file name of special characters so it is suitable for use as a cache file name

Parameters

string $name

Return Value

string

the name with all special cahracters replaced with underscores

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

Parameters

string $fieldSchema

The field spec

Return Value

string

static array castingObjectCreatorPair(string $fieldSchema)

Convert a field schema (e.g. "Varchar(50)") into a casting object creator array that contains both a className and castingHelper constructor code. See castingObjectCreator for more information about the constructor.

Parameters

string $fieldSchema

Return Value

array

bool __isset(string $property)

Check if a field exists on this object or its failover.

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

setField(string $field, mixed $value)

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

Parameters

string $field
mixed $value

unknown deprecatedCachedCall($method, $args = null, string $identifier = null)

Method to facilitate deprecation of underscore-prefixed methods automatically being cached.

Parameters

$method
$args
string $identifier

an optional custom cache identifier

Return Value

unknown

ViewableData_Customised customise(array|ViewableData $data)

Merge some arbitrary data in with this object. This method returns a ViewableData_Customised instance with references to both this and the new custom data.

Note that any fields you specify will take precedence over the fields on this object.

Parameters

array|ViewableData $data

Return Value

ViewableData_Customised

ViewableData getCustomisedObj()

No description

Return Value

ViewableData

setCustomisedObj(ViewableData $object)

No description

Parameters

ViewableData $object

array castingHelperPair(string $field)

Get the class a field on this object would be casted to, as well as the casting helper for casting a field to an object (see ViewableData::castingHelper() for information on casting helpers).

The returned array contains two keys:

  • className: the class the field would be casted to (e.g. "Varchar")
  • castingHelper: the casting helper for casting the field (e.g. "return new Varchar($fieldName)")

Parameters

string $field

Return Value

array

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.

Parameters

string $field

Return Value

string

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'

buildCastingCache(reference $cache)

Save the casting cache for this object (including data from any failovers) into a variable

Parameters

reference $cache

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

Parameters

string|array|SSViewer $template

the template to render into

array $customFields

fields to customise() the object with before rendering

Return Value

HTMLText

protected objCacheName(string $fieldName, array $arguments)

Generate the cache name for a field

Parameters

string $fieldName

Name of field

array $arguments

List of optional arguments given

protected mixed objCacheGet(string $key)

Get a cached value from the field cache

Parameters

string $key

Cache key

Return Value

mixed

protected objCacheSet(string $key, mixed $value)

Store a value in the field cache

Parameters

string $key

Cache key

mixed $value

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.

Parameters

string $fieldName
array $arguments
bool $forceReturnedObject

if TRUE, the value will ALWAYS be casted to an object before being returned, even if there is no explicit casting information

bool $cache

Cache this object

string $cacheName

a custom cache name

cachedCall(string $field, array $arguments = null, string $identifier = null)

A simple wrapper around ViewableData::obj() that automatically caches the result so it can be used again without re-running the method.

Parameters

string $field
array $arguments
string $identifier

an optional custom cache identifier

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.

Parameters

string $field
array $arguments
bool $cache

Return Value

bool

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.

Parameters

$field
$arguments
$cache

RAW_val($field, $arguments = null, $cache = true)

Return the value of the field without any escaping being applied.

Parameters

$field
$arguments
$cache

SQL_val($field, $arguments = null, $cache = true)

Return the value of a field in an SQL-safe format.

Parameters

$field
$arguments
$cache

JS_val($field, $arguments = null, $cache = true)

Return the value of a field in a JavaScript-save format.

Parameters

$field
$arguments
$cache

ATT_val($field, $arguments = null, $cache = true)

Return the value of a field escaped suitable to be inserted into an XML node attribute.

Parameters

$field
$arguments
$cache

array getXMLValues($fields)

Get an array of XML-escaped values by field name

Parameters

$fields

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

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

Parameters

string $subtheme

the subtheme path to get

Return Value

string

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

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

setDataModel($model)

Set the DataModel for this request.

Parameters

$model

SS_HTTPResponse|RequestHandler|string|array handleRequest(SS_HTTPRequest $request, DataModel $model)

Handles URL requests.

  • ViewableData::handleRequest() iterates through each rule in self::$url_handlers.
    • If the rule matches, the named method will be called.
    • If there is still more URL to be processed, then handleRequest() is called on the object that that method returns.

Once all of the URL has been processed, the final result is returned. However, if the final result is an array, this array is interpreted as being additional template data to customise the 2nd to last result with, rather than an object in its own right. This is most frequently used when a Controller's action will return an array of data with which to customise the controller.

Parameters

SS_HTTPRequest $request

The SS_HTTPRequest object that is reponsible for distributing URL parsing

DataModel $model

Return Value

SS_HTTPResponse|RequestHandler|string|array

protected findAction($request)

No description

Parameters

$request

protected SS_HTTPResponse handleAction($request, $action)

Given a request, and an action name, call that action name on this RequestHandler

Must not raise SS_HTTPResponse_Exceptions - instead it should return

Parameters

$request
$action

Return Value

SS_HTTPResponse

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.

Parameters

string $limitToClass

Return Value

array|null

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.

Parameters

string $action

Return Value

bool

protected definingClassForAction($actionOrigCasing)

Return the class that defines the given action, so that we know where to check allowed_actions.

Parameters

$actionOrigCasing

checkAccessAction($action)

No description

Parameters

$action

httpError(int $errorCode, string $errorMessage = null)

Throws a HTTP error response encased in a SS_HTTPResponse_Exception, which is later caught in RequestHandler::handleAction() and returned to the user.

Parameters

int $errorCode
string $errorMessage

Plaintext error message

SS_HTTPRequest|NullHTTPRequest getRequest()

Returns the SS_HTTPRequest object that this controller is using.

Returns a placeholder NullHTTPRequest object unless handleAction()} or {@link handleRequest() have been called, which adds a reference to an actual SS_HTTPRequest object.

setRequest($request)

Typically the request is set through handleAction() or handleRequest(), but in some based we want to set it manually.

Parameters

$request

Returns a link to this controller. Overload with your own Link rules if they exist.

Return Value

string

$this setupFormErrors()

Set up current form errors in session to the current form if appropriate.

Return Value

$this

protected setupDefaultClasses()

set up the default classes for the form. This is done on construct so that the default classes can be removed after instantiation

httpSubmission(SS_HTTPRequest $request)

Handle a form submission. GET and POST requests behave identically.

Populates the form with loadDataFrom()}, calls {@link validate(), and only triggers the requested form action/method if the form is valid.

Parameters

SS_HTTPRequest $request

Exceptions

SS_HTTPResponse_Exception

protected SS_HTTPResponse|string getValidationErrorResponse()

Returns the appropriate response up the controller chain if validate() fails (which is checked prior to executing any form actions).

By default, returns different views for ajax/non-ajax request, and handles 'application/json' requests with a JSON object containing the error messages. Behaviour can be influenced by setting $redirectToFormOnValidationError.

Return Value

SS_HTTPResponse|string

protected FormField checkFieldsForAction(SS_List|array $fields, callable $funcName)

Fields can have action to, let's check if anyone of the responds to $funcname them

Parameters

SS_List|array $fields
callable $funcName

Return Value

FormField

FormField handleField(SS_HTTPRequest $request)

Handle a field request.

Uses Form->dataFieldByName() to find a matching field, and falls back to FieldList->fieldByName() to look for tabs instead. This means that if you have a tab and a formfield with the same name, this method gives priority to the formfield.

Parameters

SS_HTTPRequest $request

Return Value

FormField

makeReadonly()

Convert this form into a readonly form

$this setRedirectToFormOnValidationError(bool $bool)

Set whether the user should be redirected back down to the form on the page upon validation errors in the form or if they just need to redirect back to the page

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

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.

Parameters

string $fieldName
string $message
string $messageType
bool $escapeHtml

transform(FormTransformation $trans)

No description

Parameters

FormTransformation $trans

Validator getValidator()

Get the Validator attached to this form.

Return Value

Validator

$this setValidator(Validator $validator)

Set the Validator on this form.

Parameters

Validator $validator

Return Value

$this

unsetValidator()

Remove the Validator from this from.

transformTo(FormTransformation $format)

Convert this form to another format.

Parameters

FormTransformation $format

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

No description

Parameters

string $name
string $value

Return Value

$this

string getAttribute($name)

No description

Parameters

$name

Return Value

string $name

array getAttributes()

No description

Return Value

array

string getAttributesHTML($attrs = null)

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

Parameters

$attrs

Return Value

string

HTML attributes, ready for insertion into an HTML tag

FormAttributes()

No description

setTemplateHelper($helper)

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

Parameters

$helper

FormTemplateHelper getTemplateHelper()

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

Return Value

FormTemplateHelper

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

Parameters

target $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 $template)

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

Parameters

string $template

The name of the template (without the .ss extension)

Return Value

$this

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

Return Value

string

getEncType()

Returns the encoding type for the form.

By default this will be URL encoded, unless there is a file field present in which case multipart is used. You can also set the enc type using setEncType.

$this setEncType(string $encType)

Sets the form encoding type. The most common encoding types are defined in ENC_TYPE_URLENCODED} and {@link ENC_TYPE_MULTIPART.

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 Director::direct(). See 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 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 setStrictFormMethodCheck().

Return Value

$this

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

Parameters

$bool boolean

Return Value

$this

bool getStrictFormMethodCheck()

No description

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

No description

Return Value

string

Controller Controller() deprecated

deprecated 4.0

Returns this form's controller.

Return Value

Controller

Controller getController()

Get the controller.

Return Value

Controller

Form setController(Controller $controller)

Set the controller.

Parameters

Controller $controller

Return Value

Form

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

string Message()

The next functions store and modify the forms message attributes. messages are stored in session under $_SESSION[formname][message];

Return Value

string

string MessageType()

No description

Return Value

string

protected string getMessageFromSession()

No description

Return Value

string

$this setMessage(string $message, string $type, bool $escapeHtml = true)

Set a status message for the form.

Parameters

string $message

the text of the message

string $type

Should be set to good, bad, or warning.

bool $escapeHtml

Automatically sanitize the message. Set to FALSE if the message contains HTML. In that case, you might want to use Convert::raw2xml() to escape any user supplied data in the message.

Return Value

$this

sessionMessage(string $message, string $type, bool $escapeHtml = true)

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.

bool $escapeHtml

Automatically sanitize the message. Set to FALSE if the message contains HTML. In that case, you might want to use Convert::raw2xml() to escape any user supplied data in the message.

static messageForForm($formName, $message, $type, $escapeHtml = true)

No description

Parameters

$formName
$message
$type
$escapeHtml

clearMessage()

No description

resetValidation()

No description

DataObject getRecord()

Returns the DataObject that has given this form its data through loadDataFrom().

Return Value

DataObject

string getLegend()

Get the legend value to be inserted into the

element in Form.ss

Return Value

string

bool validate()

Processing that occurs before a form is executed.

This includes form validation, if it fails, we redirect back to the form with appropriate error messages.

Triggered through httpSubmission().

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

Return Value

bool

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

Load data from the given DataObject or array.

It will call $object->MyField to get the value of MyField. If you passed an array, it will call $object[MyField]. Doesn't save into dataless FormFields (DatalessField), as determined by FieldList->dataFields().

By default, if a field isn't set (as determined by isset()), its value will not be saved to the field, retaining potential existing values.

Passed data should not be escaped, and is saved to the FormField instances unescaped. Escaping happens automatically on saving the data through saveInto().

Escaping happens automatically on saving the data through saveInto().

Parameters

array|DataObject $data
int $mergeStrategy

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

By default, if $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 $data are "left alone", meaning they retain any previous value.

You can pass a bitmask here to change this behaviour.

Passing CLEAR_MISSING means that any fields that don't match any property/key in $data are cleared.

Passing IGNORE_FALSEISH means that any false-ish value in $data won't replace a field's value.

For backwards compatibility reasons, this parameter can also be set to === true, which is the same as passing 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

Form

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 FieldList->dataFields(), which filters out any form-specific data like form-actions.

Calls FormField->dataValue() on each field, which returns a value suitable for insertion into a DataObject property.

Return Value

array

mixed callfieldmethod(array $data)

Call the given method on the given field.

Parameters

array $data

Return Value

mixed

HTML forTemplate()

Return a rendered version of this form.

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

Return Value

HTML

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.

Return Value

HTML

HTML formHtmlContent()

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

HTML

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

Parameters

string|array $template

Return Value

HTMLText

$this setButtonClicked(callable $funcName)

Sets the button that was clicked. This should only be called by the Controller.

Parameters

callable $funcName

The name of the action method that will be called.

Return Value

$this

FormAction buttonClicked()

No description

Return Value

FormAction

protected array getAllActions()

Get a list of all actions, including those in the main "fields" FieldList

Return Value

array

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 getSecurityToken() and SecurityToken->isEnabled().

Return Value

Form

Form enableSecurityToken()

Enable SecurityToken protection for this form instance.

Check for token state with getSecurityToken() and SecurityToken->isEnabled().

Return Value

Form

SecurityToken|null getSecurityToken()

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

Doesn't check for securityTokenEnabled().

Use SecurityToken::inst() to get a global token.

Return Value

SecurityToken|null

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.

Return Value

string

static string current_action()

Return the current form action being called, if available.

Return Value

string

static set_current_action(string $action)

Set the current form action. Should only be called by Controller.

Parameters

string $action

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

No description

SS_HTTPResponse testSubmission(string $action, array $data)

Test a submission of this form.

Parameters

string $action
array $data

Return Value

SS_HTTPResponse

the response object that the handling controller produces. You can interrogate this in your unit test.

Exceptions

SS_HTTPResponse_Exception

SS_HTTPResponse testAjaxSubmission(string $action, array $data)

Test an ajax submission of this form.

Parameters

string $action
array $data

Return Value

SS_HTTPResponse

the response object that the handling controller produces. You can interrogate this in your unit test.