API Documentation
\

\Horde_Kolab_Storage_List_Query_Acl

Defines the ACL query.

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.

Summary

Methods
Properties
Constants
hasAclSupport()
getAcl()
getMyAcl()
getAllAcl()
setAcl()
deleteAcl()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

hasAclSupport()

hasAclSupport() : boolean

Does the backend support ACL?

Returns

boolean —

True if the backend supports ACLs.

getAcl()

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.

Parameters

string $folder

The folder to retrieve the ACL for.

Returns

array —

An array of rights.

getMyAcl()

getMyAcl(string  $folder) : string

Retrieve the access rights the current user has on a folder.

Parameters

string $folder

The folder to retrieve the user ACL for.

Returns

string —

The user rights.

getAllAcl()

getAllAcl(string  $folder) : string

Retrieve the all access rights on a folder.

Parameters

string $folder

The folder to retrieve the ACL for.

Returns

string —

The folder rights.

setAcl()

setAcl(string  $folder, string  $user, string  $acl) : NULL

Set the access rights for a folder.

Parameters

string $folder

The folder to act upon.
string $user

The user to set the ACL for.
string $acl

The ACL.

Returns

NULL

deleteAcl()

deleteAcl(string  $folder, string  $user) : NULL

Delete the access rights for user on a folder.

Parameters

string $folder

The folder to act upon.
string $user

The user to delete the ACL for

Returns

NULL