PHP Class Horde_Kolab_Storage_List_Query_Acl_Base, horde

Copyright 2011-2016 Horde LLC (http://www.horde.org/) See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.
Inheritance: extends Horde_Kolab_Storage_List_Query_Acl
Datei anzeigen Open project: horde/horde

Public Methods

Method Description
__construct ( Horde_Kolab_Storage_Driver $driver ) Constructor.
deleteAcl ( string $folder, string $user ) : null Delete the access rights for user on a folder.
getAcl ( string $folder ) : array Retrieve the access rights for a folder. This method will use two calls to the backend. It will first get the individual user rights via getMyRights and will subsequently fetch all ACL if the user has admin rights on a folder. If you already know the user has admin rights on a folder it makes more sense to call getAllAcl() directly.
getAllAcl ( string $folder ) : string Retrieve the all access rights on a folder.
getMyAcl ( string $folder ) : string Retrieve the access rights the current user has on a folder.
hasAclSupport ( ) : boolean Does the backend support ACL?
setAcl ( string $folder, string $user, string $acl ) : null Set the access rights for a folder.

Private Methods

Method Description
_failOnMissingAcl ( )

Method Details

__construct() public method

Constructor.
public __construct ( Horde_Kolab_Storage_Driver $driver )
$driver Horde_Kolab_Storage_Driver The driver to access the backend.

deleteAcl() public method

Delete the access rights for user on a folder.
public deleteAcl ( string $folder, string $user ) : null
$folder string The folder to act upon.
$user string The user to delete the ACL for
return null

getAcl() public method

Retrieve the access rights for a folder. This method will use two calls to the backend. It will first get the individual user rights via getMyRights and will subsequently fetch all ACL if the user has admin rights on a folder. If you already know the user has admin rights on a folder it makes more sense to call getAllAcl() directly.
public getAcl ( string $folder ) : array
$folder string The folder to retrieve the ACL for.
return array An array of rights.

getAllAcl() public method

Retrieve the all access rights on a folder.
public getAllAcl ( string $folder ) : string
$folder string The folder to retrieve the ACL for.
return string The folder rights.

getMyAcl() public method

Retrieve the access rights the current user has on a folder.
public getMyAcl ( string $folder ) : string
$folder string The folder to retrieve the user ACL for.
return string The user rights.

hasAclSupport() public method

Does the backend support ACL?
public hasAclSupport ( ) : boolean
return boolean True if the backend supports ACLs.

setAcl() public method

Set the access rights for a folder.
public setAcl ( string $folder, string $user, string $acl ) : null
$folder string The folder to act upon.
$user string The user to set the ACL for.
$acl string The ACL.
return null