Class: base_surfer

Quellcode Position: Program_Root/base_surfer.php

Class base_surfer

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

Surfer object for load and check users

Implementiert in Program_Root/base_surfer.php [Zeile 25] 

base_object
   |
   --base_db
      |
      --base_surfer
Author(s): Information Tags:

Properties

Methods
[ Seitenanfang ]
Inherited Properties And Methods
Class Overview | 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
base_db::$msgs

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 | Inherited Properties And Methods | Properties Summary | Property Details | Method Summary | Method Details
mixed   $dburi  
array   $errs   Errors
string   $grouptable   Table name group
boolean   $is_valid   Valid surfer
string   $linktable   Link table name surfer<->right
string   $logform_var   Param name for login form fields
boolean   $md5hash   Use encoding ?
string   $permtable   Table name rights
string   $surfername_var   Session variable name for surfer handle
string   $surferobj_var   Name of the global surfer object
string   $surfertable   Table name surfer
string   $surfer_email   Surfer email
string   $surfer_handle   Visitor name
int   $surfer_id   Surfer id
boolean   $surfer_valid   Active
boolean   $temp_topicrights   Temporary
array   $topiclist   Surfer acessible topics
string   $topiclist_var   Session variable name for topics that the surfer can see
boolean   $topicrights   Topic rights
string   $topictable   Table name topic

[ Seitenanfang ]
Method Summary
Class Overview | Inherited Properties And Methods | Properties Summary | Property Details | Method Summary | Method Details
base_surfer   base_surfer()   Constructor base surfer
void   can_view()   Test if surfer can enter a given topic
mixed   checkChangePasswordId()   Check change password id
mixed   checkUserByData()   Check user by data
string   getFormXML()   Get formular XML
mixed   getNodeRights()   Get node rights
string   getPassFormXML()   Get password formular XML
string   getPasswordRequestForm()   Get password request formular
array   get_viewable()   Get viewable
mixed   hasOnPermOf()   Has on permissions of
boolean   hasPerm()   Has permission ?
boolean   load()   Load function
boolean   loadPermissionList()   Load permission list
void   load_topiclist()   Load list of all accessible sites
boolean   login()   Login attempt
void   logLoginTime()  
void   logout()   Surfer logout, clean up variable
mixed   permStr2Array()   Permission string to array
boolean   requestPasswordChange()   Request password change
boolean   saveChangePasswordId()   Save change password id

[ Seitenanfang ]
Properties
Class Overview | Inherited Properties And Methods | Properties Summary | Property Details | Method Summary | Method Details
mixed   $dburi = PAPAYA_DB_URI [Zeile 27]
Neudefinition von:
base_db::$dburi
Database URI

[ Seitenanfang ]
array   $errs [Zeile 146]

Errors


[ Seitenanfang ]
string   $grouptable = PAPAYA_DB_TBL_SURFERGROUPS [Zeile 39]

Table name group


[ Seitenanfang ]
boolean   $is_valid = false [Zeile 102]

Valid surfer

API Tags:
Access:  public


[ Seitenanfang ]
string   $linktable = PAPAYA_DB_TBL_SURFERPERMLINK [Zeile 51]

Link table name surfer<->right


[ Seitenanfang ]
string   $logform_var = surf [Zeile 81]

Param name for login form fields


[ Seitenanfang ]
boolean   $md5hash = false [Zeile 95]

Use encoding ?

API Tags:
Access:  public


[ Seitenanfang ]
string   $permtable = PAPAYA_DB_TBL_SURFERPERM [Zeile 45]

Table name rights


[ Seitenanfang ]
string   $surfername_var = papaya_surfer_handle [Zeile 63]

Session variable name for surfer handle


[ Seitenanfang ]
string   $surferobj_var = surfer [Zeile 69]

Name of the global surfer object


[ Seitenanfang ]
string   $surfertable = PAPAYA_DB_TBL_SURFER [Zeile 33]

Table name surfer


[ Seitenanfang ]
string   $surfer_email [Zeile 123]

Surfer email

API Tags:
Access:  public


[ Seitenanfang ]
string   $surfer_handle [Zeile 88]

Visitor name

API Tags:
Access:  public


[ Seitenanfang ]
int   $surfer_id [Zeile 116]

Surfer id

API Tags:
Access:  public


[ Seitenanfang ]
boolean   $surfer_valid = false [Zeile 109]

Active

API Tags:
Access:  public


[ Seitenanfang ]
boolean   $temp_topicrights = false [Zeile 140]

Temporary


[ Seitenanfang ]
array   $topiclist = false [Zeile 130]

Surfer acessible topics

API Tags:
Access:  public


[ Seitenanfang ]
string   $topiclist_var = surfer_topics [Zeile 75]

Session variable name for topics that the surfer can see


[ Seitenanfang ]
boolean   $topicrights = false [Zeile 135]

Topic rights


[ Seitenanfang ]
string   $topictable = PAPAYA_DB_TBL_TOPICS [Zeile 57]

Table name topic


[ Seitenanfang ]
Methods
Class Overview | Inherited Properties And Methods | Properties Summary | Property Details Method Summary | Method Details
Constructor base_surfer  [Zeile 155]

  base_surfer base_surfer( [boolean $login = true], string $surferhandle  )

Constructor base surfer

Parameters:
boolean   $login:  optional, default value true
string   $surferhandle:  optional, default value ""

API Tags:
Access:  public


[ Seitenanfang ]
can_view  [Zeile 518]

  void can_view( integer $topic_id  )

Test if surfer can enter a given topic

Parameters:
integer   $topic_id: 

API Tags:
Access:  public


[ Seitenanfang ]
checkChangePasswordId  [Zeile 443]

  mixed checkChangePasswordId( integer $chg_id  )

Check change password id

Parameters:
integer   $chg_id: 

API Tags:
Access:  public


[ Seitenanfang ]
checkUserByData  [Zeile 345]

  mixed checkUserByData( string $username, string $useremail  )

Check user by data

Parameters:
string   $username: 
string   $useremail: 

API Tags:
Access:  public


[ Seitenanfang ]
getFormXML  [Zeile 560]

  string getFormXML( [boolean $login = true]  )

Get formular XML

Parameters:
boolean   $login:  optional, default value true

API Tags:
Access:  public


[ Seitenanfang ]
getNodeRights  [Zeile 466]

  mixed getNodeRights( integer $id  )

Get node rights

Parameters:
integer   $id: 

API Tags:
Return:  array or boolean
Access:  public


[ Seitenanfang ]
getPassFormXML  [Zeile 595]

  string getPassFormXML( string $token  )

Get password formular XML

Parameters:
string   $token: 

API Tags:
Access:  public


[ Seitenanfang ]
getPasswordRequestForm  [Zeile 400]

  string getPasswordRequestForm( )

Get password request formular


API Tags:
Access:  public


[ Seitenanfang ]
get_viewable  [Zeile 529]

  array get_viewable( )

Get viewable


API Tags:
Access:  public


[ Seitenanfang ]
hasOnPermOf  [Zeile 624]

  mixed hasOnPermOf( integer $perm_ids  )

Has on permissions of

Parameters:
integer   $perm_ids: 

API Tags:
Access:  public


[ Seitenanfang ]
hasPerm  [Zeile 613]

  boolean hasPerm( integer $perm_id  )

Has permission ?

Parameters:
integer   $perm_id: 

API Tags:
Access:  public


[ Seitenanfang ]
load  [Zeile 186]

  boolean load( string $surfername, [boolean $login = false], string $password  )

Load function

Parameters:
string   $surfername: 
boolean   $login:  optional, default value false
string   $password:  optional, default value ""

API Tags:
Access:  public


[ Seitenanfang ]
loadPermissionList  [Zeile 317]

  boolean loadPermissionList( [boolean $force_reload = false]  )

Load permission list

Parameters:
boolean   $force_reload:  optional, default value false

API Tags:
Access:  public


[ Seitenanfang ]
load_topiclist  [Zeile 251]

  void load_topiclist( [mixed $default = FALSE]  )

Load list of all accessible sites



[ Seitenanfang ]
login  [Zeile 243]

  boolean login( mixed $surfername, string $password, string $username  )

Login attempt

Parameters:
string   $username: 
string   $password: 

API Tags:
Return:  login valid?


[ Seitenanfang ]
logLoginTime  [Zeile 428]

  void logLoginTime( )



[ Seitenanfang ]
logout  [Zeile 537]

  void logout( )

Surfer logout, clean up variable


API Tags:
Access:  public


[ Seitenanfang ]
permStr2Array  [Zeile 504]

  mixed permStr2Array( string $permstr  )

Permission string to array

Parameters:
string   $permstr: 

API Tags:
Access:  public


[ Seitenanfang ]
requestPasswordChange  [Zeile 364]

  boolean requestPasswordChange( )

Request password change


API Tags:
Access:  public


[ Seitenanfang ]
saveChangePasswordId  [Zeile 419]

  boolean saveChangePasswordId( string $username, integer $chg_id  )

Save change password id

Parameters:
string   $username: 
integer   $chg_id: 

API Tags:
Access:  public


[ Seitenanfang ]