Horde_Kolab_Storage_List_Query_Acl_Base
extends Horde_Kolab_Storage_List_Query_Acl
in package
Handles a list of folder acls.
Copyright 2011-2017 Horde LLC (http://www.horde.org/)
See the enclosed file LICENSE for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.
Tags
Table of Contents
- $_driver : Horde_Kolab_Storage_Driver
- The driver for accessing the Kolab storage system.
- __construct() : mixed
- Constructor.
- deleteAcl() : null
- Delete the access rights for user on a folder.
- getAcl() : array<string|int, mixed>
- 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
- Retrieve the all access rights on a folder.
- getMyAcl() : string
- Retrieve the access rights the current user has on a folder.
- hasAclSupport() : bool
- Does the backend support ACL?
- setAcl() : null
- Set the access rights for a folder.
- _failOnMissingAcl() : mixed
Properties
$_driver
The driver for accessing the Kolab storage system.
private
Horde_Kolab_Storage_Driver
$_driver
Methods
__construct()
Constructor.
public
__construct(Horde_Kolab_Storage_Driver $driver) : mixed
Parameters
- $driver : Horde_Kolab_Storage_Driver
-
The driver to access the backend.
Return values
mixed —deleteAcl()
Delete the access rights for user on a folder.
public
deleteAcl(string $folder, string $user) : null
Parameters
- $folder : string
-
The folder to act upon.
- $user : string
-
The user to delete the ACL for
Return values
null —getAcl()
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<string|int, mixed>
Parameters
- $folder : string
-
The folder to retrieve the ACL for.
Return values
array<string|int, mixed> —An array of rights.
getAllAcl()
Retrieve the all access rights on a folder.
public
getAllAcl(string $folder) : string
Parameters
- $folder : string
-
The folder to retrieve the ACL for.
Return values
string —The folder rights.
getMyAcl()
Retrieve the access rights the current user has on a folder.
public
getMyAcl(string $folder) : string
Parameters
- $folder : string
-
The folder to retrieve the user ACL for.
Return values
string —The user rights.
hasAclSupport()
Does the backend support ACL?
public
hasAclSupport() : bool
Return values
bool —True if the backend supports ACLs.
setAcl()
Set the access rights for a folder.
public
setAcl(string $folder, string $user, string $acl) : null
Parameters
- $folder : string
-
The folder to act upon.
- $user : string
-
The user to set the ACL for.
- $acl : string
-
The ACL.
Return values
null —_failOnMissingAcl()
private
_failOnMissingAcl() : mixed