PHPBoost Framework A.P.I.

AuthenticationMethod

Abstract Package: PHPBoost\User\authentication Copyright: © 2005-2019 PHPBoost License: GNU/GPL-3.0 Author: Loic ROUCHON horn@phpboost.com Version: PHPBoost 5.2 - last update: 2018 04 10 Since: PHPBoost 3.0 - 2010 11 28 Contributor: Julien BRISWALTER j1.seth@phpboost.com Located at: phpboost/user/authentication/AuthenticationMethod.class.php

The AuthenticationMethod interface could be implemented in different ways to enable specifics authentication mecanisms. PHPBoost comes with a PHPBoostAuthenticationMethod which will be performed on the internal member list. But it is possible to implement external authentication mecanism by providing others implementations of this class to support LDAP authentication, OpenID, Facebook connect and more...

Direct known subclasses

PHPBoostAuthenticationMethod

Methods summary
`abstract public`	# `associate( integer $user_id )` associate the current authentication method with the given user_id. associate the current authentication method with the given user_id. Parameters `$user_id` Throws `IllegalArgumentException` if the user_id is already associate with an authentication method
`abstract public`	# `dissociate( integer $user_id )` dissociate the current authentication method with the given user_id. dissociate the current authentication method with the given user_id. Parameters `$user_id` Throws `IllegalArgumentException` if the user_id is already dissociate with an authentication method
`abstract public integer`	# `authenticate( )` Tries to authenticate the user and returns true on success, false otherwise. Tries to authenticate the user and returns true on success, false otherwise. Returns integer $user_id, if authentication has been performed successfully
`public`	# `has_error( )`
`public`	# `get_error_msg( )`
`protected`	# `check_user_bannishment( $user_id )`
`protected`	# `update_user_last_connection_date( $user_id )`

Properties summary
`protected`	`$error_msg`	#

Direct known subclasses

Parameters

Throws

Parameters

Throws

Returns