Class Horde_Share_Object

Description

Abstract class for storing Share information.

This class should be extended for the more specific drivers.

Located in /Share/Share.php (line 555)


	
			
Direct descendents
Class Description
 class Horde_Share_Object_datatree Extension of the Horde_Share_Object class for storing share information in the DataTree driver.
 class Horde_Share_Object_kolab Extension of the Horde_Share_Object class for handling Kolab share information.
 class Horde_Share_Object_sql Extension of the Horde_Share_Object class for storing share information in the sql driver.
Variable Summary
Method Summary
 void addGroupPermission (string $group, integer $permission)
 void addUserPermission (string $userid, integer $permission)
 mixed get (string $attribute)
 string getId ()
 string getName ()
 array listGroups ([integer $perm_level = null])
 array listUsers ([integer $perm_level = null])
 void removeGroup (integer $groupId)
 void removeGroupPermission (string $group, constant $permission)
 void removeUser (string $userid)
 void removeUserPermission (string $userid, integer $permission)
 void save ()
 mixed set (string $attribute, mixed $value)
 void setShareOb ( &$shareOb, Horde_Share $shareOb)
 array __sleep ()
Variables
Horde_Share $_shareOb (line 563)

The Horde_Share object which this share came from - needed for updating data in the backend to make changes stick, etc.

Methods
addGroupPermission (line 683)

Gives a group certain privileges for this share.

void addGroupPermission (string $group, integer $permission)
  • string $group: The group to add permissions for.
  • integer $permission: A PERMS_* constant.
addUserPermission (line 657)

Gives a user a certain privilege for this share.

void addUserPermission (string $userid, integer $permission)
  • string $userid: The userid of the user.
  • integer $permission: A PERMS_* constant.
get (line 612)

Returns an attribute value from this object.

  • return: The value for $attribute.
mixed get (string $attribute)
  • string $attribute: The attribute to return.
getId (line 622)

Returns the ID of this share.

  • return: The share's ID.
string getId ()
getName (line 632)

Returns the name of this share.

  • return: The share's name.
string getName ()
listGroups (line 762)

Returns an array containing all the groupids of the groups with access to this share.

  • return: The IDs of the groups with access to this share.
array listGroups ([integer $perm_level = null])
  • integer $perm_level: List only users with this permission level. Defaults to all users.
listUsers (line 744)

Returns an array containing all the userids of the users with access to this share.

  • return: The users with access to this share.
array listUsers ([integer $perm_level = null])
  • integer $perm_level: List only users with this permission level. Defaults to all users.
removeGroup (line 724)

Removes a group from this share.

void removeGroup (integer $groupId)
  • integer $groupId: The group to remove.
removeGroupPermission (line 696)

Removes a certain privilege from a group.

void removeGroupPermission (string $group, constant $permission)
  • string $group: The group to remove permissions from.
  • constant $permission: A PERMS_* constant.
removeUser (line 708)

Removes a user from this share.

void removeUser (string $userid)
  • string $userid: The userid of the user to remove.
removeUserPermission (line 670)

Removes a certain privilege for a user from this share.

void removeUserPermission (string $userid, integer $permission)
  • string $userid: The userid of the user.
  • integer $permission: A PERMS_* constant.
save (line 640)

Saves the current attribute values.

void save ()
set (line 600)

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.
setShareOb (line 583)

Associates a Share object with this share.

void setShareOb ( &$shareOb, Horde_Share $shareOb)

Redefined in descendants as:
__sleep (line 570)

Returns the properties that need to be serialized.

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

Redefined in descendants as:

Documentation generated on Sun, 30 Jan 2011 05:21:19 +0000 by phpDocumentor 1.4.3