Class: base_auth

Quellcode Position: Program_Root/base_auth.php

Class base_auth

Class Overview
Class Overview | Ableitungen | Inherited Properties And Methods | Properties Summary | Property Details | Method Summary | Method Details

User autentification

Verifying and change user data for admin interface

Implementiert in Program_Root/base_auth.php [Zeile 27] 

base_object
   |
   --base_db
      |
      --base_auth
Author(s):
  • Thomas Weinert
Information Tags:

Properties

Methods
[ Seitenanfang ]
Direct Derivates
Class Overview | Derivates | Inherited Properties And Methods | Properties Summary | Property Details | Method Summary | Method Details
Abgeleitete Class Description
papaya_user User class for papaya

[ Seitenanfang ]
Inherited Properties And Methods
Class Overview | Ableitungen | | Inherited Properties And Methods | Propertys Summary | Property Details | Method Summary | Method Details
Inherited Properties Inherited Methods

Abgeleitet von base_db

base_db::$dbobj_name
base_db::$dbsocket
base_db::$db_obj

Abgeleitet von base_db

base_db::createDBObject()
Create data base object(PEAR)
base_db::db_addField()
Interface function: insert field
base_db::db_addIndex()
Interface function: insert index
base_db::db_changeField()
Interface function: change field
base_db::db_changeIndex()
Interface function: change index
base_db::db_connect()
Connect to data base object
base_db::db_createTable()
Interface function: create given table
base_db::db_deleteRecord()
Interface function: delete database record
base_db::db_deleteRecords()
Interface function: delete records
base_db::db_dropField()
Interface function: delete field
base_db::db_dropIndex()
Interface function: delete index
base_db::db_emptyTable()
Interface function: delete ALL data in this table
base_db::db_getSQLSource()
DBMS spezific SQL source
base_db::db_insertRecord()
Interface function: create new record, return ID, set default values
base_db::db_insertRecords()
Interface function: insert records
base_db::db_query()
Interface function: submit database query
base_db::db_queryFmt()
Interface function: escape params and submit query
base_db::db_queryTableNames()
Interface function: delete all table names
base_db::db_queryTableStructure()
Interface function: table structur returned as array
base_db::db_updateRecord()
Interface function: change data record
base_db::db_updateRecords()
Interface function: change data records
base_db::escapeStr()
Store string in sql for use

Abgeleitet von base_object

base_object::addmsg()
Adds a message in the message object.
base_object::createPluginObject()
Create plugin object
base_object::debug()
Show the debug of the variable &$var
base_object::encodeQueryString()
Encode query string
base_object::escapeForFilename()
Escape chars in a string to use it in a filename
base_object::getAbsoluteURL()
Return absolute URL
base_object::getBaseLink()
Get base link
base_object::getBasePath()
get base path to current script
base_object::getLink()
Get link
base_object::getSessionValue()
base_object::getWebLink()
Get web link
base_object::getWebMediaLink()
Get web media link
base_object::includePluginFile()
Include plugin file
base_object::initializeParams()
Parameter initialisation
base_object::initializeSessionParam()
Initialisation of session-parameter
base_object::logMsg()
Log events
base_object::parseRequestURI()
Parse request URI to filter data out of it
base_object::setSessionValue()
base_object::stripslashes()
base_object::_gt()
Phrasetranslator - Fetch translation for all phrase
base_object::_gtf()
Phrasetranslator - Fetch translation of one phrase and insert variable
base_object::_gtfile()
Phrases - Locate files

[ Seitenanfang ]
Properties Summary
Class Overview | Ableitungen | Inherited Properties And Methods | Properties Summary | Property Details | Method Summary | Method Details
mixed   $auth_user  
mixed   $dburi  
mixed   $default_username  
mixed   $groups  
mixed   $grouptable  
mixed   $grouptree  
mixed   $images  
mixed   $is_valid  
mixed   $layout  
mixed   $modpermlinktable  
mixed   $modpermtable  
mixed   $msgs  
mixed   $options  
mixed   $optionstable  
mixed   $paramname  
mixed   $params  
mixed   $perms  
mixed   $permtable  
mixed   $sessionparamname  
mixed   $sessionparams  
mixed   $start_node  
mixed   $sub_level  
mixed   $surfertable  
mixed   $user  
mixed   $userlinktable  
mixed   $users  
mixed   $usertable  
mixed   $user_id  
mixed   $user_options  
mixed   $user_perms  

[ Seitenanfang ]
Method Summary
Class Overview | Ableitungen | Inherited Properties And Methods | Properties Summary | Property Details | Method Summary | Method Details
void   addDefaultAdminUser()  
boolean   changeForgottenPassword()   Change forgotten password
mixed   checkChangePasswordId()   Check change password id
boolean   checkDialogInput()   Check dialog input
boolean   checkLoginInput()   Check login input
boolean   checkPerms()   Check permissions
mixed   decodePermStr()   Decode permission string
boolean   execLogin()   Execute Login
void   forgotPassword()   forgot password
void   getLoginXML()   Get login XML
mixed   hasModulePerm()   Has module permission
boolean   hasPerm()   Has permission
boolean   inGroup()   Is in group
void   initialize()   Initialisation of parameters
boolean   isAdmin()   is administrator
boolean   isModulePermActive()   Is module permission active
boolean   load()   Load user data
void   loadGroups()   Load groups
boolean   loadLogin()   Load login data
boolean   loadModulePermLinks()   Load Module permission Links
boolean   loadModulePerms()   Load Module permissions
void   loadOptions()  
array   loadUserPerms()   Load user permissions
boolean   login()   Login function
void   logout()   Logout function
boolean   restoreLogin()   Login aus Sessiondaten wiederherstellen
mixed   saveChangePasswordId()   Save change password id
boolean   saveLoginData()   Save login data
void   setSessionToken()  
mixed   surferExists()   Check Surfer is in database
void   syncronizeSurfer()   syncronize Surfer
mixed   userExists()   Check user is in database

[ Seitenanfang ]
Properties
Class Overview | Ableitungen | Inherited Properties And Methods | Properties Summary | Property Details | Method Summary | Method Details
mixed   $auth_user = NULL [Zeile 61]

[ Seitenanfang ]
mixed   $dburi = PAPAYA_DB_URI [Zeile 28]
Neudefinition von:
base_db::$dburi
Database URI
Neu definiert in folgenden Ableitungen:

[ Seitenanfang ]
mixed   $default_username = new [Zeile 69]

[ Seitenanfang ]
mixed   $groups = NULL [Zeile 55]

[ Seitenanfang ]
mixed   $grouptable = PAPAYA_DB_TBL_AUTHGROUPS [Zeile 30]
Neu definiert in folgenden Ableitungen:

[ Seitenanfang ]
mixed   $grouptree = NULL [Zeile 57]

[ Seitenanfang ]
mixed   $images = NULL [Zeile 60]

[ Seitenanfang ]
mixed   $is_valid = false [Zeile 52]

[ Seitenanfang ]
mixed   $layout = NULL [Zeile 59]

[ Seitenanfang ]
mixed   $modpermlinktable = PAPAYA_DB_TBL_AUTHMODPERMLINKS [Zeile 37]

[ Seitenanfang ]
mixed   $modpermtable = PAPAYA_DB_TBL_AUTHMODPERMS [Zeile 36]

[ Seitenanfang ]
mixed   $msgs = NULL [Zeile 62]
Neudefinition von:
base_db::$msgs
Message for user

[ Seitenanfang ]
mixed   $options = array() [Zeile 67]

[ Seitenanfang ]
mixed   $optionstable = PAPAYA_DB_TBL_AUTHOPTIONS [Zeile 32]
Neu definiert in folgenden Ableitungen:

[ Seitenanfang ]
mixed   $paramname = usr [Zeile 41]

[ Seitenanfang ]
mixed   $params = NULL [Zeile 42]

[ Seitenanfang ]
mixed   $perms = NULL [Zeile 56]

[ Seitenanfang ]
mixed   $permtable = PAPAYA_DB_TBL_AUTHPERM [Zeile 34]
Neu definiert in folgenden Ableitungen:

[ Seitenanfang ]
mixed   $sessionparamname = PAPAYA_SESS_usr [Zeile 43]

[ Seitenanfang ]
mixed   $sessionparams = NULL [Zeile 44]

[ Seitenanfang ]
mixed   $start_node [Zeile 49]

[ Seitenanfang ]
mixed   $sub_level [Zeile 50]

[ Seitenanfang ]
mixed   $surfertable = PAPAYA_DB_TBL_SURFER [Zeile 39]

[ Seitenanfang ]
mixed   $user = NULL [Zeile 46]

[ Seitenanfang ]
mixed   $userlinktable = PAPAYA_DB_TBL_AUTHLINK [Zeile 31]
Neu definiert in folgenden Ableitungen:

[ Seitenanfang ]
mixed   $users = NULL [Zeile 54]

[ Seitenanfang ]
mixed   $usertable = PAPAYA_DB_TBL_AUTHUSER [Zeile 29]
Neu definiert in folgenden Ableitungen:

[ Seitenanfang ]
mixed   $user_id [Zeile 47]

[ Seitenanfang ]
mixed   $user_options = array('PAPAYA_UI_LANGUAGE', 'PAPAYA_UI_THEME', 'PAPAYA_USE_FLASHCONTROLS', 'PAPAYA_USE_RICHTEXT') [Zeile 64]

[ Seitenanfang ]
mixed   $user_perms = NULL [Zeile 48]

[ Seitenanfang ]
Methods
Class Overview | Ableitungen | Inherited Properties And Methods | Properties Summary | Property Details Method Summary | Method Details
addDefaultAdminUser  [Zeile 692]

  void addDefaultAdminUser( )



[ Seitenanfang ]
changeForgottenPassword  [Zeile 906]

  boolean changeForgottenPassword( integer $user_id  )

Change forgotten password

Parameters:
integer   $user_id: 

API Tags:
Access:  public


[ Seitenanfang ]
checkChangePasswordId  [Zeile 661]

  mixed checkChangePasswordId( string $chg_id  )

Check change password id

Parameters:
string   $chg_id: 

API Tags:
Return:  user id or false
Access:  public


[ Seitenanfang ]
checkDialogInput  [Zeile 769]

  boolean checkDialogInput( array $fields  )

Check dialog input

Parameters:
array   $fields: 

API Tags:
Access:  public


[ Seitenanfang ]
checkLoginInput  [Zeile 740]

  boolean checkLoginInput( [boolean $setpass = false]  )

Check login input

Parameters:
boolean   $setpass:  optional, default value false

API Tags:
Access:  public


[ Seitenanfang ]
checkPerms  [Zeile 466]

  boolean checkPerms( )

Check permissions


API Tags:
Access:  public


[ Seitenanfang ]
decodePermStr  [Zeile 684]

  mixed decodePermStr( string $str  )

Decode permission string

Parameters:
string   $str: 

API Tags:
Access:  public


[ Seitenanfang ]
execLogin  [Zeile 91]

  boolean execLogin( )

Execute Login


API Tags:
Return:  Login successful
Access:  public


[ Seitenanfang ]
forgotPassword  [Zeile 835]

  void forgotPassword( )

forgot password


API Tags:
Access:  public


[ Seitenanfang ]
getLoginXML  [Zeile 804]

  void getLoginXML( )

Get login XML


API Tags:
Access:  public


[ Seitenanfang ]
hasModulePerm  [Zeile 949]

  mixed hasModulePerm( integer $perm_id, integer $module_id  )

Has module permission

Parameters:
integer   $perm_id: 
integer   $module_id: 

API Tags:
Access:  public


[ Seitenanfang ]
hasPerm  [Zeile 976]

  boolean hasPerm( integer $perm_id, [mixed $module_id = NULL]  )

Has permission

Parameters:
integer   $perm_id: 
mixed   $module_id:  optional, default value NULL

API Tags:
Access:  public


[ Seitenanfang ]
inGroup  [Zeile 994]

  boolean inGroup( integer $group_id  )

Is in group

Parameters:
integer   $group_id: 

API Tags:
Access:  public


[ Seitenanfang ]
initialize  [Zeile 77]

  void initialize( [string $paramname = 'usr']  )

Initialisation of parameters

Parameters:
string   $paramname:  optional, default value 'usr'

API Tags:
Access:  public


[ Seitenanfang ]
isAdmin  [Zeile 1010]

  boolean isAdmin( )

is administrator


API Tags:
Access:  public


[ Seitenanfang ]
isModulePermActive  [Zeile 964]

  boolean isModulePermActive( integer $perm_id, integer $mod_id  )

Is module permission active

Parameters:
integer   $perm_id: 
integer   $mod_id: 

API Tags:
Access:  public


[ Seitenanfang ]
load  [Zeile 212]

  boolean load( integer $uid, [boolean $login = false]  )

Load user data

Parameters:
integer   $uid: 
boolean   $login: 

API Tags:
Return:  loading successful


[ Seitenanfang ]
loadGroups  [Zeile 353]

  void loadGroups( [array $group_ids = NULL]  )

Load groups

Parameters:
array   $group_ids:  optional, default value NULL

API Tags:
Access:  public


[ Seitenanfang ]
loadLogin  [Zeile 172]

  boolean loadLogin( string $username, string $password  )

Load login data

Parameters:
string   $username: 
string   $password: 

API Tags:
Return:  user valid?


[ Seitenanfang ]
loadModulePermLinks  [Zeile 421]

  boolean loadModulePermLinks( integer $group_id, integer $user_id, [integer $module_id = NULL]  )

Load Module permission Links

Parameters:
integer   $group_id:  optional, default value undefined
integer   $user_id:  optional, default value undefined
integer   $module_id:  optional, default value NULL


[ Seitenanfang ]
loadModulePerms  [Zeile 391]

  boolean loadModulePerms( [integer $module_id = NULL]  )

Load Module permissions

Parameters:
integer   $module_id:  optional, default value NULL


[ Seitenanfang ]
loadOptions  [Zeile 238]

  void loadOptions( )



[ Seitenanfang ]
loadUserPerms  [Zeile 268]

  array loadUserPerms( [boolean $login = false]  )

Load user permissions

Parameters:
boolean   $login:  optional, default value false

API Tags:
Return:  permissions
Access:  public


[ Seitenanfang ]
login  [Zeile 128]

  boolean login( )

Login function


API Tags:
Access:  public


[ Seitenanfang ]
logout  [Zeile 158]

  void logout( )

Logout function


API Tags:
Access:  public


[ Seitenanfang ]
restoreLogin  [Zeile 199]

  boolean restoreLogin( )

Login aus Sessiondaten wiederherstellen


API Tags:
Return:  Login restore successful
Access:  public


[ Seitenanfang ]
saveChangePasswordId  [Zeile 642]

  mixed saveChangePasswordId( integer $user_id, integer $chg_id  )

Save change password id

Parameters:
integer   $user_id: 
integer   $chg_id: 

API Tags:
Return:  user id or false
Access:  public


[ Seitenanfang ]
saveLoginData  [Zeile 573]

  boolean saveLoginData( integer $user_id  )

Save login data

Parameters:
integer   $user_id: 

API Tags:
Access:  public


[ Seitenanfang ]
setSessionToken  [Zeile 148]

  void setSessionToken( mixed $userguid  )



[ Seitenanfang ]
surferExists  [Zeile 552]

  mixed surferExists( integer $surfername  )

Check Surfer is in database

Parameters:
integer   $surfername: 

API Tags:
Return:  surfer id or false
Access:  public


[ Seitenanfang ]
syncronizeSurfer  [Zeile 501]

  void syncronizeSurfer( integer $user_id  )

syncronize Surfer

Parameters:
integer   $user_id: 

API Tags:
Access:  public


[ Seitenanfang ]
userExists  [Zeile 531]

  mixed userExists( string $username  )

Check user is in database

Parameters:
string   $username: 

API Tags:
Return:  valid user id or false
Access:  public


[ Seitenanfang ]