| core_auth

# Class: Bs_User Source Location: /core/auth/Bs_User.class.php
### Class Overview
    Bs_Object
       |
       --Bs_MagicClass
          |
          --Bs_User
User Class for the User Management. EXPERIMENTAL! #### Author(s): andrej arn <at blueshoes dot org> #### Version: 4.3.$Revision: 1.3 $ $Date: 2003/10/29 17:48:37 $ #### Copyright: blueshoes.org | ### Variables $email $endDatetime $formFieldsUsed $isActive $pass $startDatetime $storageFieldsUsed $user | ### Methods Bs_User loadFormHints loadPersistHints validateLogin
### Inherited Variables #### Class: Bs_MagicClass Bs_MagicClass::$formFields Bs_MagicClass::$formGroups Bs_MagicClass::$formProps Bs_MagicClass::$persistFields Bs_MagicClass::$persistFieldsUsed Bs_MagicClass::$persistPrimary Bs_MagicClass::$uniqueKey | ### Inherited Methods #### Class: Bs_MagicClass Bs_MagicClass::Bs_MagicClass() constructor Bs_MagicClass::activateField() activates a predefined field that is not activated by default. Bs_MagicClass::addField() adds (and activates) the given field. Bs_MagicClass::bs_fia_getHints() Bs_MagicClass::bs_sop_getHints() Bs_MagicClass::loadFormHints() Bs_MagicClass::loadPersistHints() Bs_MagicClass::removeField() deactivates an active field. #### Class: Bs_Object Bs_Object::Bs_Object() Bs_Object::getErrors() Basic error handling: Get *all* errors as string array from the global Bs_Error-error stack. Bs_Object::getLastError() Basic error handling: Get last error string from the global Bs_Error-error stack. Bs_Object::getLastErrors() Basic error handling: Get last errors string array from the global Bs_Error-error stack sinc last call of getLastErrors(). Bs_Object::persist() Persists this object by serializing it and saving it to a file with unique name. Bs_Object::setError() Basic error handling: Push an error string on the global Bs_Error-error stack. Bs_Object::toHtml() Dumps the content of this object to a string using PHP's var_dump(). Bs_Object::toString() Dumps the content of this object to a string using PHP's var_dump(). Bs_Object::unpersist() Fetches an object that was persisted with persist()
### Class Details [line 24] User Class for the User Management. EXPERIMENTAL! dependencies: #### Tags:
pattern: | singleton: (pseudostatic)
status: | experimental
access: | public
version: | 4.3.$Revision: 1.3 $ $Date: 2003/10/29 17:48:37 $
copyright: | blueshoes.org
author: | andrej arn <at blueshoes dot org>
[ Top ] ### Class Variables #### $email = '' [line 86] the email address. #### Tags:
access: | public
Type: | string
[ Top ] #### $endDatetime = '' [line 79] when the account expires, empty = no expiration = never. format: "yyyy-mm-dd hh:mm:ss" like in mysql. #### Tags:
access: | public
Type: | string
[ Top ] #### $formFieldsUsed = array('user'=>TRUE, 'pass'=>TRUE, 'isActive'=>TRUE, 'startDatetime'=>TRUE, 'endDatetime'=>TRUE) [line 33] specifies the form fields that are in use. #### Tags:
see: | $this->addField() and many more.
access: | public
Type: | array
Overrides: | Array
[ Top ] #### $isActive = FALSE [line 63] if the account is active or not. default is false to be dummy-compatible. #### Tags:
access: | public
Type: | bool
[ Top ] #### $pass = '' [line 56] the password. #### Tags:
access: | public
Type: | string
[ Top ] #### $startDatetime = '' [line 71] when the account gets active, empty = no activation = immediatly. format: "yyyy-mm-dd hh:mm:ss" like in mysql. #### Tags:
access: | public
Type: | string
[ Top ] #### $storageFieldsUsed = array('user'=>TRUE, 'pass'=>TRUE, 'isActive'=>TRUE, 'startDatetime'=>TRUE, 'endDatetime'=>TRUE) [line 42] specifies the storage fields that are in use. #### Tags:
see: | $this->addField() and many more.
access: | public
Type: | array
[ Top ] #### $user = '' [line 49] the username. #### Tags:
access: | public
Type: | string
[ Top ] ### Class Methods ### constructor Bs_User [line 95]
`Bs_User Bs_User( [bool $loadPersistHints = TRUE], [bool $loadFormHints = FALSE])`
constructor #### Tags:
see: | $this->loadPersistHints(), $this->loadFormHints()
#### Parameters:
bool | $loadPersistHints | (default is TRUE)
bool | $loadFormHints | (default is FALSE)
[ Top ] ### method loadFormHints [line 129]
`void loadFormHints( )`
Overrides Bs_MagicClass::loadFormHints() (parent method not documented) [ Top ] ### method loadPersistHints [line 103]
`void loadPersistHints( )`
Overrides Bs_MagicClass::loadPersistHints() (parent method not documented) [ Top ] ### method validateLogin [line 246]
`void validateLogin( string $user, string $pass)`
validates the given username and password. also takes isActive, startDatetime and endDatetime into account, if set. #### Tags:
todo: | check Bs_Cug->_validateLoginData(), not sure where to implement this functionality.
#### Parameters:
string | $user |
string | $pass |
[ Top ] Documentation generated on Mon, 29 Dec 2003 21:13:19 +0100 by phpDocumentor 1.2.3