Overview

Packages

  • Auth
  • Core
  • Horde
    • Imsp
  • None
  • Notification

Classes

  • Horde_Core_Imsp_Utils
  • Overview
  • Package
  • Class
  • Tree

Class Horde_Core_Imsp_Utils

Horde_Imsp_Utils::

Copyright 2003-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.

Package: Horde\Imsp
Author: Michael Rubinsky mrubinsk@horde.org
Located at Horde/Core/Imsp/Utils.php
Methods summary
public static array
# getAllBooks( array $serverInfo )

Utility function to retrieve the names of all the address books that the user has access to, along with the acl for those books. For information about the $serverInfo array see turba/config/sources.php as this is the cfgSources[] entry for the address books.

Utility function to retrieve the names of all the address books that the user has access to, along with the acl for those books. For information about the $serverInfo array see turba/config/sources.php as this is the cfgSources[] entry for the address books.

Parameters

$serverInfo
<p>Information about the server and the current user.</p>

Returns

array
Information about all the address books or PEAR_Error.
public static mixed
# createBook( array $source, string $newName )

Utility function to help clients create new address books without having to create an imsp driver instance first.

Utility function to help clients create new address books without having to create an imsp driver instance first.

Parameters

$source
<p>Information about the user's default IMSP address book.</p>
$newName
The name of the new address book.

Returns

mixed
true on success or PEAR_Error on failure.
public mixed
# synchShares( Horde_Share $share_obj, array $serverInfo )

Synchronize Horde_Shares to existing IMSP address books.

Synchronize Horde_Shares to existing IMSP address books.

Parameters

$share_obj
The Horde_Share object to use.
$serverInfo
<p>Information about the IMSP server and the current user.</p>

Returns

mixed
Array describing any shares added or removed | PEAR_Error.
public static string
# permsToACL( integer $perms )

Translates Horde_Share permissions into IMSP acl.

Translates Horde_Share permissions into IMSP acl.

Parameters

$perms
Horde_Perms style permission bitmask.

Returns

string
An IMSP acl string
public static mixed
# setACL( string $params, string $book, string $name, mixed $acl )

Set's an address book's acl on the IMSP server.

Set's an address book's acl on the IMSP server.

Parameters

$params
$book The address book name to set
$book
$name The user name to set for.
$name
$acl The acl string to set.
$acl

Returns

mixed
True | Pear_Error
API documentation generated by ApiGen