FRED™  3.0
FRED™: Framework for Rapid and Easy Development
Authenticator Class Reference
Inheritance diagram for Authenticator:
Component Thing GeoIp Http Mail Password Subnet Token

Public Member Functions

 verified ($result)
 Process the result of a verification. More...
 
 regenerateSessionId ()
 
 invalidate ()
 
- Public Member Functions inherited from Component
 __construct ($fred, $config=null)
 
 __destruct ()
 
 clientConfig ()
 Public configuration. More...
 
 config ($key, $default=null)
 Retrieve a config value. More...
 
 ping ()
 Ping function. More...
 
 filemtime ($filename)
 Filemtime with session cache. More...
 
 component ($name)
 Get a component (local or default). More...
 
 components (... $names)
 Get multiple components in an array. More...
 
- Public Member Functions inherited from Thing
 propertyExists ($property)
 Check if a property exists (public or published). More...
 
 constants ($prefix=null)
 Return all constants. More...
 
 get ($key)
 Get one or more properties. More...
 
 set ($key, $value=null)
 Set one or more properties. More...
 
 __get ($key)
 
 __set ($key, $value)
 

Data Fields

 $maxSessionTime = null
 Maximum duration of a session (minutes; empty = infinite). More...
 
 $maxInactiveTime = null
 Maximum period of inactivity (minutes; empty = infinite). More...
 
 $controllerName = null
 Controller to redirect the user to if more information is required (e.g. a username and. More...
 
- Data Fields inherited from Component
 $filemtimeTtl = 0
 
- Data Fields inherited from Thing
const HIDDEN = 0
 Property is hidden. More...
 
const READABLE = 1
 Property is readable. More...
 
const WRITEABLE = 2
 Property is writeable. More...
 
const READWRITE = 3
 Property is readable and writeable. More...
 

Protected Member Functions

 check ()
 Perform the check. More...
 
 getAuthenticated ()
 
 getChecked ()
 
 setChecked ($value)
 
- Protected Member Functions inherited from Component
 init ()
 
 done ()
 
 getSession ()
 
- Protected Member Functions inherited from Thing
 publish ($property, $visibility=self::READABLE)
 Publish a property (or hide it again). More...
 
 configure ($config)
 Configure the object. More...
 
 _get ($key)
 Default getter if no specific setter is defined, and the property is also not published (readable). More...
 
 _set ($key, $value)
 Default setter if no specific setter is defined, and the property is also not published (writeable). More...
 

Additional Inherited Members

- Protected Attributes inherited from Component
 $_fred = null
 
 $_config = null
 
 $_name = null
 
 $_components = []
 Local components (key = component name, value = component). More...
 
 $_session = null
 
- Protected Attributes inherited from Thing
 $_published = []
 Published properties (key = name of property, value = visibility). More...
 

Detailed Description

Definition at line 5 of file Authenticator.php.

Member Function Documentation

◆ check()

check ( )
abstractprotected

Perform the check.

Returns
bool True if the user is authenticated. False if something is wrong. Null if the user has to provide some more information (set the $controllerName for this purpose).

◆ getAuthenticated()

getAuthenticated ( )
protected

Definition at line 45 of file Authenticator.php.

◆ getChecked()

getChecked ( )
protected

Definition at line 50 of file Authenticator.php.

◆ invalidate()

invalidate ( )

Definition at line 41 of file Authenticator.php.

◆ regenerateSessionId()

regenerateSessionId ( )

Definition at line 29 of file Authenticator.php.

◆ setChecked()

setChecked (   $value)
protected

Definition at line 61 of file Authenticator.php.

◆ verified()

verified (   $result)

Process the result of a verification.

Parameters
bool$result

Definition at line 23 of file Authenticator.php.

Field Documentation

◆ $controllerName

$controllerName = null

Controller to redirect the user to if more information is required (e.g. a username and.

Definition at line 10 of file Authenticator.php.

◆ $maxInactiveTime

$maxInactiveTime = null

Maximum period of inactivity (minutes; empty = infinite).

Definition at line 8 of file Authenticator.php.

◆ $maxSessionTime

$maxSessionTime = null

Maximum duration of a session (minutes; empty = infinite).

Definition at line 7 of file Authenticator.php.


The documentation for this class was generated from the following file: