Auth
[ class tree: Auth ] [ index: Auth ] [ all elements ]

Class: Auth_Anonymous

Source Location: /Auth-1.6.4/Auth/Anonymous.php

Class Overview

Auth
   |
   --Auth_Anonymous

Anonymous Authentication


Author(s):

Version:

  • Release: @package_version@ File: $Revision: 289651 $

Copyright:

  • 2001-2006 The PHP Group

Variables

Methods


Inherited Variables

Inherited Methods

Class: Auth

Auth::Auth()
Constructor
Auth::addUser()
Add user to the storage container
Auth::attachLogObserver()
Attach an Observer to the Auth Log Source
Auth::changePassword()
Change password for user in the storage container
Auth::checkAuth()
Checks if there is a session with valid auth information.
Auth::getAuth()
Has the user been authenticated?
Auth::getAuthData()
Get additional information that is stored in the session.
Auth::getPostPasswordField()
Gets the post varible used for the username
Auth::getPostUsernameField()
Gets the post varible used for the username
Auth::getStatus()
Get the current status
Auth::getUsername()
Get the username
Auth::listUsers()
List all users that are currently available in the storage container
Auth::log()
Log a message from the Auth system
Auth::logout()
Logout function
Auth::removeUser()
Remove user from the storage container
Auth::sessionValidThru()
Returns the time up to the session is valid
Auth::setAdvancedSecurity()
Enables advanced security checks
Auth::setAllowLogin()
Is Login Allowed from this page?
Auth::setAuth()
Register variable in a session telling that the user has logged in successfully
Auth::setAuthData()
Register additional information that is to be stored in the session.
Auth::setCheckAuthCallback()
Register a callback function to be called whenever the validity of the login is checked The function will receive two parameters, the username and a reference to the auth object.
Auth::setExpire()
Set the maximum expire time
Auth::setFailedLoginCallback()
Register a callback function to be called on failed user login.
Auth::setIdle()
Set the maximum idle time
Auth::setLoginCallback()
Register a callback function to be called on user login.
Auth::setLogoutCallback()
Register a callback function to be called on user logout.
Auth::setSessionName()
Set name of the session to a customized value.
Auth::setShowLogin()
Should the login form be displayed if necessary?
Auth::start()
Start new auth session
Auth::staticCheckAuth()
Statically checks if there is a session with valid auth information.

Class Details

[line 47]
Anonymous Authentication

This class provides anonymous authentication if username and password were not supplied



[ Top ]


Class Variables

$allow_anonymous =  true

[line 57]

Whether to allow anonymous authentication

Type:   boolean


[ Top ]

$anonymous_username =  'anonymous'

[line 64]

Username to use for anonymous user

Type:   string


[ Top ]



Method Detail

Auth_Anonymous (Constructor)   [line 84]

void Auth_Anonymous( string $storageDriver, [mixed $options = ''], [string $loginFunction = ''], [boolean $showLogin = true])

Pass all parameters to Parent Auth class

Set up the storage driver.


Parameters:

string   $storageDriver   —  Type of the storage driver
mixed   $options   —  Additional options for the storage driver (example: if you are using DB as the storage driver, you have to pass the dsn string here)
string   $loginFunction   —  Name of the function that creates the login form
boolean   $showLogin   —  Should the login form be displayed if necessary?

[ Top ]

forceLogin   [line 127]

void forceLogin( )

Force the user to login

Calling this function forces the user to provide a real username and password before continuing.


[ Top ]


Documentation generated on Mon, 11 Mar 2019 15:41:38 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.