Version: current

# Class ConfirmedPasswordField

Shows two password-fields, and checks for matching passwords. Optionally hides the fields by default and shows a link to toggle their visibility.

  Object
  ViewableData implements IteratorAggregate
  RequestHandler
  FormField
  ConfirmedPasswordField

Package: forms\fields-formattedinput
Located at sapphire/forms/ConfirmedPasswordField.php

## Methods summary

`public` | # `__construct( string $name, string $title = null, mixed $value = "", `Form` $form = null, boolean $showOnClick = false, string $titleConfirmField = null )` #### Parameters $name string $name $title string $title $value mixed $value $form Form $form $showOnClick boolean $showOnClick $titleConfirmField string $titleConfirmField Alternate title (not localizeable) #### Overrides `FormField::__construct`
`public` | # `Field( )` Returns the form field - used by templates. Although FieldHolder is generally what is inserted into templates, all of the field holder templates make use of $Field. It's expected that FieldHolder will give you the "complete" representation of the field on the form, whereas Field will give you the core editing widget, such as an input tag. Returns the form field - used by templates. Although FieldHolder is generally what is inserted into templates, all of the field holder templates make use of $Field. It's expected that FieldHolder will give you the "complete" representation of the field on the form, whereas Field will give you the core editing widget, such as an input tag. Our base FormField class just returns a span containing the value. This should be overridden! #### Overrides `FormField::Field`
`public` | # `setCanBeEmpty( mixed $value )` Can be empty is a flag that turns on/off empty field checking. For example, set this to false (the default) when creating a user account, and true Can be empty is a flag that turns on/off empty field checking. For example, set this to false (the default) when creating a user account, and true
`public` | # `setShowOnClickTitle( mixed $title )` The title on the link which triggers display of the "password" and "confirm password" formfields. Only used if setShowOnClick() is set to TRUE. The title on the link which triggers display of the "password" and "confirm password" formfields. Only used if setShowOnClick() is set to TRUE. #### Parameters $title $title
`public string` | # `getShowOnClickTitle( )` #### Returns `string` string
`public` | # `setRightTitle( mixed $title )` #### Overrides `FormField::setRightTitle`
`public` | # `setChildrenTitles( array: $titles )` #### Parameters $titles array: 2 entrie array with the customised title for each of the 2 children.
`public` | # `setValue( mixed $value )` Value is sometimes an array, and sometimes a single value, so we need to handle both cases Value is sometimes an array, and sometimes a single value, so we need to handle both cases #### Overrides `FormField::setValue`
`public` | # `jsValidation( )` javascript handler Functions for each field type by default formfield doesnt have a validation function javascript handler Functions for each field type by default formfield doesnt have a validation function #### Overrides `FormField::jsValidation`
`public boolean` | # `isSaveable( )` Determines if the field was actually shown on the clientside - if not, we don't validate or save it. Determines if the field was actually shown on the clientside - if not, we don't validate or save it. #### Returns `boolean` bool
`public` | # `validate( )` Validation Functions for each field type by default formfield doesnt have a validation function Validation Functions for each field type by default formfield doesnt have a validation function #### Overrides `FormField::validate`
`public boolean` | # `saveInto( `DataObject` $record )` Only save if field was shown on the client, and is not empty. Only save if field was shown on the client, and is not empty. #### Parameters $record DataObject $record #### Returns `boolean` bool #### Overrides `FormField::saveInto`
`public` | # `performReadonlyTransformation( )` Makes a pretty readonly field with some stars in it Makes a pretty readonly field with some stars in it #### Overrides `FormField::performReadonlyTransformation`

### Methods inherited from FormField

`FieldHolder()`, `LeftTitle()`, `Link()`, `Message()`, `MessageType()`, `Name()`, `Required()`, `RightTitle()`, `SmallFieldHolder()`, `Title()`, `Type()`, `Value()`, `addExtraAttribute()`, `addExtraClass()`, `allowHTML5()`, `allow_html5()`, `attrName()`, `attrTitle()`, `attrValue()`, `createTag()`, `dataValue()`, `debug()`, `describe()`, `extraClass()`, `fieldHolderTemplates()`, `fieldTemplates()`, `forTemplate()`, `getCustomValidationMessage()`, `getExtraClasses()`, `getForm()`, `getHTML5Attribute()`, `getTabIndex()`, `getTabIndexHTML()`, `hasClass()`, `hasData()`, `id()`, `isComposite()`, `isDisabled()`, `isReadonly()`, `name_to_label()`, `performDisabledTransformation()`, `removeExtraAttribute()`, `removeExtraClass()`, `rootFieldSet()`, `securityTokenEnabled()`, `setAutocomplete()`, `setContainerFieldSet()`, `setCustomValidationMessage()`, `setDisabled()`, `setError()`, `setFieldHolderTemplate()`, `setForm()`, `setHTML5Attribute()`, `setLeftTitle()`, `setName()`, `setReadonly()`, `setSmallFieldHolderTemplate()`, `setTabIndex()`, `setTemplate()`, `setTitle()`, `smallFieldHolderTemplates()`, `transform()`, `useHTML5()`, `use_html5()`

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

`public integer` | $minLength | # Minimum character length of the password. Minimum character length of the password.
`public integer` | $maxLength | # Maximum character length of the password. Maximum character length of the password.
`public boolean` | $requireStrongPassword | # Enforces at least one digit and one alphanumeric character (in addition to {$minLength} and {$maxLength} Enforces at least one digit and one alphanumeric character (in addition to {$minLength} and {$maxLength}
`public boolean` | $canBeEmpty | # Allow empty fields in serverside validation Allow empty fields in serverside validation
`protected boolean` | $showOnClick | # If set to TRUE, the "password" and "confirm password" formfields will be hidden via CSS and JavaScript by default, and triggered by a link. An additional hidden field determines if showing the fields has been triggered, and just validates/saves the input in this case. This behaviour works unobtrusively, without JavaScript enabled the fields show, validate and save by default. If set to TRUE, the "password" and "confirm password" formfields will be hidden via CSS and JavaScript by default, and triggered by a link. An additional hidden field determines if showing the fields has been triggered, and just validates/saves the input in this case. This behaviour works unobtrusively, without JavaScript enabled the fields show, validate and save by default. #### Param boolean $showOnClick
`public string` | $showOnClickTitle | # Title for the link that triggers the visibility of password fields. Title for the link that triggers the visibility of password fields.

### Properties inherited from FormField

`$autocomplete`, `$containerFieldSet`, `$customValidationMessage`, `$description`, `$disabled`, `$dontEscape`, `$extraAttributes`, `$extraClass`, `$extraClasses`, `$fieldHTML5`, `$fieldHolderTemplate`, `$form`, `$html5Attributes`, `$leftTitle`, `$message`, `$messageType`, `$name`, `$possible_autocomplete_values`, `$readonly`, `$rightTitle`, `$smallFieldHolderTemplate`, `$tabIndex`, `$template`, `$title`, `$use_html5`, `$value`

### Properties inherited from RequestHandler

`$allowed_actions`, `$brokenOnConstruct`, `$request`, `$url_handlers`

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