ChangePasswordForm

public

SS_HTTPResponse|RequestHandler|string|array

handleRequest(SS_HTTPRequest $request, DataModel $model)

Handles URL requests.

protected

findAction($request)

No description

protected

SS_HTTPResponse

handleAction($request, $action)

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

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

from Form

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

SS_HTTPRequest|NullHTTPRequest

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.

from Form

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

from Form

public

httpSubmission(SS_HTTPRequest $request)

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

from Form

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

from Form

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

from Form

public

FormField

handleField(SS_HTTPRequest $request)

Handle a field request.

from Form

public

makeReadonly()

Convert this form into a readonly form

from 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

from Form

public

bool

getRedirectToFormOnValidationError()

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

from Form

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.

from Form

public

transform(FormTransformation $trans)

No description

from Form

public

Validator

getValidator()

Get the Validator attached to this form.

from Form

public

$this

setValidator(Validator $validator)

Set the Validator on this form.

from Form

public

unsetValidator()

Remove the Validator from this from.

from Form

public

transformTo(FormTransformation $format)

Convert this form to another format.

from Form

public

FieldList

getExtraFields()

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

from Form

public

FieldList

Fields()

Return the form's fields - used by the templates

from Form

public

FieldList

HiddenFields()

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

from Form

public

VisibleFields()

Return all fields except for the hidden fields.

from Form

public

$this

setFields(FieldList $fields)

Setter for the form fields.

from Form

public

FieldList

Actions()

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

from Form

public

$this

setActions(FieldList $actions)

Setter for the form actions.

from Form

public

unsetAllActions()

Unset all form actions

from Form

public

$this

setAttribute(string $name, string $value)

No description

from Form

public

string

getAttribute($name)

No description

from Form

public

array

getAttributes()

No description

from Form

public

string

getAttributesHTML($attrs = null)

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

from Form

public

FormAttributes()

No description

from Form

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

from Form

public

FormTemplateHelper

getTemplateHelper()

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

from Form

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.

from Form

public

$this

setLegend(string $legend)

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

from Form

public

$this

setTemplate(string $template)

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

from Form

public

string

getTemplate()

Return the template to render this form with.

from Form

public

getEncType()

Returns the encoding type for the form.

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

from Form

public

string

FormHttpMethod()

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

from Form

public

string

FormMethod()

Returns the form method to be used in the

from Form

public

$this

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

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

from Form

public

$this

setStrictFormMethodCheck($bool)

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

from Form

public

bool

getStrictFormMethodCheck()

No description

from Form

public

string

FormAction()

Return the form's action attribute.

from Form

public

$this

setFormAction(string $path)

Set the form action attribute to a custom URL.

from Form

public

string

FormName()

Returns the name of the form.

from Form

public

$this

setHTMLID(string $id)

Set the HTML ID attribute of the form.

from Form

public

string

getHTMLID()

No description

from Form

public

Controller

Controller() deprecated

Returns this form's controller.

from Form

public

Controller

getController()

Get the controller.

from Form

public

Form

setController(Controller $controller)

Set the controller.

from Form

public

string

getName()

Get the name of the form.

from Form

public

Form

setName(string $name)

Set the name of the form.

from Form

public

FieldMap()

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

from Form

public

string

Message()

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

from Form

public

string

MessageType()

No description

from Form

protected

string

getMessageFromSession()

No description

from Form

public

$this

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

Set a status message for the form.

from Form

public

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

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

from Form

public static

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

No description

from Form

public

clearMessage()

No description

from Form

public

resetValidation()

No description

from Form

public

DataObject

getRecord()

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

from Form

public

string

getLegend()

Get the legend value to be inserted into the

element in Form.ss

from Form

public

bool

validate()

Processing that occurs before a form is executed.

from Form

public

Form

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

Load data from the given DataObject or array.

from Form

public

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

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

from Form

public

array

getData()

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

from Form

public

mixed

callfieldmethod(array $data)

Call the given method on the given field.

from Form

public

HTML

forTemplate()

Return a rendered version of this form.

from Form

public

HTML

forAjaxTemplate()

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

from Form

public

HTML

formHtmlContent()

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

from Form

public

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

from Form

public

$this

setButtonClicked(callable $funcName)

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

from Form

public

FormAction

buttonClicked()

No description

from Form

protected

array

getAllActions()

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

from Form

public

FormAction

defaultAction()

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

from Form

public

Form

disableDefaultAction()

Disable the default button.

from Form

public

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.

from Form

public

Form

enableSecurityToken()

Enable SecurityToken protection for this form instance.

from Form

public

SecurityToken|null

getSecurityToken()

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

from Form

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.

from Form

public static

string

current_action()

Return the current form action being called, if available.

from Form

public static

set_current_action(string $action)

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

from Form

public

string

extraClass()

Compiles all CSS-classes.

from Form

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.

from Form

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

from Form

public

debug()

No description

from Form

public

SS_HTTPResponse

testSubmission(string $action, array $data)

Test a submission of this form.

from Form

public

SS_HTTPResponse

testAjaxSubmission(string $action, array $data)

Test an ajax submission of this form.

from Form

public

SS_HTTPResponse

doChangePassword(array $data)

Change the password

Details

in SS_Object at line 60
`static Config_ForClass|null config()`

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

Return Value

Config_ForClass|null

in SS_Object at line 85
`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

in SS_Object at line 108
`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

in SS_Object at line 132
`static SS_Object create()`

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

This method first for strong class overloads (singletons & DB interaction), then custom class overloads. If an overload is found, an instance of this is returned rather than the original class. To overload a class, use 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

in SS_Object at line 155
`static SS_Object singleton()`

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

It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).

Return Value

SS_Object

The singleton instance

in SS_Object at line 190
`static create_from_string($classSpec, $firstArg = null)`

Create an object from a string representation. It treats it as a PHP constructor without the 'new' keyword. It also manages to construct the object without the use of eval().

Construction itself is done with Object::create(), so that Object::useCustomClass() calls are respected.

Object::create_from_string("Versioned('Stage','Live')") will return the result of Versioned::create('Stage', 'Live);

It is designed for simple, clonable objects. The first time this method is called for a given string it is cached, and clones of that object are returned.

If you pass the $firstArg argument, this will be prepended to the constructor arguments. It's impossible to pass null as the firstArg argument.

Object::create_from_string("Varchar(50)", "MyField") will return the result of Vachar::create('MyField', '50');

Arguments are always strings, although this is a quirk of the current implementation rather than something that can be relied upon.

Parameters

	$classSpec
	$firstArg

in SS_Object at line 215
`static parse_class_spec($classSpec)`

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

string

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

in SS_Object at line 396
`static any static_lookup($class, $name, null $default = null)`

Get the value of a static property of a class, even in that property is declared protected (but not private), without any inheritance, merging or parent lookup if it doesn't exist on the given class.

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

in SS_Object at line 436
`static get_static($class, $name, $uncached = false) deprecated`

deprecated

No description

Parameters

	$class
	$name
	$uncached

in SS_Object at line 444
`static set_static($class, $name, $value) deprecated`

deprecated

No description

Parameters

	$class
	$name
	$value

in SS_Object at line 452
`static uninherited_static($class, $name, $uncached = false) deprecated`

deprecated

No description

Parameters

	$class
	$name
	$uncached

in SS_Object at line 460
`static combined_static($class, $name, $ceiling = false) deprecated`

deprecated

No description

Parameters

	$class
	$name
	$ceiling

in SS_Object at line 470
`static addStaticVars($class, $properties, $replace = false) deprecated`

deprecated

No description

Parameters

	$class
	$properties
	$replace

in SS_Object at line 478
`static add_static_var($class, $name, $value, $replace = false) deprecated`

deprecated

No description

Parameters

	$class
	$name
	$value
	$replace

in SS_Object at line 494
`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

in SS_Object at line 536
`static add_extension(string $classOrExtension, string $extension = null)`

Add an extension to a specific class.

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

As an alternative, extensions can be added to a specific class directly in the 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')"

in SS_Object at line 594
`static remove_extension(string $extension)`

Remove an extension from a class.

Keep in mind that this won't revert any datamodel additions of the extension at runtime, unless its used before the schema building kicks in (in your _config.php). Doesn't remove the extension from any 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

in SS_Object at line 633
`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.

in SS_Object at line 655
`static get_extra_config_sources($class = null)`

No description

Parameters

$class

at line 22
`__construct(Controller $controller, string $name, FieldList $fields = null, FieldList $actions = null)`

Constructor

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

in SS_Object at line 725
`mixed __call(string $method, array $arguments)`

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

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

Parameters

string	$method
array	$arguments

Return Value

mixed

in SS_Object at line 792
`bool hasMethod(string $method)`

Return TRUE if a method exists on this object

This should be used rather than PHP's inbuild method_exists() as it takes into account methods added via extensions

Parameters

string

$method

Return Value

bool

in SS_Object at line 802
`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

in ViewableData at line 206
`defineMethods()`

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

in SS_Object at line 843
`protected array findMethodsFromExtension(object $extension)`

No description

Parameters

object

$extension

Return Value

array

in SS_Object at line 864
`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

in SS_Object at line 899
`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

in SS_Object at line 935
`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

in SS_Object at line 950
`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

in SS_Object at line 963
`stat($name, $uncached = false)`

No description

Parameters

	$name
	$uncached

in SS_Object at line 970
`set_stat($name, $value)`

No description

Parameters

	$name
	$value

in SS_Object at line 977
`uninherited($name)`

No description

Parameters

$name

in SS_Object at line 991
`bool exists()`

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

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

No description

Return Value

string

the class name

in SS_Object at line 1030
`mixed invokeWithExtensions(string $method, mixed $argument = null)`

Calls a method if available on both this object and all applied 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

in SS_Object at line 1058
`array extend(string $method, mixed $a1 = null, mixed $a2 = null, mixed $a3 = null, mixed $a4 = null, mixed $a5 = null, mixed $a6 = null, mixed $a7 = null)`

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

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

The extension methods are defined during __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

in SS_Object at line 1097
`Extension getExtensionInstance(string $extension)`

Get an extension instance attached to this object by name.

Parameters

string

$extension

Return Value

Extension

in SS_Object at line 1115
`bool hasExtension(string $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

in SS_Object at line 1126
`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.

in SS_Object at line 1142
`mixed cacheToFile(string $method, int $lifetime = 3600, string $ID = false, array $arguments = array())`

Cache the results of an instance method in this object to a file, or if it is already cache return the cached results

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

in SS_Object at line 1171
`clearCache($method, $ID = false, $arguments = array())`

Clears the cache for the given cacheToFile call

Parameters

	$method
	$ID
	$arguments

in SS_Object at line 1190
`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

in SS_Object at line 1208
`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)

in SS_Object at line 1219
`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

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

Parameters

string

$property

Return Value

bool

in ViewableData at line 117
`mixed __get(string $property)`

Parameters

string

$property

Return Value

mixed

in ViewableData at line 138
`__set(string $property, mixed $value)`

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

Parameters

string	$property
mixed	$value

in ViewableData at line 151
`setFailover(ViewableData $failover)`

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

Parameters

$failover

string	$field
mixed	$value

in ViewableData at line 236
`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

in ViewableData at line 255
`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

in ViewableData at line 272
`ViewableData getCustomisedObj()`

No description

Return Value

in ViewableData at line 279
`setCustomisedObj(ViewableData $object)`

No description

Parameters

$object

in ViewableData at line 296
`array castingHelperPair(string $field)`

Get the class a field on this object would be casted to, as well as the casting helper for casting a field to an object (see 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

in ViewableData at line 308
`string castingHelper(string $field)`

Return the "casting helper" (a piece of PHP code that when evaluated creates a casted value object) for a field on this object.

Parameters

string

$field

Return Value

string

in ViewableData at line 394
`HTMLText renderWith(string|array|SSViewer $template, array $customFields = null)`

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

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

Parameters

string\|array\|SSViewer	$template	the template to render into
array	$customFields	fields to customise() the object with before rendering

Return Value

HTMLText

in ViewableData at line 419
`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

in ViewableData at line 431
`protected mixed objCacheGet(string $key)`

Get a cached value from the field cache

Parameters

string

$key

Cache key

Return Value

mixed

in ViewableData at line 441
`protected objCacheSet(string $key, mixed $value)`

Store a value in the field cache

Parameters

string	$key	Cache key
mixed	$value

in ViewableData at line 456
`obj(string $fieldName, array $arguments = null, bool $forceReturnedObject = true, bool $cache = false, string $cacheName = null)`

Get the value of a field on this object, automatically inserting the value into any available casting objects that have been specified.

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

in ViewableData at line 503
`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

in ViewableData at line 516
`bool hasValue(string $field, array $arguments = null, bool $cache = true)`

Checks if a given method/field has a valid value. If the result is an object, this will return the result of the exists method, otherwise will check if the result is not just an empty paragraph tag.

Parameters

string	$field
array	$arguments
bool	$cache

Return Value

bool

in ViewableData at line 538
`XML_val($field, $arguments = null, $cache = false)`

Get the string value of a field on this object that has been suitable escaped to be inserted directly into a template.

Parameters

	$field
	$arguments
	$cache

in ViewableData at line 546
`RAW_val($field, $arguments = null, $cache = true)`

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

Parameters

	$field
	$arguments
	$cache

in ViewableData at line 553
`SQL_val($field, $arguments = null, $cache = true)`

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

Parameters

	$field
	$arguments
	$cache

in ViewableData at line 560
`JS_val($field, $arguments = null, $cache = true)`

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

Parameters

	$field
	$arguments
	$cache

in ViewableData at line 567
`ATT_val($field, $arguments = null, $cache = true)`

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

Parameters

	$field
	$arguments
	$cache

in ViewableData at line 579
`array getXMLValues($fields)`

Get an array of XML-escaped values by field name

Parameters

$fields

Return Value

array

in ViewableData at line 599
`ArrayIterator getIterator()`

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

This is useful so you can use a single record inside a <% control %> block in a template - and then use to access individual fields on this object.

Return Value

ArrayIterator

in ViewableData at line 611
`ViewableData Me()`

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

Return Value

in ViewableData at line 627
`string ThemeDir(string $subtheme = false)`

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

This method is useful for things such as accessing theme images from your template without hardcoding the theme page - e.g. .

This method should only be used when a theme is currently active. However, it will fall over to the current project directory.

Parameters

string

$subtheme

the subtheme path to get

Return Value

string

in ViewableData at line 648
`string CSSClasses(string $stopAtClass = 'ViewableData')`

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

This method returns an escaped string of CSS classes representing the current classes ancestry until it hits a stop point - e.g. "Page DataObject ViewableData".

Parameters

string

$stopAtClass

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_Exception

in RequestHandler at line 316
`array|null allowedActions(string $limitToClass = null)`

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

Caution: Since 3.1, allowed_actions definitions only apply to methods on the controller they're defined on, so it is recommended to use the $class argument when invoking this method.

Parameters

string

$limitToClass

Return Value

array|null

in RequestHandler at line 358
`bool hasAction(string $action)`

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

Includes class ancestry and extensions in the checks.

Parameters

string

$action

Return Value

bool

in RequestHandler at line 396
`protected definingClassForAction($actionOrigCasing)`

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

Parameters

$actionOrigCasing

in Form at line 481
`checkAccessAction($action)`

No description

Parameters

$action

in RequestHandler at line 472
`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

in RequestHandler at line 494
`SS_HTTPRequest|NullHTTPRequest getRequest()`

in Form at line 341
`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

in Form at line 511
`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

in Form at line 551
`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

in Form at line 574
`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

The form fields

in Form at line 744
`FieldList HiddenFields()`

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

Useful when doing custom field layouts.

Return Value

in Form at line 752
`VisibleFields()`

Return all fields except for the hidden fields.

Useful when making your own simplified form layouts.

in Form at line 762
`$this setFields(FieldList $fields)`

Setter for the form fields.

Parameters

$fields

Return Value

$this

in Form at line 772
`FieldList Actions()`

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

Return Value

The action list

in Form at line 782
`$this setActions(FieldList $actions)`

Setter for the form actions.

Parameters

in Form at line 815
`array getAttributes()`

No description

Return Value

array

in Form at line 843
`string getAttributesHTML($attrs = null)`

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

Parameters

$attrs

Return Value

$legend

Return Value

$this

in Form at line 948
`$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

in Form at line 960
`string getTemplate()`

Return the template to render this form with.

If the template isn't set, then default to the form class name e.g "Form".

Return Value

string

in Form at line 972
`getEncType()`

Returns the encoding type for the form.

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

in Form at line 993
`$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

in Form at line 1010
`string FormHttpMethod()`

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

As most browsers only support GET and POST in form submissions, all other HTTP methods are added as a hidden field "_method" that gets evaluated in Director::direct(). See FormMethod() to get a HTTP method for safe insertion into a tag.

Return Value

string

HTTP method

in Form at line 1020
`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'

in Form at line 1035
`$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().

bool

in Form at line 1072
`string FormAction()`

string

in Form at line 1120
`$this setHTMLID(string $id)`

Set the HTML ID attribute of the form.

Parameters

string

$id

Return Value

$this

in Form at line 1129
`string getHTMLID()`

No description

Return Value

string

in Form at line 1139
`Controller Controller() deprecated`

deprecated 4.0

Return Value

Form

in Form at line 1171
`string getName()`

Get the name of the form.

Return Value

string

in Form at line 1181
`Form setName(string $name)`

Set the name of the form.

Parameters

string

$name

Return Value

Form

in Form at line 1195
`FieldMap()`

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

That method will return the field itself.

Get the legend value to be inserted into the

element in Form.ss

Return Value

string

in Form at line 1321
`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

in Form at line 1400
`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

in Form at line 1503
`saveInto(DataObjectInterface $dataObject, FieldList $fieldList = null)`

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

It will make use of setCastedField() to do this.

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.

in Form at line 1534
`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

in Form at line 1555
`mixed callfieldmethod(array $data)`

HTML

in Form at line 1649
`HTMLText renderWithoutActionButton(string|array $template)`

Render this form using the given template, and return the result as a string You can pass either an SSViewer or a template name

Parameters

string|array

Disable the default button.

Return Value

$this

in Form at line 1851
`debug()`

No description

in Form at line 1877
`SS_HTTPResponse testSubmission(string $action, array $data)`

Test a submission of this form.

Parameters

string	$action
array	$data

Return Value

SS_HTTPResponse_Exception

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

Exceptions

in Form at line 1891
`SS_HTTPResponse testAjaxSubmission(string $action, array $data)`

Test an ajax submission of this form.

Parameters

string	$action
array	$data

Return Value

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

at line 62
`SS_HTTPResponse doChangePassword(array $data)`

Change the password

Parameters

array

$data

The user submitted data

Return Value