Class Horde_Share_datatree

Description

Horde_Share_datatree:: provides the datatree backend for the horde share driver.

$Horde: framework/Share/Share/datatree.php,v 1.16.2.9 2009/01/06 15:23:36 jan Exp $

Copyright 2002-2009 The Horde Project (http://www.horde.org/) Copyright 2002-2007 Infoteck Internet <webmaster@infoteck.qc.ca>

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/datatree.php (line 25)

Horde_Share
   |
   --Horde_Share_datatree
Variable Summary
Method Summary
 void _addShare ( &$share, Horde_Share_Object_datatree $share)
 integer _countShares (string $userid, [integer $perm = PERMS_SHOW], [mixed $attributes = null])
 boolean _exists (string $share)
 array _getShareCriteria (string $userid, [integer $perm = PERMS_SHOW], [mixed $attributes = null])
 array &_getShares ( $ids, array $cids)
 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_datatree $share)
 void __wakeup ()
Variables
DataTree $_datatree (line 39)

Pointer to a DataTree instance to manage/store shares

string $_shareObject = 'Horde_Share_Object_datatree' (line 32)

The Horde_Share_Object subclass to instantiate objects as

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
_addShare (line 224)

Adds a share to the shares system.

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

void _addShare ( &$share, Horde_Share_Object_datatree $share)
_countShares (line 194)

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 246)

Checks if a share exists in the system.

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

Returns a Horde_Share_Object_datatree object corresponding to the given share name, with the details retrieved appropriately.

  • return: The requested share.
Horde_Share_Object_datatree &_getShare (string $name)
  • string $name: The name of the share to retrieve.
_getShareById (line 93)

Returns a Horde_Share_Object_datatree object corresponding to the given unique ID, with the details retrieved appropriately.

  • return: The requested share.
Horde_Share_Object_datatree &_getShareById ( $id, string $cid)
  • string $cid: The id of the share to retrieve.
  • $id
_getShareCriteria (line 262)

Returns an array of criteria for querying shares.

  • return: The criteria tree for fetching this user's shares.
  • access: protected
array _getShareCriteria (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 returned to those who have these attribute values.
_getShares (line 112)

Returns an array of Horde_Share_Object_datatree objects corresponding to the given set of unique IDs, with the details retrieved appropriately.

  • return: The requested shares.
array &_getShares ( $ids, array $cids)
  • array $cids: The array of ids to retrieve.
  • $ids
_listAllShares (line 134)

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

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

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 207)

Returns a new share object.

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

Removes a share from the shares system permanently.

void _removeShare ( &$share, Horde_Share_Object_datatree $share)
__wakeup (line 44)

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:16:35 +0000 by phpDocumentor 1.4.3