Version: current

# Class MemberAuthenticator

Authenticator for the default "member" method

  Object
  Authenticator
  MemberAuthenticator

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

## Methods summary

`public static boolean|`Member`` | # `authenticate( array $RAW_data, `Form` $form = null )` Method to authenticate an user Method to authenticate an user #### Parameters $RAW_data array $RAW_data Raw data to authenticate the user $form Form $form Optional: If passed, better error messages can be produced by using `Form::sessionMessage()` #### Returns `boolean|`Member`` Returns FALSE if authentication fails, otherwise the member object #### See ``Security::setDefaultAdmin()``
`public static `Form`` | # `get_login_form( `Controller` $controller )` Method that creates the login form for this authentication method Method that creates the login form for this authentication method #### Parameters $controller Controller The parent controller, necessary to create the appropriate form action tag #### Returns ``Form`` Returns the login form to use with this authentication method
`public static string` | # `get_name( )` Get the name of the authentication method Get the name of the authentication method #### Returns `string` Returns the name of the authentication method.

### Methods inherited from Authenticator

`get_authenticators()`, `get_default_authenticator()`, `is_registered()`, `on_register()`, `on_unregister()`, `register()`, `register_authenticator()`, `set_default_authenticator()`, `unregister()`, `unregister_authenticator()`

### Methods inherited from Object

`__call()`, `__construct()`, `__toString()`, `__wakeup()`, `addMethodsFrom()`, `addStaticVars()`, `addWrapperMethod()`, `add_extension()`, `add_static_var()`, `allMethodNames()`, `cacheToFile()`, `cacheToFileWithArgs()`, `clearCache()`, `combined_static()`, `create()`, `createMethod()`, `create_from_string()`, `defineMethods()`, `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 static Array` | $migrate_legacy_hashes | # Contains encryption algorithm identifiers. If set, will migrate to new precision-safe password hashing upon login. See http://open.silverstripe.org/ticket/3004. Contains encryption algorithm identifiers. If set, will migrate to new precision-safe password hashing upon login. See http://open.silverstripe.org/ticket/3004.

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