Class LoginForm

Abstract base class for a login form

This class is used as a base class for the different log-in forms like MemberLoginForm or OpenIDLoginForm.

Object

Extended by

ViewableData implements IteratorAggregate

Extended by

RequestHandler

Extended by

Form

Extended by

LoginForm

Direct known subclasses

MemberLoginForm

Abstract
Package: sapphire\security
Author: Markus Lanthaler <markus@silverstripe.com>
Located at sapphire/security/LoginForm.php

Methods summary

`public`	# `__construct( Controller $controller, String $name, FieldSet $fields, FieldSet $actions )` Create a new form, with the given fields an action buttons. Create a new form, with the given fields an action buttons. Parameters `$controller` Controller $controller The parent controller, necessary to create the appropriate form action tag. `$name` String $name The method on the controller that will return this form object. `$fields` FieldSet $fields All of the fields in the form - a `FieldSet` of `FormField` objects. `$actions` FieldSet $actions All of the action buttons in the form - a `FieldSet` of `FormAction` objects Overrides `Form::__construct`
`public Authenticator`	# `getAuthenticator( )` Get the authenticator class Get the authenticator class Returns `Authenticator` Returns the authenticator class for this login form.

Methods inherited from Form

Actions(), Controller(), FieldMap(), Fields(), FormAction(), FormAttributes(), FormEncType(), FormHttpMethod(), FormMethod(), FormName(), HiddenFields(), Message(), MessageType(), Name(), addErrorMessage(), addExtraClass(), buttonClicked(), callfieldmethod(), clearMessage(), current_action(), dataFieldByName(), debug(), defaultAction(), disableDefaultAction(), disableSecurityToken(), disable_all_security_tokens(), extraClass(), forAjaxTemplate(), forTemplate(), formHtmlContent(), getData(), getExtraClasses(), getExtraFields(), getLegend(), getMessageFromSession(), getRecord(), getRedirectToFormOnValidationError(), getTemplate(), getValidator(), handleField(), httpSubmission(), loadDataFrom(), makeReadonly(), messageForForm(), removeExtraClass(), renderWithoutActionButton(), resetField(), resetValidation(), saveInto(), securityTokenEnabled(), sessionMessage(), setActions(), setButtonClicked(), setFields(), setFormAction(), setFormMethod(), setHTMLID(), setLegend(), setMessage(), setRedirectToFormOnValidationError(), setTarget(), setTemplate(), setValidator(), set_current_action(), setupFormErrors(), single_field_required(), testAjaxSubmission(), testSubmission(), transform(), transformTo(), unsetActionByName(), unsetAllActions(), unsetDataFieldByName(), unsetFieldFromTab(), unsetValidator(), validate()

Methods inherited from RequestHandler

allowedActions(), checkAccessAction(), getRequest(), handleRequest(), hasAction(), httpError()

Methods inherited from ViewableData

ATT_val(), BaseHref(), CSSClasses(), ColumnBreak(), ColumnCalc(), ColumnNumber(), ColumnPad(), ColumnPos(), CurrentMember(), CurrentPage(), Debug(), Even(), EvenOdd(), First(), FirstLast(), HasPerm(), IsAjax(), JS_val(), Last(), Me(), Middle(), MiddleString(), Modulus(), MultipleOf(), Odd(), Pos(), RAW_val(), SQL_val(), ThemeDir(), ThemeName(), Top(), TotalItems(), XML_val(), __get(), __isset(), __set(), buildCastingCache(), cachedCall(), castingClass(), castingHelper(), castingHelperPair(), castingObjectCreator(), castingObjectCreatorPair(), customise(), defineMethods(), escapeTypeForField(), getField(), getIterator(), getSecurityID(), getXMLValues(), hasField(), hasValue(), i18nLocale(), iteratorProperties(), obj(), renderWith(), setCustomisedObj(), setField()

Methods inherited from Object

__call(), __toString(), __wakeup(), addMethodsFrom(), addStaticVars(), addWrapperMethod(), add_extension(), add_static_var(), allMethodNames(), cacheToFile(), cacheToFileWithArgs(), clearCache(), combined_static(), create(), createMethod(), create_from_string(), exists(), extInstance(), extend(), getCustomClass(), getExtensionInstance(), getExtensionInstances(), get_extensions(), get_static(), hasExtension(), hasMethod(), has_extension(), invokeWithExtensions(), is_a(), loadCache(), parentClass(), parse_class_spec(), remove_extension(), sanitiseCachename(), saveCache(), set_stat(), set_static(), set_uninherited(), stat(), strong_create(), uninherited(), uninherited_static(), useCustomClass()

Magic methods summary

Properties summary

`protected string`	`$authenticator_class`	# Authenticator class to use with this login form Authenticator class to use with this login form Set this variable to the authenticator class to use with this login form.

Properties inherited from Form

$IncludeFormTag, $actions, $buttonClickedFunc, $controller, $current_action, $extraClasses, $fields, $formMethod, $hasDefaultAction, $jsValidationIncluded, $legend, $message, $messageType, $name, $record, $redirectToFormOnValidationError, $security, $target, $template, $url_handlers, $validator

Properties inherited from RequestHandler

$allowed_actions, $brokenOnConstruct, $request

Properties inherited from ViewableData

$casting, $customisedObject, $default_cast, $failover, $iteratorPos, $iteratorTotalItems

Properties inherited from Object

$class, $extension_instances, $extensions

[Raise a SilverStripe Framework issue/bug](https://github.com/silverstripe/silverstripe-framework/issues/new)
- [Raise a SilverStripe CMS issue/bug](https://github.com/silverstripe/silverstripe-cms/issues/new)
- Please use the Silverstripe Forums to ask development related questions. -