API Documentation
\

\Horde_Share_Object_Kolab

Extension of the Horde_Share_Object class for handling Kolab share information.

Copyright 2004-2017 Horde LLC (http://www.horde.org/)

See the enclosed file LICENSE for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Summary

Methods
Properties
Constants
setShareOb()
getShareOb()
set()
get()
getId()
getName()
save()
toHash()
addUserPermission()
removeUserPermission()
addGroupPermission()
removeGroupPermission()
removeUser()
removeGroup()
listUsers()
listGroups()
addGuestPermission()
removeGuestPermission()
addCreatorPermission()
removeCreatorPermission()
addDefaultPermission()
removeDefaultPermission()
hasPermission()
setPermission()
getPermission()
__construct()
serialize()
unserialize()
getPermissionId()
getOwner()
countChildren()
getChildren()
getParent()
getParents()
setParent()
getAcl()
setAcl()
deleteAcl()
No public properties found
VERSION
_save()
_getAttributes()
$_shareCallback
$_shareOb
$_data
N/A
No private methods found
$_old_id
$_id
$_groups
$_permission
N/A

Constants

VERSION

VERSION

Serializable version.

Properties

$_shareCallback

$_shareCallback : callback

A function to be called when a Horde_Share object is needed and not available.

Type

callback

$_shareOb

$_shareOb : \Horde_Share

The Horde_Share object which this share is associated with.

If this is empty, the $_shareCallback is called to obtain it.

Type

\Horde_Share

$_data

$_data : array

The share attributes.

Type

array

$_old_id

$_old_id : string

The old share id.

Type

string

$_id

$_id : string

The share id.

Type

string

$_groups

$_groups : \Horde_Group_Base

The Horde_Group driver

Type

\Horde_Group_Base

$_permission

$_permission : \Horde_Perm_Permission_Kolab

The permission cache holds any permission changes that will be executed on saving.

Type

\Horde_Perm_Permission_Kolab

Methods

setShareOb()

setShareOb(  $shareOb)

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

Parameters

$shareOb

getShareOb()

getShareOb() : \Horde_Share

Obtain this object's share driver.

Returns

\Horde_Share —

The share driver.

set()

set(string  $attribute, mixed  $value, boolean  $update = false) : NULL

Sets an attribute value in this object.

Parameters

string $attribute

The attribute to set.
mixed $value

The value for $attribute.
boolean $update

Update only this change immediately.

Returns

NULL

get()

get(string  $attribute) : mixed

Returns an attribute value from this object.

Parameters

string $attribute

The attribute to return.

Returns

mixed —

The value for $attribute.

getId()

getId() : string

Returns the ID of this share.

Returns

string —

The share's ID.

getName()

getName() : string

Returns the name of this share.

Returns

string —

The share's name.

save()

save() : boolean

Saves the current attribute values.

Throws

\Horde_Exception

Returns

boolean

toHash()

toHash() : array

Exports the share object as a PHP hash.

Returns

array —

Hash representation of this share.

addUserPermission()

addUserPermission(string  $userid, integer  $permission)

Gives a user a certain privilege for this share.

Parameters

string $userid

The userid of the user.
integer $permission

A Horde_Perms::* constant.

removeUserPermission()

removeUserPermission(string  $userid, integer  $permission)

Removes a certain privilege for a user from this share.

Parameters

string $userid

The userid of the user.
integer $permission

A Horde_Perms::* constant.

addGroupPermission()

addGroupPermission(string  $group, integer  $permission)

Gives a group certain privileges for this share.

Parameters

string $group

The group to add permissions for.
integer $permission

A Horde_Perms::* constant.

removeGroupPermission()

removeGroupPermission(string  $group, \constant  $permission)

Removes a certain privilege from a group.

Parameters

string $group

The group to remove permissions from.
\constant $permission

A Horde_Perms::* constant.

removeUser()

removeUser(string  $userid)

Removes a user from this share.

Parameters

string $userid

The userid of the user to remove.

removeGroup()

removeGroup(integer  $groupId)

Removes a group from this share.

Parameters

integer $groupId

The group to remove.

listUsers()

listUsers(integer  $perm_level = null) : array

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

Parameters

integer $perm_level

List only users with this permission level. Defaults to all users.

Returns

array —

The users with access to this share.

listGroups()

listGroups(integer  $perm_level = null) : array

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

Parameters

integer $perm_level

List only users with this permission level. Defaults to all users.

Returns

array —

The IDs of the groups with access to this share.

addGuestPermission()

addGuestPermission(integer  $permission)

Gives guests a certain privilege for this share.

Parameters

integer $permission

A Horde_Perms::* constant.

removeGuestPermission()

removeGuestPermission(integer  $permission)

Removes a certain privilege for guests from this share.

Parameters

integer $permission

A Horde_Perms::* constant.

addCreatorPermission()

addCreatorPermission(integer  $permission)

Gives creators a certain privilege for this share.

Parameters

integer $permission

A Horde_Perms::* constant.

removeCreatorPermission()

removeCreatorPermission(integer  $permission)

Removes a certain privilege for creators from this share.

Parameters

integer $permission

A Horde_Perms::* constant.

addDefaultPermission()

addDefaultPermission(integer  $permission)

Gives all authenticated users a certain privilege for this share.

Parameters

integer $permission

A Horde_Perms::* constant.

removeDefaultPermission()

removeDefaultPermission(integer  $permission)

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

Parameters

integer $permission

A Horde_Perms::* constant.

hasPermission()

hasPermission(string  $userid, integer  $permission, string  $creator = null) : boolean

Checks to see if a user has a given permission.

Parameters

string $userid

The userid of the user.
integer $permission

A Horde_Perms::* constant to test for.
string $creator

The creator of the shared object.

Returns

boolean —

Whether or not $userid has $permission.

setPermission()

setPermission(\Horde_Perms_Permission_Kolab  $perms, boolean  $update = true) : NULL

Sets the permissions on the share.

Parameters

\Horde_Perms_Permission_Kolab $perms

Permission object to folder on the object.
boolean $update

Save the updated information?

Returns

NULL

getPermission()

getPermission() : \Horde_Perms_Permission_Kolab

Returns the permissions from this storage object.

Returns

\Horde_Perms_Permission_Kolab —

The permissions on the share.

__construct()

__construct(string  $id, \Horde_Group_Base  $groups, array  $data = array())

Constructor.

Parameters

string $id

The share id.
\Horde_Group_Base $groups

The Horde_Group driver
array $data

The share data.

serialize()

serialize() : string

Serialize this object.

Returns

string —

The serialized data.

unserialize()

unserialize(\<type>  $data)

Unserialize object.

Parameters

\ $data

getPermissionId()

getPermissionId() : string

Returns the permission ID of this share.

Returns

string —

The share's permission ID.

getOwner()

getOwner() : string

Returns the owner of this share.

Returns

string —

The share's owner.

countChildren()

countChildren(string  $user, integer  $perm = \Horde_Perms::SHOW, boolean  $allLevels = true) : integer

Return a count of the number of children this share has

Parameters

string $user

The user to use for checking perms
integer $perm

A Horde_Perms::* constant
boolean $allLevels

Count grandchildren or just children

Returns

integer —

The number of child shares

getChildren()

getChildren(string  $user, integer  $perm = \Horde_Perms::SHOW, boolean  $allLevels = true) : array

Get all children of this share.

Parameters

string $user

The user to use for checking perms
integer $perm

Horde_Perms::* constant. If NULL will return all shares regardless of permissions.
boolean $allLevels

Return all levels.

Returns

array —

An array of Horde_Share_Object objects

getParent()

getParent() : \Horde_Share_Object|NULL

Returns a child's direct parent.

Returns

\Horde_Share_Object|NULL —

The direct parent Horde_Share_Object or NULL in case the share has no parent.

getParents()

getParents() : \array()

Get all of this share's parents.

Returns

\array() —

An array of Horde_Share_Objects.

setParent()

setParent(mixed  $parent) : NULL

Set the parent object for this share.

Parameters

mixed $parent

A Horde_Share object or share id for the parent.

Returns

NULL

getAcl()

getAcl() : \An

Retrieve the Kolab specific access rights for this share.

Returns

\An —

array of rights.

setAcl()

setAcl(string  $user, string  $acl) : NULL

Set the Kolab specific access rights for this share.

Parameters

string $user

The user to set the ACL for.
string $acl

The ACL.

Returns

NULL

deleteAcl()

deleteAcl(string  $user) : NULL

Delete Kolab specific access rights for this share.

Parameters

string $user

The user to delete the ACL for.

Returns

NULL

_save()

_save()

Saves the current attribute values.

_getAttributes()

_getAttributes() : array

Returns the share attributes.

Returns

array —

All share attributes as a hash.