FOSSology  3.2.0rc1
Open Source License Compliance by Open Source Software
core_auth Class Reference
Inheritance diagram for core_auth:
Inheritance graph
Collaboration diagram for core_auth:
Collaboration graph

Public Member Functions

 staticValue ()
 getter to retreive value of static var
 
 Install ()
 Only used during installation. This may be called multiple times. Used to ensure the DB has the right default columns. More...
 
 PostInitialize ()
 This is where the magic for Authentication happens.
 
 updateSession ($userRow)
 Set $_SESSION and $SysConf user variables. More...
 
 getIP ()
 Retrieve the user's IP address. Some proxy systems pass forwarded IP address info. This ensures that someone who steals the cookie won't gain access unless they come from the same IP.
 
 Output ()
 This is only called when the user logs out.
 
 OutputOpen ()
 perform logout
 
 checkUsernameAndPassword ($userName, $password)
 See if a username/password is valid. More...
 
- Public Member Functions inherited from FO_Plugin
 Install ()
 This function (when defined) is only called when the plugin is first installed. It should make sure all requirements are available and create anything it needs to run. It returns 0 on success, non-zero on failure. A failed install is not inserted in the system. More...
 
 Remove ()
 This function (when defined) is only called once, when the plugin is removed. It should uninstall and remove all items that are only used by this plugin. There should be no residues – if the plugin is ever installed again, it should act like a clean install. Thus, any DB, files, or state variables specific to this plugin must be removed. This function must always succeed.
 
 __construct ()
 base constructor. Most plugins will just use this More...
 
 Initialize ()
 dummy stub till all references are removed.
 
 PostInitialize ()
 This function is called before the plugin is used and after all plugins have been initialized. If there is any initialization step that is dependent on other plugins, put it here. More...
 
 RegisterMenus ()
 While menus can be added to any time at or after the PostInitialize phase, this is the standard location for registering this item with menus. More...
 
 Destroy ()
 This is a destructor called after the plugin is no longer needed. It should assume that PostInitialize() was already run one time (this session) and succeeded. This function must always succeed.
 
 OutputOpen ()
 This function is called when user output is requested. This function is responsible for assigning headers.
 
 OutputUnSet ()
 Similar to OutputClose, this ends the output type for this object. However, this does NOT change any global settings. This is called when this object is a dependency for another object.
 
 getResponse ()
 
 Output ()
 This function is called when user output is requested. This function is responsible for content. (OutputOpen and Output are separated so one plugin can call another plugin's Output.)
 
 getTemplateName ()
 
 renderString ($templateName, $vars=null)
 
 renderScripts ($scripts)
 Render JavaScript in the template's footer. More...
 
 getRequest ()
 
 execute ()
 
 preInstall ()
 
 postInstall ()
 
 unInstall ()
 
 getName ()
 
 __toString ()
 

Static Public Attributes

static $origReferer
 

Private Attributes

 $dbManager
 
 $userDao
 
 $session
 
 $authExternal
 

Additional Inherited Members

- Public Attributes inherited from FO_Plugin
 $State = PLUGIN_STATE_INVALID
 
 $Name = ""
 
 $Version = "1.0"
 
 $Title = ""
 
 $DBaccess = PLUGIN_DB_NONE
 
 $LoginFlag = 0
 
 $NoMenu = 0
 
 $NoHeader = 0
 
 $PluginLevel = 10
 
 $Dependency = array()
 
 $InitOrder = 0
 
 $MenuList = NULL
 
 $MenuOrder = 0
 
 $MenuTarget = NULL
 
 $OutputType = "HTML"
 
 $OutputToStdout = 0
 
- Protected Member Functions inherited from FO_Plugin
 render ($templateName, $vars=null)
 
- Protected Attributes inherited from FO_Plugin
 $microMenu
 
 $renderer
 
 $vars = array()
 

Detailed Description

Definition at line 29 of file core-auth.php.

Member Function Documentation

core_auth::checkUsernameAndPassword (   $userName,
  $password 
)

See if a username/password is valid.

Returns
boolean

Definition at line 267 of file core-auth.php.

core_auth::Install ( )

Only used during installation. This may be called multiple times. Used to ensure the DB has the right default columns.

Returns
0 on success, non-zero on failure.

Definition at line 71 of file core-auth.php.

core_auth::updateSession (   $userRow)

Set $_SESSION and $SysConf user variables.

Parameters
$UserRowusers table row, if empty, use Default User
Returns
void, updates globals $_SESSION and $SysConf[auth][UserId] variables

Definition at line 156 of file core-auth.php.


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