Overview

Packages

  • None
  • Share

Classes

  • Horde_Share_Base
  • Horde_Share_Datatree
  • Horde_Share_Kolab
  • Horde_Share_Object
  • Horde_Share_Object_Datatree
  • Horde_Share_Object_DataTree_Share
  • Horde_Share_Object_Kolab
  • Horde_Share_Object_Sql
  • Horde_Share_Object_Sqlng
  • Horde_Share_Sql
  • Horde_Share_Sqlng
  • Horde_Share_Translation
  • Overview
  • Package
  • Class
  • Tree

Class Horde_Share_Object

Abstract class for storing Share information.

This class should be extended for the more specific drivers.

Horde_Share_Object implements Serializable

Direct known subclasses

Horde_Share_Object_Datatree, Horde_Share_Object_Kolab, Horde_Share_Object_Sql

Indirect known subclasses

Horde_Share_Object_Sqlng
Abstract
Package: Share
Author: Mike Cochrane mike@graftonhall.co.nz
Author: Jan Schneider jan@horde.org
Author: Gunnar Wrobel wrobel@pardus.de
Located at Horde/Share/Object.php
Methods summary
public
# setShareOb( mixed $shareOb )

Associates a Share object with this share, or provides a callback that knows how to provide it.

Associates a Share object with this share, or provides a callback that knows how to provide it.

Parameters

$shareOb
| Callback $shareOb The Share object.
public Horde_Share
# getShareOb( )

Obtain this object's share driver.

Obtain this object's share driver.

Returns

Horde_Share
The share driver.
abstract public boolean
# set( string $attribute, mixed $value, boolean $update = false )

Sets an attribute value in this object.

Sets an attribute value in this object.

Parameters

$attribute
The attribute to set.
$value
The value for $attribute.
$update
Immediately update only this change.

Returns

boolean
abstract public mixed
# get( string $attribute )

Returns an attribute value from this object.

Returns an attribute value from this object.

Parameters

$attribute
The attribute to return.

Returns

mixed
The value for $attribute.
abstract public string
# getId( )

Returns the ID of this share.

Returns the ID of this share.

Returns

string
The share's ID.
abstract public string
# getName( )

Returns the name of this share.

Returns the name of this share.

Returns

string
The share's name.
public boolean
# save( )

Saves the current attribute values.

Saves the current attribute values.

Returns

boolean

Throws

Horde_Exception
public
# addUserPermission( string $userid, integer $permission )

Gives a user a certain privilege for this share.

Gives a user a certain privilege for this share.

Parameters

$userid
The userid of the user.
$permission
A Horde_Perms::* constant.
public
# removeUserPermission( string $userid, integer $permission )

Removes a certain privilege for a user from this share.

Removes a certain privilege for a user from this share.

Parameters

$userid
The userid of the user.
$permission
A Horde_Perms::* constant.
public
# addGroupPermission( string $group, integer $permission )

Gives a group certain privileges for this share.

Gives a group certain privileges for this share.

Parameters

$group
The group to add permissions for.
$permission
A Horde_Perms::* constant.
public
# removeGroupPermission( string $group, constant $permission )

Removes a certain privilege from a group.

Removes a certain privilege from a group.

Parameters

$group
The group to remove permissions from.
$permission
A Horde_Perms::* constant.
public
# removeUser( string $userid )

Removes a user from this share.

Removes a user from this share.

Parameters

$userid
The userid of the user to remove.
public
# removeGroup( integer $groupId )

Removes a group from this share.

Removes a group from this share.

Parameters

$groupId
The group to remove.
public array
# listUsers( integer $perm_level = null )

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

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

Parameters

$perm_level
<p>List only users with this permission level. Defaults to all users.</p>

Returns

array
The users with access to this share.
public array
# listGroups( integer $perm_level = null )

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

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

Parameters

$perm_level
<p>List only users with this permission level. Defaults to all users.</p>

Returns

array
The IDs of the groups with access to this share.
public
# addGuestPermission( integer $permission )

Gives guests a certain privilege for this share.

Gives guests a certain privilege for this share.

Parameters

$permission
A Horde_Perms::* constant.
public
# removeGuestPermission( integer $permission )

Removes a certain privilege for guests from this share.

Removes a certain privilege for guests from this share.

Parameters

$permission
A Horde_Perms::* constant.
public
# addCreatorPermission( integer $permission )

Gives creators a certain privilege for this share.

Gives creators a certain privilege for this share.

Parameters

$permission
A Horde_Perms::* constant.
public
# removeCreatorPermission( integer $permission )

Removes a certain privilege for creators from this share.

Removes a certain privilege for creators from this share.

Parameters

$permission
A Horde_Perms::* constant.
public
# addDefaultPermission( integer $permission )

Gives all authenticated users a certain privilege for this share.

Gives all authenticated users a certain privilege for this share.

Parameters

$permission
A Horde_Perms::* constant.
public
# removeDefaultPermission( integer $permission )

Removes a certain privilege for all authenticated users from this share.

Removes a certain privilege for all authenticated users from this share.

Parameters

$permission
A Horde_Perms::* constant.
abstract public boolean
# hasPermission( string $userid, integer $permission, string $creator = null )

Checks to see if a user has a given permission.

Checks to see if a user has a given permission.

Parameters

$userid
The userid of the user.
$permission
A Horde_Perms::* constant to test for.
$creator
The creator of the event.

Returns

boolean
Whether or not $userid has $permission.
abstract public
# setPermission( Horde_Perms_Permission $perm, boolean $update = true )

Sets the permission of this share.

Sets the permission of this share.

Parameters

$perm
Permission object.
$update
<p>Should the share be saved after this operation?</p>
abstract public Horde_Perms_Permission
# getPermission( )

Returns the permission of this share.

Returns the permission of this share.

Returns

Horde_Perms_Permission

Permission object that represents the permissions on this share.
Methods inherited from Serializable
serialize(), unserialize()
API documentation generated by ApiGen