Class BeAuthComponent

User/group/authorization component: - login, session start - user/group creation/handling

Object

BeAuthComponent

Direct known subclasses

BeAuthFacebookComponent, BeAuthGoogleComponent, BeAuthTwitterComponent

Located at controllers/components/be_auth.php

Methods summary

`public`	# `initialize( object & $controller )` Set current user, if already logged in and/or valid Set current user, if already logged in and/or valid Parameters `$controller`
`public boolean`	# `startSession( string $sessionId = null )` Start session if it isn't already started else check if it's valid Start session if it isn't already started else check if it's valid Parameters `$sessionId` the session id with which the session try to start (if not already started) Returns boolean true if session started and valid
`protected`	# `initExternalServices( )` Init external auth services components, reading 'extAuthParams' config Create components without components startup Init external auth services components, reading 'extAuthParams' config Create components without components startup
`public`	# `getExternalServices( )` Get external auth services list Get external auth services list
`protected`	# `startupExternalServices( )` Startup external auth service components Startup external auth service components
`protected`	# `checkSessionKey( )` Check whether session key is valid Check whether session key is valid
`public boolean`	# `externalLogin( string $extAuthType, string $extAuthOptions = array(), array $extAuthOptions,… )` User authentication on external service (OpenID. LDAP, Shibbolet...) User authentication on external service (OpenID. LDAP, Shibbolet...) Parameters `$extAuthType` $userid `$extAuthOptions` $extAuthType `$extAuthOptions`,… Returns boolean Throws `BeditaException`
`public boolean`	# `login( string $userid, string $password, array $policy = null, array $auth_group_name = array(), string $authType = 'bedita', array $extAuthOptions = array() )` User authentication User authentication Parameters `$userid` `$password` `$policy` (could contain parameters like maxLoginAttempts,maxNumDaysInactivity,maxNumDaysValidity) `$auth_group_name` `$authType` `$extAuthOptions` Returns boolean
`public number`	# `responseLogin( string $userid, string $password, array $policy = null, array $auth_group_name = array() )` Http code response for login attempt Http code response for login attempt Parameters `$userid` `$password` `$policy` (could contain parameters like maxLoginAttempts,maxNumDaysInactivity,maxNumDaysValidity) `$auth_group_name` Returns number (can be 200 'ok' 401 'unauthorized' 403 'forbidden'
`protected boolean`	# `loginPolicy( string $userid, array $u, array $policy = null, array $auth_group_name = array() )` Check policy using $policy array or config if null Check policy using $policy array or config if null Parameters `$userid` `$u` `$policy` (could contain parameters like maxLoginAttempts,maxNumDaysInactivity,maxNumDaysValidity) `$auth_group_name` Returns boolean
`public boolean`	# `changePassword( string $userid, string $password )` Change password for user and set num_login_err to 0 Change password for user and set num_login_err to 0 Parameters `$userid` `$password` Returns boolean
`public boolean`	# `logout( )` User logout: remove session data for the user User logout: remove session data for the user Returns boolean
`public boolean`	# `isLogged( )` Check whether current user is logged in Check whether current user is logged in Returns boolean
`public`	# `getAuthComponent( )` Get the current used component for the authentication Get the current used component for the authentication
`public`	# `getUser( )` Get the current logged user Get the current logged user
`public`	# `userid( )` Get the current logged userid or empty string if no user is logged Get the current logged userid or empty string if no user is logged
`public boolean`	# `isUserGroupAuthorized( array $groups = array() )` Check whether user group is authorized Check whether user group is authorized Parameters `$groups` Returns boolean
`public integer`	# `createUser( array $userData, array $groups = NULL, boolean $notify = true )` Create new user Create new user Parameters `$userData` `$groups` (contains groups names) `$notify` (send newUser backend notify) Returns integer id of user created Throws `BeditaException`
`public boolean`	# `checkConfirmPassword( string $password, string $confirmedPassword )` Check confirm password Check confirm password Parameters `$password` `$confirmedPassword` Returns boolean
`protected`	# `userGroupModel( array & $userData, array $groups )` Fill group data for user (set group data in $userData) Fill group data for user (set group data in $userData) Parameters `$userData` `$groups`
`public boolean`	# `updateUser( array $userData, array $groups = NULL )` Update user data Update user data Parameters `$userData` `$groups` Returns boolean Throws `BeditaException`
`public boolean`	# `removeGroup( string $groupName )` Remove group Remove group Parameters `$groupName` Returns boolean Throws `BeditaException`
`public integer`	# `saveGroup( array $groupData )` Save group Save group Parameters `$groupData` Returns integer group id Throws `BeditaException`
`public boolean`	# `removeUser( string $userId )` Remove user Remove user Parameters `$userId` Returns boolean Throws `BeditaException`
`public array`	# `connectedUser( )` Get users whose sessions are still active (not expired) Get users whose sessions are still active (not expired) Returns array
`public array`	# `unserializesession( array $data )` Unserialize session data Unserialize session data Parameters `$data` Returns array
`public mixed`	# `getUserSession( )` Get user session data if present, false otherwise Get user session data if present, false otherwise Returns mixed string\|boolean
`public`	# `setSessionVars( )` Set session variables (i.e. userAgent, ipNumber, time, Config.language) Set session variables (i.e. userAgent, ipNumber, time, Config.language)
`public`	# `updateSessionHistory( array $historyItem, array $historyConf )` Update session history Update session history Parameters `$historyItem` `$historyConf`

Constants summary

`string`	`SESSION_INFO_KEY`	# `"BESession"`

Properties summary

`public`	`$controller`	# `null`
`public array`	`$extAuthComponents`	# `array()`
`public`	`$Session`	# `null`
`public`	`$user`	# `null`
`public boolean`	`$isValid`	# `true`
`public boolean`	`$changePasswd`	# `false`
`public string`	`$sessionKey`	# `"BEAuthUser"`
`public string`	`$authResult`	# `'OK'`
`public string`	`$userAuth`	# `'bedita'`

Classes

Interfaces

Exceptions

Class BeAuthComponent

Direct known subclasses

Methods summary

Parameters

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Parameters

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Throws

Returns

Parameters

Returns

Returns

Parameters

Constants summary

Properties summary