PHP Class Horde_Kolab_Storage_List_Query_Acl_Cache, 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, implements Horde_Kolab_Storage_List_Manipulation_Listener, implements Horde_Kolab_Storage_List_Synchronization_Listener
Mostrar archivo Open project: horde/horde Class Usage Examples

Public Methods

Method Description
__construct ( Horde_Kolab_Storage_List_Query_Acl $query, Horde_Kolab_Storage_List_Cache $cache ) 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.
synchronize ( ) : null Synchronize the ACL information with the information from the backend.
updateAfterCreateFolder ( string $folder, string $type = null ) : null Update the listener after creating a new folder.
updateAfterDeleteFolder ( string $folder ) : null Update the listener after deleting folder.
updateAfterRenameFolder ( string $old, string $new ) : null Update the listener after renaming a folder.

Private Methods

Method Description
_purgeFolder ( string $folder ) : null Remove outdated folder data from the cache.

Method Details

__construct() public method

Constructor.
public __construct ( Horde_Kolab_Storage_List_Query_Acl $query, Horde_Kolab_Storage_List_Cache $cache )
$query Horde_Kolab_Storage_List_Query_Acl
$cache Horde_Kolab_Storage_List_Cache The list cache.

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

synchronize() public method

Synchronize the ACL information with the information from the backend.
public synchronize ( ) : null
return null

updateAfterCreateFolder() public method

Update the listener after creating a new folder.
public updateAfterCreateFolder ( string $folder, string $type = null ) : null
$folder string The path of the folder that has been created.
$type string An optional type for the folder.
return null

updateAfterDeleteFolder() public method

Update the listener after deleting folder.
public updateAfterDeleteFolder ( string $folder ) : null
$folder string The path of the folder that has been deleted.
return null

updateAfterRenameFolder() public method

Update the listener after renaming a folder.
public updateAfterRenameFolder ( string $old, string $new ) : null
$old string The old path of the folder.
$new string The new path of the folder.
return null