Class Horde_Share_Object_kolab

Description

Extension of the Horde_Share_Object class for handling Kolab share information.

Located in /Share/Share/kolab.php (line 348)

Horde_Share_Object
   |
   --Horde_Share_Object_kolab
Variable Summary
Method Summary
 Horde_Share_Object_kolab Horde_Share_Object_kolab (string $id,  $type)
 boolean|PEAR_Error delete ()
 boolean|PEAR_Error hasPermission (string $userid, integer $permission, [string $creator = null])
 void setFolder ( &$folder, string $folder, array $perms)
 boolean|PEAR_Error setPermission ( &$perms, [boolean $update = true], Horde_Permission_Kolab $perms)
 void setShareOb ( &$shareOb, Horde_Share $shareOb)
 PEAR_Error _folderError ()
 mixed _get (string $attribute)
 string _getId ()
 string _getName ()
 void _save ()
 mixed _set (string $attribute, mixed $value)
 array __sleep ()
 void __wakeup ()
Variables
array $_data (line 369)

A cache for the share attributes.

Kolab_Folder $_folder (line 355)

The Kolab folder this share is based on.

string $_folder_name (line 362)

The Kolab folder name.

Kolab_List $_list (line 376)

Our Kolab folder list handler

Inherited Variables

Inherited from Horde_Share_Object

Horde_Share_Object::$_shareOb
Methods
Constructor Horde_Share_Object_kolab (line 385)

Constructor.

Sets the folder name.

Horde_Share_Object_kolab Horde_Share_Object_kolab (string $id,  $type)
  • string $id: The share id.
  • $type
delete (line 626)

Delete this share.

  • return: True on success.
boolean|PEAR_Error delete ()
getDefaultShareName (line 439)

Returns the default share name for the current application.

  • return: The default share name.
string getDefaultShareName ()
getPermission (line 656)

Returns the permissions from this storage object.

  • return: The permissions on the share.
Horde_Permission_Kolab|PEAR_Error &getPermission ()
hasPermission (line 643)

Checks to see if a user has a given permission.

  • return: Whether or not $userid has $permission.
boolean|PEAR_Error hasPermission (string $userid, integer $permission, [string $creator = null])
  • string $userid: The userid of the user.
  • integer $permission: A PERMS_* constant to test for.
  • string $creator: The creator of the shared object.
setFolder (line 463)

Sets the folder for this storage object.

void setFolder ( &$folder, string $folder, array $perms)
  • string $folder: Name of the Kolab folder.
  • array $perms: The permissions of the folder if they are known.
  • &$folder
setPermission (line 673)

Sets the permissions on the share.

  • return: True on success.
boolean|PEAR_Error setPermission ( &$perms, [boolean $update = true], Horde_Permission_Kolab $perms)
  • Horde_Permission_Kolab $perms: Permission object to folder on the object.
  • boolean $update: Save the updated information?
  • &$perms
setShareOb (line 404)

Associates a Share object with this share.

void setShareOb ( &$shareOb, Horde_Share $shareOb)

Redefinition of:
Horde_Share_Object::setShareOb()
Associates a Share object with this share.
_folderError (line 687)

Return a standard error in case the share has not been correctly initialized.

  • return: The PEAR_Error to return.
PEAR_Error _folderError ()
_get (line 500)

Returns an attribute value from this object.

  • return: The value for $attribute.
mixed _get (string $attribute)
  • string $attribute: The attribute to return.
_getId (line 478)

Returns the ID of this share.

  • return: The share's ID.
string _getId ()
_getName (line 488)

Returns the name of this share.

  • return: The share's name.
string _getName ()
_save (line 599)

Saves the current attribute values.

void _save ()
_set (line 566)

Sets an attribute value in this object.

  • return: True if setting the attribute did succeed, a PEAR_Error otherwise.
mixed _set (string $attribute, mixed $value)
  • string $attribute: The attribute to set.
  • mixed $value: The value for $attribute.
__sleep (line 425)

Returns the properties that need to be serialized.

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

Redefinition of:
Horde_Share_Object::__sleep()
Returns the properties that need to be serialized.
__wakeup (line 412)

Initializes the object.

void __wakeup ()

Inherited Methods

Inherited From Horde_Share_Object

 Horde_Share_Object::addGroupPermission()
 Horde_Share_Object::addUserPermission()
 Horde_Share_Object::get()
 Horde_Share_Object::getId()
 Horde_Share_Object::getName()
 Horde_Share_Object::listGroups()
 Horde_Share_Object::listUsers()
 Horde_Share_Object::removeGroup()
 Horde_Share_Object::removeGroupPermission()
 Horde_Share_Object::removeUser()
 Horde_Share_Object::removeUserPermission()
 Horde_Share_Object::save()
 Horde_Share_Object::set()
 Horde_Share_Object::setShareOb()
 Horde_Share_Object::__sleep()

Documentation generated on Sun, 30 Jan 2011 05:18:51 +0000 by phpDocumentor 1.4.3