Arbit - project tracking, tracked with Arbit

API documentation :: Docs For Class arbitCouchDbGroupFacade

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::arbitCouchDbGroupFacade

Class arbitCouchDbGroupFacade

Group facade defining all methods required to access group related data in the backend.

Implements interfaces:

arbitGroupFacade

arbitCouchDbFacadeBase
   |
   --arbitCouchDbGroupFacade

Author(s):

Version:	$Revision: 1546 $
License:	GPL

Inherited Member Variables

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

Method Summary

public void	`createGroup( $name )` Create a new group Create a new group with the given name. there already is a group with the given name.
public array	`getAllGroupIDs( )` Get array of groups Return an array with the IDs of all available groups in the database.
public array	`getGroupData( $group )` Get group data Get data for the given group name. array, and should contain the following keys: name description users permissions Where users and permissions are arrays containg the list of users (their login names) repectively the permission string keys.
public array	`getPrivilegesForUser( $user )` Get privileges for user Get the privileges for a user, given the users ID, as an array of strings defining the privileges the user has.
public void	`updateGroupData( $group , $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

createGroup

void createGroup( string $name )

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

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

Parameters:

Name	Type	Description
`$name`	string

Implementation of:

Method	Description
`arbitGroupFacade::createGroup()`	Create a new group Create a new group with the given name. there already is a group with the given name.

getAllGroupIDs

array getAllGroupIDs( )

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

Implementation of:

Method	Description
`arbitGroupFacade::getAllGroupIDs()`	Get array of groups Return an array with the IDs of all available groups in the database.

getGroupData

array getGroupData( string $group )

Get group data Get data for the given group name. array, and should contain the following keys:

name
description
users
permissions

Where users and permissions are arrays containg the list of users (their login names) repectively the permission string keys.

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

name
description
users
permissions

Where users and permissions are arrays containg the list of users (their login names) repectively the permission string keys.

Parameters:

Name	Type	Description
`$group`	string

Implementation of:

Method	Description
`arbitGroupFacade::getGroupData()`	Get group data Get data for the given group name. array, and should contain the following keys: name description users permissions Where users and permissions are arrays containg the list of users (their login names) repectively the permission string keys.

getPrivilegesForUser

array getPrivilegesForUser( string $user )

Get privileges for user Get the privileges for a user, given the users ID, as an array of strings defining the privileges the user has.

Parameters:

Name	Type	Description
`$user`	string

Implementation of:

Method	Description
`arbitGroupFacade::getPrivilegesForUser()`	Get privileges for user Get the privileges for a user, given the users ID, as an array of strings defining the privileges the user has.

updateGroupData

void updateGroupData( string $group , 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
`$group`	string
`$data`	array

Implementation of:

Method	Description
`arbitGroupFacade::updateGroupData()`	Update stored information for the given group 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:01:57 +0200 by phpDocumentor 1.4.3