class MemberLoginForm extends LoginForm (View source)

Log-in form for the "member" authentication method.

Available extension points:

  • "authenticationFailed": Called when login was not successful. Arguments: $data containing the form submission
  • "forgotPassword": Called before forgot password logic kicks in, allowing extensions to "veto" execution by returning FALSE. Arguments: $member containing the detected Member record

Constants

ENC_TYPE_URLENCODED

ENC_TYPE_MULTIPART

MERGE_DEFAULT

MERGE_CLEAR_MISSING

MERGE_IGNORE_FALSEISH

Properties

static private array $extensions

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

from  SS_Object
string $class from  SS_Object
static private array $casting

An array of objects to cast certain fields to. This is set up as an array in the format:

from  ViewableData
static private string $default_cast

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

from  ViewableData
static private string|null $url_segment

Optional url_segment for this request handler

from  RequestHandler
static private $url_handlers

The default URL handling rules. This specifies that the next component of the URL corresponds to a method to be called on this RequestHandlingData object.

from  RequestHandler
static private array $allowed_actions

Since the logout and dologin actions may be conditionally removed, it's necessary to ensure these remain valid actions regardless of the member login state.

static private bool $require_allowed_actions from  RequestHandler
bool $IncludeFormTag from  Form
static private array $default_classes from  Form
static private int $min_auth_time

The minimum amount of time authenticating is allowed to take in milliseconds.

from  LoginForm
string $loggedInAsField

This field is used in the "You are logged in as %s" message

Methods

static Config_ForClass|null
config()

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

static SS_Object
create()

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

static SS_Object
singleton()

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

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

static 
parse_class_spec($classSpec)

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

static SS_Object
strong_create()

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

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

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

static string
getCustomClass(string $class)

If a class has been overloaded, get the class name it has been overloaded with - otherwise return the class name

static any
static_lookup($class, $name, null $default = null)

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

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

Return TRUE if a class has a specified extension.

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

Add an extension to a specific class.

static 
remove_extension(string $extension)

Remove an extension from a class.

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

No description

static 
get_extra_config_sources($class = null)

No description

__construct(Controller $controller, string $name, FieldList $fields = null, FieldList $actions = null, bool $checkCurrentUser = true)

Constructor

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

bool
hasMethod(string $method)

Return TRUE if a method exists on this object

array
allMethodNames(bool $custom = false)

Return the names of all the methods available on this object

stat($name, $uncached = false)

No description

set_stat($name, $value)

No description

uninherited($name)

No description

bool
exists()

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

string
parentClass()

No description

bool
is_a(string $class)

Check if this class is an instance of a specific class, or has that class as one of its parents

string
__toString()

No description

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

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

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

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

getExtensionInstance(string $extension)

Get an extension instance attached to this object by name.

bool
hasExtension(string $extension)

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

array
getExtensionInstances()

Get all extension instances for this specific object instance.

mixed
cacheToFile(string $method, int $lifetime = 3600, string $ID = false, array $arguments = array())

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

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

Clears the cache for the given cacheToFile call

static string
castingObjectCreator(string $fieldSchema)

Converts a field spec into an object creator. For example: "Int" becomes "new Int($fieldName);" and "Varchar(50)" becomes "new Varchar($fieldName, 50);".

static array
castingObjectCreatorPair(string $fieldSchema)

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

bool
__isset(string $property)

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

mixed
__get(string $property)

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

__set(string $property, mixed $value)

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

setFailover(ViewableData $failover)

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

getFailover()

Get the current failover object if set

bool
hasField(string $field)

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

mixed
getField(string $field)

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

setField(string $field, mixed $value)

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

defineMethods()

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

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

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

customise(array|ViewableData $data)

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

setCustomisedObj(ViewableData $object)

No description

array
castingHelperPair(string $field)

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

string
castingHelper(string $field)

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

string
castingClass(string $field)

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

string
escapeTypeForField(string $field)

Return the string-format type for the given field.

buildCastingCache(reference $cache)

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

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

obj(string $fieldName, array $arguments = null, bool $forceReturnedObject = true, bool $cache = false, string $cacheName = null)

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

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

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

bool
hasValue(string $field, array $arguments = null, bool $cache = true)

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

XML_val($field, $arguments = null, $cache = false)

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

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

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

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

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

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

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

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

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

array
getXMLValues($fields)

Get an array of XML-escaped values by field name

getIterator()

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

Me()

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

string
ThemeDir(string $subtheme = false)

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

string
CSSClasses(string $stopAtClass = 'ViewableData')

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

Debug()

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

setDataModel($model)

Set the DataModel for this request.

handleRequest(SS_HTTPRequest $request, DataModel $model)

Handles URL requests.

array|null
allowedActions(string $limitToClass = null)

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

bool
hasAction(string $action)

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

checkAccessAction($action)

No description

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

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

getRequest()

Returns the SS_HTTPRequest object that this controller is using.

setRequest($request)

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

string
Link()

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

$this
setupFormErrors()

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

from  Form
httpSubmission(SS_HTTPRequest $request)

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

from  Form
handleField(SS_HTTPRequest $request)

Handle a field request.

from  Form
makeReadonly()

Convert this form into a readonly form

from  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

from  Form
bool
getRedirectToFormOnValidationError()

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

from  Form
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
transform(FormTransformation $trans)

No description

from  Form
getValidator()

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

from  Form
$this
setValidator(Validator $validator)

Set the {@link Validator} on this form.

from  Form
unsetValidator()

Remove the {@link Validator} from this from.

from  Form
transformTo(FormTransformation $format)

Convert this form to another format.

from  Form
getExtraFields()

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

from  Form
Fields()

Return the form's fields - used by the templates

from  Form
HiddenFields()

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

from  Form
VisibleFields()

Return all fields except for the hidden fields.

from  Form
$this
setFields(FieldList $fields)

Setter for the form fields.

from  Form
Actions()

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

from  Form
$this
setActions(FieldList $actions)

Setter for the form actions.

from  Form
unsetAllActions()

Unset all form actions

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

No description

from  Form
string
getAttribute($name)

No description

from  Form
array
getAttributes()

No description

from  Form
string
getAttributesHTML($attrs = null)

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

from  Form
FormAttributes()

No description

from  Form
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
getTemplateHelper()

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

from  Form
$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
$this
setLegend(string $legend)

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

from  Form
$this
setTemplate(string $template)

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

from  Form
string
getTemplate()

Return the template to render this form with.

from  Form
getEncType()

Returns the encoding type for the form.

from  Form
$this
setEncType(string $encType)

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

from  Form
string
FormHttpMethod()

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

from  Form
string
FormMethod()

Returns the form method to be used in the

tag.

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

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

from  Form
$this
setStrictFormMethodCheck($bool)

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

from  Form
bool
getStrictFormMethodCheck()

No description

from  Form
string
FormAction()

Return the form's action attribute.

from  Form
$this
setFormAction(string $path)

Set the form action attribute to a custom URL.

from  Form
string
FormName()

Returns the name of the form.

from  Form
$this
setHTMLID(string $id)

Set the HTML ID attribute of the form.

from  Form
string
getHTMLID()

No description

from  Form
Controller() deprecated

Returns this form's controller.

from  Form
getController()

Get the controller.

from  Form
setController(Controller $controller)

Set the controller.

from  Form
string
getName()

Get the name of the form.

from  Form
setName(string $name)

Set the name of the form.

from  Form
FieldMap()

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

from  Form
string
Message()

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

from  Form
string
MessageType()

No description

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

Set a status message for the form.

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

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

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

No description

from  Form
clearMessage()

No description

from  Form
resetValidation()

No description

from  Form
getRecord()

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

from  Form
string
getLegend()

Get the legend value to be inserted into the

element in Form.ss

from  Form
bool
validate()

Processing that occurs before a form is executed.

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

Load data from the given DataObject or array.

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

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

from  Form
array
getData()

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

from  Form
mixed
callfieldmethod(array $data)

Call the given method on the given field.

from  Form
HTML
forTemplate()

Return a rendered version of this form.

from  Form
HTML
forAjaxTemplate()

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

from  Form
HTML
formHtmlContent()

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

from  Form
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
$this
setButtonClicked(callable $funcName)

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

from  Form
buttonClicked()

No description

from  Form
defaultAction()

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

from  Form
disableDefaultAction()

Disable the default button.

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

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

from  Form
getSecurityToken()

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

from  Form
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
static string
current_action()

Return the current form action being called, if available.

from  Form
static 
set_current_action(string $action)

Set the current form action. Should only be called by {@link Controller}.

from  Form
string
extraClass()

Compiles all CSS-classes.

from  Form
$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
$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
debug()

No description

from  Form
testSubmission(string $action, array $data)

Test a submission of this form.

from  Form
testAjaxSubmission(string $action, array $data)

Test an ajax submission of this form.

from  Form
getAuthenticator()

Get the authenticator instance

string
getAuthenticatorName()

Get the authenticator name.

setAuthenticatorClass($class)

No description

dologin(array $data)

Login form handler method

logout()

Log out form handler method

performLogin($data)

Try to authenticate the user

forgotPassword(array $data)

Forgot password form handler method.

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

static SS_Object create()

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

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

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

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 {@link Object::create()}, except that classes are only overloaded if you set the $strong parameter to TRUE when using {@link 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 {@link 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 {@link 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

Parameters

$class
$name
$uncached

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

deprecated

Parameters

$class
$name
$value

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

deprecated

Parameters

$class
$name
$uncached

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

deprecated

Parameters

$class
$name
$ceiling

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

deprecated

Parameters

$class
$properties
$replace

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

deprecated

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 {@link Object::$extensions} array. See {@link SiteTree::$extensions} for examples. Keep in mind that the extension will only be applied to new instances, not existing ones (including all instances created through {@link singleton()}).

Parameters

string $classOrExtension

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

string $extension

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

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 {@link Object} instances which are already created, but will have an effect on new extensions. Clears any previously created singletons through {@link singleton()} to avoid side-effects from stale extension information.

Parameters

string $extension

Classname of an {@link Extension} subclass, without parameters

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

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 {@link DataExtension} classnames, or eval'ed classname strings with constructor arguments.

static get_extra_config_sources($class = null)

Parameters

$class

__construct(Controller $controller, string $name, FieldList $fields = null, FieldList $actions = null, bool $checkCurrentUser = true)

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 {@link FieldList} of {@link FormField} objects.

FieldList $actions

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

bool $checkCurrentUser

If set to TRUE, it will be checked if a the user is currently logged in, and if so, only a logout button will be rendered

mixed __call(string $method, array $arguments)

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

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

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

stat($name, $uncached = false)

Parameters

$name
$uncached

See also

SS_Object::get_static

set_stat($name, $value)

Parameters

$name
$value

See also

SS_Object::set_static

uninherited($name)

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 {@link DataObject} class could return false when it is deleted from the database

Return Value

bool

string parentClass()

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

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

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 {@link __construct()} in {@link defineMethods()}.

Parameters

string $method

the name of the method to call on each extension

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

Return Value

array

Extension 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 {@link $extension_instances}. Extension instances are initialized at constructor time, meaning if you use {@link add_extension()} afterwards, the added extension will just be added to new instances of the extended class. Use the static method {@link has_extension()} to check if a class (not an instance) has a specific extension.

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

Parameters

string $extension

Classname of an {@link Extension} subclass without parameters

Return Value

bool

array getExtensionInstances()

Get all extension instances for this specific object instance.

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

Return Value

array

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

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 {@link 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 {@link ViewableData::getField()}, then fall back on a failover object.

Parameters

string $property

Return Value

mixed

__set(string $property, mixed $value)

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

Parameters

string $property
mixed $value

setFailover(ViewableData $failover)

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

Parameters

ViewableData $failover

ViewableData|null getFailover()

Get the current failover object if set

Return Value

ViewableData|null

bool hasField(string $field)

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

Parameters

string $field

Return Value

bool

mixed getField(string $field)

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

Parameters

string $field

Return Value

mixed

setField(string $field, mixed $value)

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

Parameters

string $field
mixed $value

defineMethods()

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

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 {@link ViewableData_Customised} instance with references to both this and the new custom data.

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

Parameters

array|ViewableData $data

Return Value

ViewableData_Customised

ViewableData getCustomisedObj()

Return Value

ViewableData

setCustomisedObj(ViewableData $object)

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 {@link ViewableData::castingHelper()} for information on casting helpers).

The returned array contains two keys:

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

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

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 {@link ViewableData::obj()} that automatically caches the result so it can be used again without re-running the method.

Parameters

string $field
array $arguments
string $identifier

an optional custom cache identifier

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 {@link self::$url_handlers}.
    • If the rule matches, the named method will be called.
    • If there is still more URL to be processed, then handleRequest() is called on the object that that method returns.

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

Parameters

SS_HTTPRequest $request

The {@link SS_HTTPRequest} object that is reponsible for distributing URL parsing

DataModel $model

Return Value

SS_HTTPResponse|RequestHandler|string|array

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

checkAccessAction($action)

Parameters

$action

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

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

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 {@link NullHTTPRequest} object unless {@link handleAction()} or {@link handleRequest()} have been called, which adds a reference to an actual {@link SS_HTTPRequest} object.

setRequest($request)

Typically the request is set through {@link handleAction()} or {@link 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

httpSubmission(SS_HTTPRequest $request)

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

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

Parameters

SS_HTTPRequest $request

Exceptions

SS_HTTPResponse_Exception

FormField handleField(SS_HTTPRequest $request)

Handle a field request.

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

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)

Parameters

FormTransformation $trans

Validator getValidator()

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

Return Value

Validator

$this setValidator(Validator $validator)

Set the {@link Validator} on this form.

Parameters

Validator $validator

Return Value

$this

unsetValidator()

Remove the {@link Validator} from this from.

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 {@link CompositeFields}.

Useful when doing custom field layouts.

Return Value

FieldList

VisibleFields()

Return all fields except for the hidden fields.

Useful when making your own simplified form layouts.

$this setFields(FieldList $fields)

Setter for the form fields.

Parameters

FieldList $fields

Return Value

$this

FieldList Actions()

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

Return Value

FieldList

The action list

$this setActions(FieldList $actions)

Setter for the form actions.

Parameters

FieldList $actions

Return Value

$this

unsetAllActions()

Unset all form actions

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

Parameters

string $name
string $value

Return Value

$this

string getAttribute($name)

Parameters

$name

Return Value

string

$name

array getAttributes()

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

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 {@link 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 {@link setEncType}.

$this setEncType(string $encType)

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

Parameters

string $encType

Return Value

$this

string FormHttpMethod()

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

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

Return Value

string

HTTP method

string FormMethod()

Returns the form method to be used in the tag.

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

Return Value

string

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

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

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

Parameters

string $method
bool $strict

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

Return Value

$this

$this setStrictFormMethodCheck($bool)

If set to true, 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()

Return Value

bool

string FormAction()

Return the form's action attribute.

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

Return Value

string

$this setFormAction(string $path)

Set the form action attribute to a custom URL.

Note: For "normal" forms, you shouldn't need to use this method. It is recommended only for situations where you have two relatively distinct parts of the system trying to communicate via a form post.

Parameters

string $path

Return Value

$this

string FormName()

Returns the name of the form.

Return Value

string

$this setHTMLID(string $id)

Set the HTML ID attribute of the form.

Parameters

string $id

Return Value

$this

string getHTMLID()

Return Value

string

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

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 {@link 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 {@link Convert::raw2xml()} to escape any user supplied data in the message.

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

Parameters

$formName
$message
$type
$escapeHtml

clearMessage()

resetValidation()

DataObject getRecord()

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

Return Value

DataObject

string getLegend()

Get the legend value to be inserted into the

element in Form.ss

Return Value

string

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

Note that CSRF protection takes place in {@link 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 ({@link DatalessField}), as determined by {@link FieldList->dataFields()}.

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

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

Escaping happens automatically on saving the data through {@link saveInto()}.

Parameters

array|DataObject $data
int $mergeStrategy

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

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

You can pass a bitmask here to change this behaviour.

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

Passing IGNORE_FALSEISH means that any false-ish value in {@link $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 {@link FieldList->dataFields()}, which filters out any form-specific data like form-actions.

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

Return Value

array

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

Return Value

FormAction

FormAction defaultAction()

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

Return Value

FormAction

Form disableDefaultAction()

Disable the default button.

Ordinarily, when a form is processed and no action_XXX button is available, then the first button in the actions list will be pressed. However, if this is "delete", for example, this isn't such a good idea.

Return Value

Form

Form disableSecurityToken()

Disable the requirement of a security token on this form instance. This security protects against CSRF attacks, but you should disable this if you don't want to tie a form to a session - eg a search form.

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

Return Value

Form

Form enableSecurityToken()

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

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

Return Value

Form

SecurityToken|null getSecurityToken()

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

Doesn't check for {@link securityTokenEnabled()}.

Use {@link SecurityToken::inst()} to get a global token.

Return Value

SecurityToken|null

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

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.

Authenticator getAuthenticator()

Get the authenticator instance

Return Value

Authenticator

Returns the authenticator instance for this login form.

string getAuthenticatorName()

Get the authenticator name.

Return Value

string

The friendly name for use in templates, etc.

setAuthenticatorClass($class)

Parameters

$class

dologin(array $data)

Login form handler method

This method is called when the user clicks on "Log in"

Parameters

array $data

Submitted data

logout()

Log out form handler method

This method is called when the user clicks on "logout" on the form created when the parameter $checkCurrentUser of the {@link __construct constructor} was set to TRUE and the user was currently logged in.

Member performLogin($data)

Try to authenticate the user

Parameters

$data

Return Value

Member

Returns the member object on successful authentication or NULL on failure.

forgotPassword(array $data)

Forgot password form handler method.

Called when the user clicks on "I've lost my password". Extensions can use the 'forgotPassword' method to veto executing the logic, by returning FALSE. In this case, the user will be redirected back to the form without further action. It is recommended to set a message in the form detailing why the action was denied.

Parameters

array $data

Submitted data