| core_auth

# Class: Bs_Group Source Location: /core/auth/Bs_Group.class.php
### Class Overview
    Bs_Object
       |
       --Bs_MagicClass
          |
          --Bs_Group
Group 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:36 $ #### Copyright: blueshoes.org | ### Variables $groupName $_groups $_users | ### Methods Bs_Group addUser getUser hasUserById hasUserByUsername loadFormHints loadPersistHints removeUser
### Inherited Variables #### Class: Bs_MagicClass Bs_MagicClass::$formFields Bs_MagicClass::$formFieldsUsed 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 23] Group 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:36 $
copyright: | blueshoes.org
author: | andrej arn <at blueshoes dot org>
[ Top ] ### Class Variables #### $groupName = [line 29]
Type: | mixed
[ Top ] #### $_groups = [line 40]
Type: | mixed
[ Top ] #### $_users = [line 39] $users = array( 'id' => obj, )
Type: | mixed
[ Top ] ### Class Methods ### constructor Bs_Group [line 49]
`Bs_Group Bs_Group( [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 addUser [line 205]
`void addUser( mixed $userObj)`
#### Tags:
access: | public
[ Top ] ### method getUser [line 199]
`object (instance getUser( string $user)`
returns the user object for the user specified. #### Tags:
return: | of Bs_User)
access: | public
#### Parameters:
string | $user |
[ Top ] ### method hasUserById [line 174]
`bool hasUserById( mixed $id)`
#### Tags:
access: | public
#### Parameters:
mixed | $id |
[ Top ] ### method hasUserByUsername [line 189]
`bool hasUserByUsername( string $user, [bool $ignoreCase = TRUE])`
tells if there is a user with the given username. example: $group->hasUserByUsername('TOM'); will return TRUE even if there is "only" a user 'tom'. #### Tags:
access: | public
#### Parameters:
string | $user |
bool | $ignoreCase | (default is TRUE)
[ Top ] ### method loadFormHints [line 80]
`void loadFormHints( )`
Overrides Bs_MagicClass::loadFormHints() (parent method not documented) [ Top ] ### method loadPersistHints [line 57]
`void loadPersistHints( )`
Overrides Bs_MagicClass::loadPersistHints() (parent method not documented) [ Top ] ### method removeUser [line 211]
`void removeUser( mixed $username)`
#### Tags:
access: | public
[ Top ] Documentation generated on Mon, 29 Dec 2003 21:10:46 +0100 by phpDocumentor 1.2.3