blueshoes php application framework and cms            core_auth
[ class tree: core_auth ] [ index: core_auth ] [ all elements ]

Element index for package core_auth

[ a ] [ b ] [ c ] [ e ] [ f ] [ g ] [ h ] [ i ] [ k ] [ l ] [ m ] [ o ] [ p ] [ r ] [ s ] [ t ] [ u ] [ v ] [ _ ]

_

$_formRecoverPasswordByUsername
in file Bs_UserManagement.class.php, variable Bs_UserManagement::$_formRecoverPasswordByUsername
$_formSignup
in file Bs_UserManagement.class.php, variable Bs_UserManagement::$_formSignup
$_groups
in file Bs_Group.class.php, variable Bs_Group::$_groups
$_groups
in file Bs_UserManagement.class.php, variable Bs_UserManagement::$_groups
$_items
in file Bs_UserManagement.class.php, variable Bs_UserManagement::$_items
$_permissions
in file Bs_UserManagement.class.php, variable Bs_UserManagement::$_permissions
$_relations
in file Bs_UserManagement.class.php, variable Bs_UserManagement::$_relations
$_users
in file Bs_UserManagement.class.php, variable Bs_UserManagement::$_users
$_users
in file Bs_Group.class.php, variable Bs_Group::$_users
    $users = array(
$_APP
in file Bs_Cug.class.php, variable Bs_Cug::$_APP (subpackage: cug)
    reference to the global settings hash.
$_postVars
in file Bs_Cug.class.php, variable Bs_Cug::$_postVars (subpackage: cug)
    reference to the HTTP_POST_VARS array.
$_signupForm
in file Bs_CugDb.class.php, variable Bs_CugDb::$_signupForm (subpackage: cug)
    instance of Bs_Form by setting this var you can create custom signup forms.
_logAttempt
in file Bs_Cug.class.php, method Bs_Cug::_logAttempt() (subpackage: cug)
    overwrite this method.
_validateLogin
in file Bs_Cug.class.php, method Bs_Cug::_validateLogin() (subpackage: cug)
    developer: if you subclass then overwrite this method, and make sure this gets called after you validated what you can. here we'll see if there are registered validators to call, and do the work. on the first error we stop and return.
top

a

$appName
in file Bs_UserManagement.class.php, variable Bs_UserManagement::$appName
addUser
in file test.php, function addUser()
addUser
in file Bs_Group.class.php, method Bs_Group::addUser()
$actionOnHack
in file Bs_Cug.class.php, variable Bs_Cug::$actionOnHack (subpackage: cug)
    currently emails the admin (webmaster) on the 3rd hack attempt.
top

b

BS_CUGARRAU_VERSION
in file Bs_CugArray.class.php, constant BS_CUGARRAU_VERSION
BS_CUGDB_VERSION
in file Bs_CugDb.class.php, constant BS_CUGDB_VERSION
BS_CUG_CASE_SENSITIVE_NO
in file Bs_Cug.class.php, constant BS_CUG_CASE_SENSITIVE_NO
BS_CUG_CASE_SENSITIVE_ONLY_PASSWORD
in file Bs_Cug.class.php, constant BS_CUG_CASE_SENSITIVE_ONLY_PASSWORD
BS_CUG_CASE_SENSITIVE_ONLY_USERNAME
in file Bs_Cug.class.php, constant BS_CUG_CASE_SENSITIVE_ONLY_USERNAME
BS_CUG_CASE_SENSITIVE_YES
in file Bs_Cug.class.php, constant BS_CUG_CASE_SENSITIVE_YES
BS_CUG_VERSION
in file Bs_Cug.class.php, constant BS_CUG_VERSION
Bs_Group
in file Bs_Group.class.php, method Bs_Group::Bs_Group()
    constructor
Bs_Group
in file Bs_Group.class.php, class Bs_Group
    Group Class for the User Management. EXPERIMENTAL!
BS_GROUP_VERSION
in file Bs_Group.class.php, constant BS_GROUP_VERSION
Bs_Password
in file Bs_Password.class.php, class Bs_Password
    Password class.
Bs_Password
in file Bs_Password.class.php, method Bs_Password::Bs_Password()
BS_PASSWORD_VERSION
in file Bs_Password.class.php, constant BS_PASSWORD_VERSION
Bs_User
in file Bs_User.class.php, class Bs_User
    User Class for the User Management. EXPERIMENTAL!
Bs_User
in file Bs_User.class.php, method Bs_User::Bs_User()
    constructor
Bs_UserManagement
in file Bs_UserManagement.class.php, class Bs_UserManagement
    User and Group Management. EXPERIMENTAL!
Bs_UserManagement
in file Bs_UserManagement.class.php, method Bs_UserManagement::Bs_UserManagement()
    constructor
BS_USERMANAGEMENT_VERSION
in file Bs_UserManagement.class.php, constant BS_USERMANAGEMENT_VERSION
BS_USER_VERSION
in file Bs_User.class.php, constant BS_USER_VERSION
Bs_Group.class.php
procedural page Bs_Group.class.php
Bs_Password.class.php
procedural page Bs_Password.class.php
Bs_UserManagement.class.php
procedural page Bs_UserManagement.class.php
Bs_User.class.php
procedural page Bs_User.class.php
Bs_CugArray.class.php
procedural page Bs_CugArray.class.php
Bs_CugDb.class.php
procedural page Bs_CugDb.class.php
Bs_Cug.class.php
procedural page Bs_Cug.class.php
$bsSession
in file Bs_Cug.class.php, variable Bs_Cug::$bsSession (subpackage: cug)
    reference to global session object.
Bs_Cug
in file Bs_Cug.class.php, class Bs_Cug (subpackage: cug)
    Closed User Group (Cug) Class
Bs_Cug
in file Bs_Cug.class.php, method Bs_Cug::Bs_Cug() (subpackage: cug)
    Constructor.
Bs_CugArray
in file Bs_CugArray.class.php, method Bs_CugArray::Bs_CugArray() (subpackage: cug)
    Constructor.
Bs_CugArray
in file Bs_CugArray.class.php, class Bs_CugArray (subpackage: cug)
    Cug Class using an array. extended from Bs_Cug, look there too.
Bs_CugDb
in file Bs_CugDb.class.php, method Bs_CugDb::Bs_CugDb() (subpackage: cug)
    Constructor.
Bs_CugDb
in file Bs_CugDb.class.php, class Bs_CugDb (subpackage: cug)
    CUG Class using a database. Extended from Bs_Cug, look there too.
top

c

createPronounceablePassword
in file Bs_Password.class.php, method Bs_Password::createPronounceablePassword()
    creates a pronounceable password.
$checkCaseSensitive
in file Bs_Cug.class.php, variable Bs_Cug::$checkCaseSensitive (subpackage: cug)
    how should username and password be compared? case sensitive or not?
$checkForHack
in file Bs_Cug.class.php, variable Bs_Cug::$checkForHack (subpackage: cug)
    if we should check for hack attempts or not.
checkLogDbTable
in file Bs_CugDb.class.php, method Bs_CugDb::checkLogDbTable() (subpackage: cug)
    checks if the log db table is ok.
createPassword
in file Bs_Cug.class.php, method Bs_Cug::createPassword() (subpackage: cug)
    creates a new pronounceable password and returns it.
cug.inc.php
procedural page cug.inc.php (subpackage: examples)
top

e

$email
in file Bs_User.class.php, variable Bs_User::$email
    the email address.
$endDatetime
in file Bs_User.class.php, variable Bs_User::$endDatetime
    when the account expires, empty = no expiration = never.
$errorMsg
in file Bs_Cug.class.php, variable Bs_Cug::$errorMsg (subpackage: cug)
    the error msg of the last error that occured.
top

f

$formFieldsUsed
in file Bs_User.class.php, variable Bs_User::$formFieldsUsed
    specifies the form fields that are in use.
$formRecoverPasswordByUsername
in file Bs_UserManagement.class.php, variable Bs_UserManagement::$formRecoverPasswordByUsername
$form
in file Bs_Cug.class.php, variable Bs_Cug::$form (subpackage: cug)
    an instance of bs_form.
$formAction
in file Bs_Cug.class.php, variable Bs_Cug::$formAction (subpackage: cug)
    the <form action=""> part. will be set to the form if set here.
$formTarget
in file Bs_Cug.class.php, variable Bs_Cug::$formTarget (subpackage: cug)
    the target the login form submits to.
top

g

$groupName
in file Bs_Group.class.php, variable Bs_Group::$groupName
getAllUsers
in file Bs_UserManagement.class.php, method Bs_UserManagement::getAllUsers()
getUser
in file Bs_UserManagement.class.php, method Bs_UserManagement::getUser()
    returns a reference to an instance of Bs_User for the given username.
getUser
in file Bs_Group.class.php, method Bs_Group::getUser()
    returns the user object for the user specified.
getDbString
in file Bs_CugDb.class.php, method Bs_CugDb::getDbString() (subpackage: cug)
    returns the dbname-dbtable string to use in queries.
getLoginForm
in file Bs_Cug.class.php, method Bs_Cug::getLoginForm() (subpackage: cug)
    returns the login form as html code.
getNumLoginFailures
in file Bs_CugDb.class.php, method Bs_CugDb::getNumLoginFailures() (subpackage: cug)
    tells how many times this user failed to login in a row.
getOldSids
in file Bs_CugDb.class.php, method Bs_CugDb::getOldSids() (subpackage: cug)
    returns the sid's (session id's) of session that existed for this user, before this one.
top

h

hasUserById
in file Bs_Group.class.php, method Bs_Group::hasUserById()
hasUserByUsername
in file Bs_Group.class.php, method Bs_Group::hasUserByUsername()
    tells if there is a user with the given username.
top

i

$isActive
in file Bs_User.class.php, variable Bs_User::$isActive
    if the account is active or not. default is false to be dummy-compatible.
initObjPersister
in file Bs_UserManagement.class.php, method Bs_UserManagement::initObjPersister()
isBadPassword
in file Bs_Password.class.php, method Bs_Password::isBadPassword()
    tells if the given password is insecure.
isBoyName
in file Bs_Password.class.php, method Bs_Password::isBoyName()
    tells if the given $name is a boy's first name.
isDictionaryWord
in file Bs_Password.class.php, method Bs_Password::isDictionaryWord()
    tells if $word is a dictionary word.
isFirstName
in file Bs_Password.class.php, method Bs_Password::isFirstName()
    tells if the given $name is a girl's or boy's first name.
isGirlName
in file Bs_Password.class.php, method Bs_Password::isGirlName()
    tells if the given $name is a girl's first name.
isSilly
in file Bs_Password.class.php, method Bs_Password::isSilly()
    tells if the given password is a silly password.
index.php
procedural page index.php (subpackage: examples)
top

k

killOldSessions
in file Bs_CugDb.class.php, method Bs_CugDb::killOldSessions() (subpackage: cug)
    kills old sessions that existed for this user, before this one.
top

l

loadAllUsers
in file Bs_UserManagement.class.php, method Bs_UserManagement::loadAllUsers()
    loads all existing users. yep.
loadFormHints
in file Bs_Group.class.php, method Bs_Group::loadFormHints()
loadFormHints
in file Bs_User.class.php, method Bs_User::loadFormHints()
loadGroup
in file Bs_UserManagement.class.php, method Bs_UserManagement::loadGroup()
loadItems
in file Bs_UserManagement.class.php, method Bs_UserManagement::loadItems()
loadPermissions
in file Bs_UserManagement.class.php, method Bs_UserManagement::loadPermissions()
loadPersistHints
in file Bs_User.class.php, method Bs_User::loadPersistHints()
loadPersistHints
in file Bs_Group.class.php, method Bs_Group::loadPersistHints()
loadRelations
in file Bs_UserManagement.class.php, method Bs_UserManagement::loadRelations()
loadUserByUsername
in file Bs_UserManagement.class.php, method Bs_UserManagement::loadUserByUsername()
    loads the user specified.
loadUsersAndGroups
in file Bs_UserManagement.class.php, method Bs_UserManagement::loadUsersAndGroups()
looksLikeHack
in file Bs_Password.class.php, method Bs_Password::looksLikeHack()
    tells if the user/pass combination looks like a hack attempt.
$language
in file Bs_Cug.class.php, variable Bs_Cug::$language (subpackage: cug)
    the language used
$logAttempts
in file Bs_Cug.class.php, variable Bs_Cug::$logAttempts (subpackage: cug)
    should we log login attempts?
$logDbName
in file Bs_CugDb.class.php, variable Bs_CugDb::$logDbName (subpackage: cug)
    the db of the log table.
$logTableName
in file Bs_CugDb.class.php, variable Bs_CugDb::$logTableName (subpackage: cug)
    the db table to log to. is also used to determine if it's
letMeIn
in file Bs_Cug.class.php, method Bs_Cug::letMeIn() (subpackage: cug)
    tells if the session is registered, the user is logged in.
loadLoginForm
in file Bs_Cug.class.php, method Bs_Cug::loadLoginForm() (subpackage: cug)
    loads a default login form if no login form has been assigned before.
loadRecoverPasswordByUsernameForm
in file Bs_Cug.class.php, method Bs_Cug::loadRecoverPasswordByUsernameForm() (subpackage: cug)
    loads a default "recover password by username" form.
logout
in file Bs_Cug.class.php, method Bs_Cug::logout() (subpackage: cug)
    logs out the user from this cug, does *not* kill the session cause it might be needed for other things.
looksLikeHack
in file Bs_Cug.class.php, method Bs_Cug::looksLikeHack() (subpackage: cug)
    let's see if this failed attempt looks like a hack.
top

m

$manyFailuresErrorMsg
in file Bs_CugDb.class.php, variable Bs_CugDb::$manyFailuresErrorMsg (subpackage: cug)
    additional error message for users that tried to log in many times (+3) in a row and failed.
$maxNumAttempts
in file Bs_Cug.class.php, variable Bs_Cug::$maxNumAttempts (subpackage: cug)
    how many login attempts does the user have?
  1. means 'no limit'.
top

o

$objP
in file Bs_UserManagement.class.php, variable Bs_UserManagement::$objP
    object persister
top

p

$pass
in file Bs_User.class.php, variable Bs_User::$pass
    the password.
top

r

removeUser
in file Bs_Group.class.php, method Bs_Group::removeUser()
$recoverPasswordByUsernameForm
in file Bs_Cug.class.php, variable Bs_Cug::$recoverPasswordByUsernameForm (subpackage: cug)
    the form object to use when displaying the "recover password by username" form.
$redirectPage
in file Bs_Cug.class.php, variable Bs_Cug::$redirectPage (subpackage: cug)
    !!!deprecated!!! the page (maybe with directory) to which the user will be redirected once the login was successful.
recoverPasswordByUsername
in file Bs_CugDb.class.php, method Bs_CugDb::recoverPasswordByUsername() (subpackage: cug)
    recovers the password for the user specified and sends it by email if desired.
redirect
in file Bs_Cug.class.php, method Bs_Cug::redirect() (subpackage: cug)
    !!!deprecated!!! redirects to the specified page.
registerValidator
in file Bs_Cug.class.php, method Bs_Cug::registerValidator() (subpackage: cug)
    registers a global validator function (or object method) that needs to be passed in order to successfully pass the "validate login" checks.
resetPasswordByEmail
in file Bs_CugDb.class.php, method Bs_CugDb::resetPasswordByEmail() (subpackage: cug)
resetPasswordByUsername
in file Bs_CugDb.class.php, method Bs_CugDb::resetPasswordByUsername() (subpackage: cug)
    resets the users password to a newly created one, and mails it to the user if that's desired (see param $automail).
top

s

$startDatetime
in file Bs_User.class.php, variable Bs_User::$startDatetime
    when the account gets active, empty = no activation = immediatly.
$storageFieldsUsed
in file Bs_User.class.php, variable Bs_User::$storageFieldsUsed
    specifies the storage fields that are in use.
setUser
in file Bs_UserManagement.class.php, method Bs_UserManagement::setUser()
    adds the given user object.
showUsers
in file test.php, function showUsers()
storeUser
in file Bs_UserManagement.class.php, method Bs_UserManagement::storeUser()
    stores the user specified.
setDbObject
in file Bs_CugDb.class.php, method Bs_CugDb::setDbObject() (subpackage: cug)
    sets a db object for this class.
setSignupForm
in file Bs_CugDb.class.php, method Bs_CugDb::setSignupForm() (subpackage: cug)
    sets a custom form object, use this if you are not satisfied with the built in one.
top

t

test.php
procedural page test.php
treatLoginForm
in file Bs_Cug.class.php, method Bs_Cug::treatLoginForm() (subpackage: cug)
    treats the login form.
treatRecoverPasswordByUsernameForm
in file Bs_Cug.class.php, method Bs_Cug::treatRecoverPasswordByUsernameForm() (subpackage: cug)
    treats the "recover password by username" form.
top

u

$user
in file Bs_User.class.php, variable Bs_User::$user
    the username.
$unixLikeDoubleTimeout
in file Bs_Cug.class.php, variable Bs_Cug::$unixLikeDoubleTimeout (subpackage: cug)
    whether to use the unix-like double timeout after each wrong login attempt in a row. by default this is on.
$userDbName
in file Bs_CugDb.class.php, variable Bs_CugDb::$userDbName (subpackage: cug)
    the db of the user table.
$userFieldNames
in file Bs_Cug.class.php, variable Bs_Cug::$userFieldNames (subpackage: cug)
    the captions of the keys.
$userTableName
in file Bs_CugDb.class.php, variable Bs_CugDb::$userTableName (subpackage: cug)
    the db table where the users are.
top

v

validateLogin
in file Bs_User.class.php, method Bs_User::validateLogin()
    validates the given username and password.
top

Documentation generated on Mon, 29 Dec 2003 21:07:25 +0100 by phpDocumentor 1.2.3