Class Horde_Permission_Kolab

Description

The Horde_Permission_Kolab provides a bridge between Horde Permission handling and the IMAP permission system used on the Kolab server.

$Horde: framework/Kolab_Storage/lib/Horde/Kolab/Storage/Perms.php,v 1.2.2.2 2009/01/06 15:23:18 jan Exp $

Copyright 2006-2009 The Horde Project (http://www.horde.org/)

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.

Located in /Kolab_Storage/lib/Horde/Kolab/Storage/Perms.php (line 26)

Horde_Permission
   |
   --Horde_Permission_Kolab
Variable Summary
 string $acl
 string $data
 string $_folder
Method Summary
 Horde_Permission_Kolab Horde_Permission_Kolab ( &$folder, [array $perms = null], Kolab_Folder $folder)
 mixed get (string $attribute)
 array|PEAR_Error getPerm ()
 mixed getPermissions ([string $user = null], [string $creator = null])
 boolean hasPermission (string $user, integer $perm, [string $creator = null])
 boolean|PEAR_Error save ()
 boolean|PEAR_Error savePermission ( $user,  $perms)
 void setFolder ( &$folder, string $folder)
 array __sleep ()
Variables
string $acl (line 48)

A cache for the raw IMAP folder acl settings.

string $data (line 41)

A cache for the folder acl settings. The cache holds the permissions in horde compatible format, not in the IMAP permission format.

string $_folder (line 33)

The folder name.

Methods
Constructor Horde_Permission_Kolab (line 57)

Constructor.

Horde_Permission_Kolab Horde_Permission_Kolab ( &$folder, [array $perms = null], Kolab_Folder $folder)
  • Kolab_Folder $folder: The Kolab Folder
  • array $perms: A set of initial permissions.
  • &$folder
get (line 103)

Gets one of the attributes of the object, or null if it isn't defined.

  • return: The value of the attribute, or null.
mixed get (string $attribute)
  • string $attribute: The attribute to get.

Redefinition of:
Horde_Permission::get()
Gets one of the attributes of the object, or null if it isn't defined.
getPerm (line 123)

Gets the current permission of the folder and stores the values in the cache.

  • return: The data array representing the permissions.
array|PEAR_Error getPerm ()
getPermissions (line 344)

Finds out what rights the given user has to this object.

  • return: A bitmask of permissions, a permission value, or an array of permission values the user has, depending on the permission type and whether the permission value is ambiguous. False if there is no such permsission.
mixed getPermissions ([string $user = null], [string $creator = null])
  • string $user: The user to check for. Defaults to the current user.
  • string $creator: The user who created the object.
hasPermission (line 410)

Finds out if the user has the specified rights to the given object.

  • return: True if the user has the specified permissions.
boolean hasPermission (string $user, integer $perm, [string $creator = null])
  • string $user: The user to check for.
  • integer $perm: The permission level that needs to be checked for.
  • string $creator: The creator of the shared object.
save (line 204)

Saves the current permission values from the cache to the IMAP folder.

  • return: True on success, false if there is nothing to save.
boolean|PEAR_Error save ()
savePermission (line 306)

Saves the specified permission values for the given user on the IMAP folder.

  • return: True on success.
boolean|PEAR_Error savePermission ( $user,  $perms)
  • $user
  • $perms
setFolder (line 91)

Sets the folder object for this permission object.

void setFolder ( &$folder, string $folder)
  • string $folder: Kolab Folder object.
  • &$folder
__sleep (line 78)

Returns the properties that need to be serialized.

  • return: List of serializable properties.
array __sleep ()

Inherited Methods

Inherited From Horde_Permission

 Horde_Permission::Horde_Permission()
 Horde_Permission::addCreatorPermission()
 Horde_Permission::addDefaultPermission()
 Horde_Permission::addGroupPermission()
 Horde_Permission::addGuestPermission()
 Horde_Permission::addUserPermission()
 Horde_Permission::get()
 Horde_Permission::getCreatorPermissions()
 Horde_Permission::getData()
 Horde_Permission::getDefaultPermissions()
 Horde_Permission::getGroupPermissions()
 Horde_Permission::getGuestPermissions()
 Horde_Permission::getName()
 Horde_Permission::getUserPermissions()
 Horde_Permission::removeCreatorPermission()
 Horde_Permission::removeDefaultPermission()
 Horde_Permission::removeGroupPermission()
 Horde_Permission::removeGuestPermission()
 Horde_Permission::removeUserPermission()
 Horde_Permission::setData()
 Horde_Permission::setName()
 Horde_Permission::setPerm()
 Horde_Permission::unsetPerm()
 Horde_Permission::updatePermissions()

Documentation generated on Sun, 30 Jan 2011 05:20:29 +0000 by phpDocumentor 1.4.3