Arbit - project tracking, tracked with Arbit

API documentation :: Docs For Class arbitCouchDbUserFacade

LICENSE

INSTALL

Packages:

Interfaces:

Facade
- arbitFacadeProjectManager
- arbitGroupFacade
- arbitProjectFacade
- arbitUserFacade

Classes:

View
- arbitCachingTranslationContext
- arbitCoreConfirmedUserViewStruct
- arbitCoreDashboardInfoViewStruct
- arbitCoreLoginUserViewStruct
- arbitCoreLogoutUserViewStruct
- arbitCoreNewGroupViewStruct
- arbitCoreNewUserViewStruct
- arbitCoreProjectComponentsUpdateViewStruct
- arbitCoreProjectVersionsUpdateViewStruct
- arbitDummyTranslationContext
- arbitModuleTrackerRssHandler
- arbitSignalSlotViewStruct
- arbitTemplateRecursiveIteratorIterator
- arbitTemplateViewHandler
- arbitTranslationManager
- arbitViewCliContextModel
- arbitViewCoreAboutModel
- arbitViewCoreCacheListModel
- arbitViewCoreDummyModel
- arbitViewCoreModel
- arbitViewCorePermissionsModel
- arbitViewCoreProjectModel
- arbitViewCoreUserAcceptModel
- arbitViewCoreUserAccountModel
- arbitViewCoreUserLoginModel
- arbitViewCoreUserModel
- arbitViewCoreUserRegisteredModel
- arbitViewCoreUserRegistrationModel
- arbitViewDashboardContextModel
- arbitViewDashboardProjectModel
- arbitViewDataModel
- arbitViewDecorationFailedException
- arbitViewEmailHandler
- arbitViewErrorContextModel
- arbitViewErrorNotFoundContextModel
- arbitViewException
- arbitViewGroupModel
- arbitViewHandler
- arbitViewHttpBinaryHandler
- arbitViewJsonHandler
- arbitViewManager
- arbitViewModel
- arbitViewModelDecorationDependencyInjectionManager
- arbitViewModuleModel
- arbitViewNoDecoratorsExceptions
- arbitViewProjectConfigurationModel
- arbitViewProjectContextModel
- arbitViewProjectModel
- arbitViewRssHandler
- arbitViewSearchResultDocumentModel
- arbitViewSearchResultModel
- arbitViewTemplateFunctions
- arbitViewTextHandler
- arbitViewTextTemplateFunctions
- arbitViewUserMessageModel
- arbitViewUserModel
- arbitViewUserSuccessModel
- arbitViewXHtmlHandler
- arbitViewXHtmlTemplateFunctions
- arbitViewXmlHandler

Model
- arbitModelArrayValidator
- arbitModelBase
- arbitModelDummyValidator
- arbitModelException
- arbitModelGroup
- arbitModelIntegerValidator
- arbitModelObjectValidator
- arbitModelProject
- arbitModelSetValidator
- arbitModelStringValidator
- arbitModelUser
- arbitModelValidatorBase
- arbitModelVersionNotFoundException

IniBackend
- arbitBackendIniConfigurationBase
- arbitBackendIniConfigurationManager
- arbitBackendIniException
- arbitBackendIniMainConfiguration
- arbitBackendIniModuleConfiguration
- arbitBackendIniProjectConfiguration
- arbitBackendNoSuchModuleException
- arbitBackendNoSuchProjectException
- arbitBackendUnknownConfigurationException

Facade
- arbitCouchDbFacadeBase
- arbitCouchDbFacadeProjectManager
- arbitCouchDbGroupFacade
- arbitCouchDbProjectFacade
- arbitCouchDbUserFacade
- arbitFacadeException
- arbitFacadeExistsException
- arbitFacadeGroupExistsException
- arbitFacadeManager
- arbitFacadeNotFoundException
- arbitFacadeProjectExistsException
- arbitFacadeUnknownClassException
- arbitFacadeUnknownProjectException
- arbitFacadeUserExistsException
- arbitModelNotPersistentException

Module
- arbitModuleDefinitionLocator
- arbitModuleDefinitionNotFoundException
- arbitModuleException
- arbitModuleFileNotFoundException
- arbitModuleManager
- arbitUnknownModuleException

CouchDbBackend
- arbitBackendCouchDbGroupView
- arbitBackendCouchDbUserView

Core::Facade::arbitCouchDbUserFacade

Class arbitCouchDbUserFacade

User facade defining all methods required to access user related data in the backend.

Implements interfaces:

arbitUserFacade

arbitCouchDbFacadeBase
   |
   --arbitCouchDbUserFacade

Author(s):

Version:	$Revision: 1682 $
License:	GPL

Inherited Member Variables

From arbitCouchDbFacadeBase
protected	`arbitCouchDbFacadeBase::$connected`
protected	`arbitCouchDbFacadeBase::$manager`

Method Summary

public void	`createUser( $name )` Create a new user Create a new user with the given name. there already is a user with the given name.
public array	`getAllUserIDs( )` Get array of users Return an array with the IDs of all available users in the database.
public array	`getUserData( $user )` Get user data
public array	`getUserDataByLogin( $login )` Get user by login Get the user id for the user given by its login name.
public void	`updateUserData( $user , $data )` Update stored information for the given user The array with the information to update may any number of the common keys, and only the given keys will be updated in the storage backend.

Inherited Methods

From arbitCouchDbFacadeBase
public void	`arbitCouchDbFacadeBase::__construct()` Constructor The constructor ensures the correct configuration for the conenction by connecting on the first request to on of the facde classes.

Methods

createUser

void createUser( string $name )

Create a new user Create a new user with the given name. there already is a user with the given name.

Create a new user Create a new user with the given name. An exception will be thrown if there already is a user with the given name.

Parameters:

Name	Type	Description
`$name`	string

Implementation of:

Method	Description
`arbitUserFacade::createUser()`	Create a new user Create a new user with the given name. there already is a user with the given name.

getAllUserIDs

array getAllUserIDs( )

Get array of users Return an array with the IDs of all available users in the database.

Implementation of:

Method	Description
`arbitUserFacade::getAllUserIDs()`	Get array of users Return an array with the IDs of all available users in the database.

getUserData

array getUserData( string $user )

Get user data

Get user data Get data for the given user id. The data should be returned as an array, and should contain the following keys:

login
email
name
valid
auth_type
auth_infos
settings
persistenceToken
revisions

Parameters:

Name	Type	Description
`$user`	string

Implementation of:

Method	Description
`arbitUserFacade::getUserData()`	Get user data

getUserDataByLogin

array getUserDataByLogin( string $login )

Get user by login Get the user id for the user given by its login name.

Parameters:

Name	Type	Description
`$login`	string

Implementation of:

Method	Description
`arbitUserFacade::getUserDataByLogin()`	Get user by login Get the user id for the user given by its login name.

updateUserData

void updateUserData( string $user , array $data )

Update stored information for the given user The array with the information to update may any number of the common keys, and only the given keys will be updated in the storage backend.

Parameters:

Name	Type	Description
`$user`	string
`$data`	array

Implementation of:

Method	Description
`arbitUserFacade::updateUserData()`	Update stored information for the given user The array with the information to update may any number of the common keys, and only the given keys will be updated in the storage backend.

Documentation generated on Mon, 05 Apr 2010 14:02:21 +0200 by phpDocumentor 1.4.3