modules/Users/authentication/LDAPAuthenticate/LDAPAuthenticate.php

Show: inherited
Table of Contents

\LDAPAuthenticate

Package:

This file is used to control the authentication process.

It will call on the user authenticate and controll redirection based on the users validation

Parent(s)
\SugarAuthenticate

Properties

Propertypublic  $authenticationDir= ''LDAPAuthenticate''
Default value'LDAPAuthenticate'Details
Type
n/a
Propertypublic  $userAuthenticateClass= ''LDAPAuthenticateUser''
Default value'LDAPAuthenticateUser'Details
Type
n/a

Methods

methodpublicLDAPAuthenticate( ) : \LDAPAuthenticate

Constructs LDAPAuthenticate This will load the user authentication class

Returns
Type Description
\LDAPAuthenticate
methodpublicSugarAuthenticate( ) : \SugarAuthenticate
inherited

Constructs SugarAuthenticate This will load the user authentication class

Inherited from: \SugarAuthenticate::SugarAuthenticate()
Returns
Type Description
\SugarAuthenticate
methodpubliccanChangePassword( ) : void
inherited

If a user may change there password through the Sugar UI

Inherited from: \SugarAuthenticate::canChangePassword()
methodpubliccanChangeUserName( ) : void
inherited

If a user may change there user name through the Sugar UI

Inherited from: \SugarAuthenticate::canChangeUserName()
methodpublicencodePassword( STRING $password ) : STRING
inherited

Encodes a users password. This is a static function and can be called at any time.

Inherited from: \SugarAuthenticate::encodePassword()
Parameters
Name Type Description
$password STRING
Returns
Type Description
STRING $encoded_password
methodpublicloginAuthenticate( string $username, string $password,  $fallback = false,  $PARAMS = array () ) : boolean
inherited

Authenticates a user based on the username and password returns true if the user was authenticated false otherwise it also will load the user into current user if he was authenticated

Inherited from: \SugarAuthenticate::loginAuthenticate()
Parameters
Name Type Description
$username string
$password string
$fallback
$PARAMS
Returns
Type Description
boolean
methodpubliclogout( ) : void
inherited

Called when a user requests to logout

Inherited from: \SugarAuthenticate::logout()
methodpublicpostLoginAuthenticate( ) : void
inherited

Once a user is authenticated on login this function will be called. Populate the session with what is needed and log anything that needs to be logged

Inherited from: \SugarAuthenticate::postLoginAuthenticate()
methodpublicpostSessionAuthenticate( ) : boolean
inherited

Called after a session is authenticated - if this returns false the sessionAuthenticate will return false and destroy the session and it will load the current user

Inherited from: \SugarAuthenticate::postSessionAuthenticate()
Returns
Type Description
boolean
methodpublicpre_login( ) : void
inherited

pre_login

Inherited from: \SugarAuthenticate::pre_login()

This function allows the SugarAuthenticate subclasses to perform some pre login initialization as needed

methodpublicsessionAuthenticate( ) : boolean
inherited

On every page hit this will be called to ensure a user is authenticated

Inherited from: \SugarAuthenticate::sessionAuthenticate()
Returns
Type Description
boolean
methodpublicvalidateIP( ) : void
inherited

Make sure a user isn't stealing sessions so check the ip to ensure that the ip address hasn't dramatically changed

Inherited from: \SugarAuthenticate::validateIP()
Documentation was generated by DocBlox 0.18.1.