• Home
• lithium
• security
• Auth

PHP Class lithium\security\Auth

Auth is responsible for managing session state for each configuration, and exposes a set of methods which adapters can implement: set(), check() and clear(). You can read more about each method below. Beyond these methods, Auth makes very few assumptions about how your application authenticates users. Each adapter accepts a set of credentials, and returns an array of user information on success, and false on failure. On successful authentication attempts, the data returned from the credential check is written to the session, which is automatically accessed on subsequent checks (though manual re-checking can be forced on a per-instance basis). To be secure by default (and if you don't override it), a password field is never stored in the session adapter. This prevents a possible password hash to be leaked in a cookie (for example). You can also be very specific on what you want to store in the session: Auth::config(array( 'default' => array( 'session' => array( 'persist' => array('username', 'email') ) ) )); You can also pass an optional persist param to the check method to override this default. For additional information on configuring and working with Auth, see the Form adapter. 显示文件 Open project: unionofrad/lithium Class Usage Examples

Protected Properties

Property	Type	Description
$_adapters		Libraries::locate() compatible path to adapters for this class.
$_classes		Dynamic class dependencies.
$_configurations		Stores configurations for various authentication adapters.

Public Methods

Method	Description
check ( string $name, mixed $credentials = null, array $options = [] ) : array	Performs an authentication check against the specified configuration, and writes the resulting user information to the session such that credentials are not required for subsequent authentication checks, and user information is returned directly from the session.
clear ( string $name, array $options = [] ) : void	Removes session information for the given configuration, and allows the configuration's adapter to perform any associated cleanup tasks.
set ( string $name, array $data, array $options = [] ) : array	Manually authenticate a user with the given set of data. Rather than checking a user's credentials, this method allows you to manually specify a user for whom you'd like to initialize an authenticated session.

Protected Methods

Method	Description
_initConfig ( string $name, array $config ) : array	Called when an adapter configuration is first accessed, this method sets the default configuration for session handling. While each configuration can use its own session class and options, this method initializes them to the default dependencies written into the class.

Method Details

Property Details