Class Horde_Share_kolab

Description

Horde_Share_kolab:: provides the kolab backend for the horde share driver.

Copyright 2004-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 /Share/Share/kolab.php (line 24)

Horde_Share
   |
   --Horde_Share_kolab
Variable Summary
Method Summary
 string getDefaultShare ()
 void _addShare ( &$share, Horde_Share_Object_kolab $share)
 integer _countShares (string $userid, [integer $perm = PERMS_SHOW], [mixed $attributes = null])
 boolean _exists ( $object, string $share)
 array &_getShares (string $ids)
 array &_listAllShares ()
 array &_listShares (string $userid, [integer $perm = PERMS_SHOW], [mixed $attributes = null], [ $from = 0], [ $count = 0], [ $sort_by = null], [ $direction = 0])
 void _removeShare ( &$share, Horde_Share_Object_kolab $share)
 array __sleep ()
 void __wakeup ()
Variables
Kolab_List $_list (line 31)

Our Kolab folder list handler

int $_listCacheValidity (line 45)

A marker for the validity of the list cache

string $_type (line 38)

The share type

Inherited Variables

Inherited from Horde_Share

Horde_Share::$_app
Horde_Share::$_cache
Horde_Share::$_listcache
Horde_Share::$_root
Horde_Share::$_shareMap
Horde_Share::$_sortList
Methods
getDefaultShare (line 314)

Create a default share for the current app

  • return: The share ID of the new default share.
string getDefaultShare ()
_addShare (line 267)

Adds a share to the shares system.

The share must first be created with Horde_Share_kolab::_newShare(), and have any initial details added to it, before this function is called.

void _addShare ( &$share, Horde_Share_Object_kolab $share)
_countShares (line 235)

Returns the number of shares that $userid has access to.

  • return: The number of shares
  • since: Horde 3.2
integer _countShares (string $userid, [integer $perm = PERMS_SHOW], [mixed $attributes = null])
  • string $userid: The userid of the user to check access for.
  • integer $perm: The level of permissions required.
  • mixed $attributes: Restrict the shares counted to those matching $attributes. An array of attribute/values pairs or a share owner username.
_exists (line 294)

Checks if a share exists in the system.

  • return: True if the share exists.
boolean _exists ( $object, string $share)
  • string $share: The share to check.
  • $object
_getShare (line 87)

Returns a Horde_Share_Object_kolab object of the request folder.

  • return: The share object.
Horde_Share_Object_kolab &_getShare (string $object)
  • string $object: The share to fetch.
_getShareById (line 122)

Returns a Horde_Share_Object_kolab object of the requested folder.

  • return: The share object.
Horde_Share_Object_kolab &_getShareById (string $id)
  • string $id: The id of the share to fetch.
_getShares (line 135)

Returns an array of Horde_Share_Object_kolab objects corresponding to the requested folders.

  • return: An array of Horde_Share_Object_kolab objects.
array &_getShares (string $ids)
  • string $ids: The ids of the shares to fetch.
_listAllShares (line 156)

Lists *all* shares for the current app/share, regardless of permissions.

Currently not implemented in this class.

  • return: All shares for the current app/share.
array &_listAllShares ()
_listShares (line 174)

Returns an array of all shares that $userid has access to.

  • return: The shares the user has access to.
array &_listShares (string $userid, [integer $perm = PERMS_SHOW], [mixed $attributes = null], [ $from = 0], [ $count = 0], [ $sort_by = null], [ $direction = 0])
  • string $userid: The userid of the user to check access for.
  • integer $perm: The level of permissions required.
  • mixed $attributes: Restrict the shares counted to those matching $attributes. An array of attribute/values pairs or a share owner username.
  • $from
  • $count
  • $sort_by
  • $direction
_newShare (line 252)

Returns a new share object.

  • return: A new share object.
Horde_Share_Object_kolab &_newShare (string $name)
  • string $name: The share's name.
_removeShare (line 277)

Removes a share from the shares system permanently.

void _removeShare ( &$share, Horde_Share_Object_kolab $share)
__sleep (line 72)

Returns the properties that need to be serialized.

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

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

Initializes the object.

void __wakeup ()

Redefinition of:
Horde_Share::__wakeup()
Initializes the object.

Inherited Methods

Inherited From Horde_Share

 Horde_Share::Horde_Share()
 Horde_Share::addShare()
 Horde_Share::countShares()
 Horde_Share::exists()
 Horde_Share::getIdentityByShare()
 Horde_Share::getPermissions()
 Horde_Share::getShare()
 Horde_Share::getShareById()
 Horde_Share::getShares()
 Horde_Share::listAllShares()
 Horde_Share::listShares()
 Horde_Share::newShare()
 Horde_Share::removeShare()
 Horde_Share::shutdown()
 Horde_Share::singleton()
 Horde_Share::_sortShares()
 Horde_Share::__sleep()
 Horde_Share::__wakeup()

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