Interface UserInterface

UserInterface implements the authentication procedure and provides access to authentication credentials of the user

Nethgui\Authorization\UserInterface implements Nethgui\Authorization\AuthorizationAttributesProviderInterface

Namespace: Nethgui\Authorization
Author: Davide Principi davide.principi@nethesis.it
Since: 1.0
Api
Located at Authorization/UserInterface.php

Methods summary
`public boolean`	# `authenticate( )` Authenticate the user through the given credentials. Authenticate the user through the given credentials. NOTE: You can pass an arbitrary number of arguments to the authentication procedure. The actual number of arguments depends on the implementation. Returns boolean TRUE if authentication is successful See `Nethgui\Authorization\UserInterface::isAuthenticated()` Api
`public boolean`	# `isAuthenticated( )` The authentication state The authentication state Returns boolean TRUE if authenticated, FALSE otherwise Api
`public mixed`	# `getCredential( string $credentialName )` Authentication credentials are acquired during authentication and provide the basic informations for authorization decisions. Authentication credentials are acquired during authentication and provide the basic informations for authorization decisions. Parameters `$credentialName` Returns mixed Api
`public boolean`	# `hasCredential( $credentialName )` Check whether $credentialName is present or not. Check whether $credentialName is present or not. Returns boolean Api
`public string`	# `getLanguageCode( )` The language that was choosen by the user The language that was choosen by the user Deprecated since version 1.7.0 Returns string ISO 639-1 language code (2 characters). Api
`public string`	# `getLocale( )` Get the User preferred locale Get the User preferred locale Returns string RFC 4646 compliant Api

Methods inherited from Nethgui\Authorization\AuthorizationAttributesProviderInterface
`asAuthorizationString(), getAuthorizationAttribute()`

Constants summary
`string`	`ID`	# `__CLASS__`