core_auth Class Reference

Inheritance diagram for core_auth:

Collaboration diagram for core_auth:

Public Member Functions
	__construct ()
	base constructor. Most plugins will just use this More...
	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, $oauth=false)
	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, $oauth=false, $isRest=false)
Public Member Functions inherited from FO_Plugin
	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.
	Initialize ()
	dummy stub till all references are removed.
	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.
	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 ()
	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 23 of file core-auth.php.

Constructor & Destructor Documentation

__construct()

core_auth::__construct

(

)

base constructor. Most plugins will just use this

Makes sure the plugin is in the correct state. If so, the plugin is inserted into the Plugins data structure.

The constructor assumes that Install() was already run one time (possibly years ago and not during this object's creation).

Returns

true on success, false on failure.

On failure the plugin is not used by the system. NOTE: This function must NOT assume that other plugins are installed. See PostInitialize.

Reimplemented from FO_Plugin.

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

Member Function Documentation

checkUsernameAndPassword()

core_auth::checkUsernameAndPassword	(		$userName,
			$password,
			$oauth = false,
			$isRest = false
	)

See if a username/password is valid.

Parameters

string	$userName
string	$password
boolean	$oauth	Request from oauth login
boolean	$isRest	Request from API token

Returns

boolean

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

Install()

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.

Reimplemented from FO_Plugin.

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

updateSession()

core_auth::updateSession	(		$userRow,
			$oauth = false
	)

Set $_SESSION and $SysConf user variables.

Parameters

$UserRow

users table row, if empty, use Default User

Returns

void, updates globals $_SESSION and $SysConf[auth][UserId] variables \oauth variable if false then update vice versa.

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

---

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

• src/www/ui/core-auth.php