Class Horde_Share_Object_Datatree
Extension of the Horde_Share_Object class for storing share information in
the Horde_DataTree driver.
-
Horde_Share_Object
implements
Serializable
-
Horde_Share_Object_Datatree
Methods summary
public
|
#
__construct( Horde_Share_Object_Datatree_Share $datatreeObject )
Constructor.
Parameters
- $datatreeObject
- <p>A Horde_Share_Object_DataTree_Share
instance.</p>
|
public
string
|
#
serialize( )
Serialize this object.
Returns
string The serialized data.
|
public
|
#
unserialize( string $data )
Reconstruct the object from serialized data.
Reconstruct the object from serialized data.
Parameters
- $data
- The serialized data.
|
public
mixed
|
#
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
mixed True if setting the attribute did succeed, a PEAR_Error
otherwise.
|
public
mixed
|
#
get( string $attribute )
Returns one of the attributes of the object, or null if it isn't
defined.
Returns one of the attributes of the object, or null if it isn't
defined.
Parameters
- $attribute
- The attribute to retrieve.
Returns
mixed The value of the attribute, or an empty string.
|
public
string
|
#
getId( )
Returns the ID of this share.
Returns the ID of this share.
Returns
string The share's ID.
|
public
string
|
#
getName( )
Returns the name of this share.
Returns the name of this share.
Returns
string The share's name.
|
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.
|
public
boolean
|
#
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>
Returns
boolean True if no error occured, PEAR_Error otherwise
|
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 Horde_Share_Object
addCreatorPermission(),
addDefaultPermission(),
addGroupPermission(),
addGuestPermission(),
addUserPermission(),
getShareOb(),
listGroups(),
listUsers(),
removeCreatorPermission(),
removeDefaultPermission(),
removeGroup(),
removeGroupPermission(),
removeGuestPermission(),
removeUser(),
removeUserPermission(),
save(),
setShareOb()
|
Properties summary
public
mixed
|
$datatreeObject
The actual storage object that holds the data.
The actual storage object that holds the data.
|
|