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_Kolab

Horde_Share_Kolab:: provides the Kolab backend for the horde share driver.

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

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

Horde_Share_Base
Extended by Horde_Share_Kolab
Package: Share
Category: Horde
License: LGPL 2.1
Author: Stuart Binge omicron@mighty.co.za
Author: Gunnar Wrobel wrobel@pardus.de
Link: http://pear.horde.org/index.php?package=Share
Located at Horde/Share/Kolab.php
Methods summary
public
# __construct( string $app, string $user, Horde_Perms_Base $perms, Horde_Group_Base $groups )

Constructor.

Constructor.

Parameters

$app
<p>The application that the shares belong to</p>
$user
The current user
$perms
The permissions object
$groups
The Horde_Group driver.

Overrides

Horde_Share_Base::__construct()
public null
# setStorage( Horde_Kolab_Storage $storage )

Set the Kolab storage backend.

Set the Kolab storage backend.

Parameters

$storage
The Kolab storage handler.

Returns

null
public Horde_Kolab_Storage
# getStorage( )

Return the Kolab storage backend associated with this driver.

Return the Kolab storage backend associated with this driver.

Returns

Horde_Kolab_Storage
The Kolab storage driver.
public Horde_Kolab_Storage_List
# getList( )

Return the Kolab storage folder list handler.

Return the Kolab storage folder list handler.

Returns

Horde_Kolab_Storage_List
The folder list handler.
public string
# getType( )

Return the type of folder this share driver will access in the Kolab storage backend (depends on the application calling the share driver).

Return the type of folder this share driver will access in the Kolab storage backend (depends on the application calling the share driver).

Returns

string
public string
# constructId( string $owner, string $name, string $prefix = null )

Construct the ID from the owner name and the folder subpath.

Construct the ID from the owner name and the folder subpath.

Parameters

$owner
The share owner.
$name
The name of the folder without the namespace prefix.
$prefix
The namespace prefix.

Returns

string
The encoded ID.
public string
# constructFolderName( string $owner, string $subpath, string $prefix = null )

Construct the Kolab storage folder name based on the share name and owner attributes.

Construct the Kolab storage folder name based on the share name and owner attributes.

Parameters

$owner
The owner of the share.
$subpath
The folder subpath.
$prefix
The namespace prefix.

Returns

string
The folder name for the Kolab backend.
public array
# getFolderNameElements( string $folder )

Retrieve namespace information for a folder name.

Retrieve namespace information for a folder name.

Parameters

$folder
The folder name.

Returns

array

A list of namespace prefix, the delimiter and the folder subpath.

Since

Horde_Share 1.2.0
public integer
# countShares( string $userid, integer $perm = Horde_Perms::SHOW, mixed $attributes = null, mixed $parent = null, boolean $allLevels = true )

Returns the count of all shares that $userid has access to.

Returns the count of all shares that $userid has access to.

Parameters

$userid
The userid of the user to check access for.
$perm
The level of permissions required.
$attributes
<p>Restrict the shares counted to those matching $attributes. An array of attribute/values pairs or a share owner username.</p>
$parent
<p>The share to start searching from (Horde_Share_Object, share_id, or null)</p>
$allLevels
<p>Return all levels, or just the direct children of $parent?</p>

Returns

integer
Number of shares the user has access to.

Throws

Horde_Share_Exception

Overrides

Horde_Share_Base::countShares()
public array
# listSystemShares( )

Returns an array of all system shares.

Returns an array of all system shares.

Returns

array
All system shares.

Overrides

Horde_Share_Base::listSystemShares()
public An
# getAcl( string $id )

Retrieve the Kolab specific access rights for a share.

Retrieve the Kolab specific access rights for a share.

Parameters

$id
The share ID.

Returns

An
array of rights.
public null
# setAcl( string $id, string $user, string $acl )

Set the Kolab specific access rights for a share.

Set the Kolab specific access rights for a share.

Parameters

$id
The share ID.
$user
The user to set the ACL for.
$acl
The ACL.

Returns

null
public null
# deleteAcl( string $id, string $user )

Delete Kolab specific access rights for a share.

Delete Kolab specific access rights for a share.

Parameters

$id
The share ID.
$user
The user to delete the ACL for

Returns

null
public null
# save( string $id, string $old_id, array $data )

Save share data to the storage backend.

Save share data to the storage backend.

Parameters

$id
The share id.
$old_id
The old share id.
$data
The share data.

Returns

null
Methods inherited from Horde_Share_Base
addCallback(), addShare(), exists(), expireListCache(), getApp(), getListCache(), getPermissions(), getPermsObject(), getShare(), getShareById(), getShares(), idExists(), initShareObject(), listAllShares(), listShares(), newShare(), removeShare(), renameShare(), resetCache(), runCallback(), setListCache(), setLogger(), setShareCallback(), setShareClass(), toDriverCharset()
Constants summary
integer VERSION
# 1
API documentation generated by ApiGen