Class Net_IMSP_Book

Description

Net_IMSP_Book Class - provides api for dealing with IMSP address books.

Required parameters:

   'username'     Username to logon to IMSP server as.
   'password'     Password for current user.
   'auth_method'  The authentication method to use to login.
   'server'       The hostname of the IMSP server.
   'port'         The port of the IMSP server.

$Horde: framework/Net_IMSP/IMSP/Book.php,v 1.16.2.28 2009/10/01 23:44:21 mrubinsk Exp $

Copyright 2002-2009 The Horde Project (http://www.horde.org/)

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.

Located in /Net_IMSP/IMSP/Book.php (line 31)


	
			
Variable Summary
 string $sort
 array $_params
Method Summary
 Net_IMSP_Book Net_IMSP_Book (array $params)
 mixed addEntry (string $abook, array $entryInfo)
 mixed createAddressBook (string $abookName)
 mixed deleteACL (string $abook, string $ident)
 mixed deleteAddressBook (string $abookName)
 mixed deleteEntry (string $abook, string $bookEntry)
 mixed getACL (string $abook)
 mixed getEntry (string $abook, string $entryName)
 mixed init ()
 mixed lockEntry (string $abook, string $bookEntry)
 mixed myRights (string $abook)
 mixed renameAddressBook (string $abookOldName, string $abookNewName)
 mixed search (string $abook, array $search)
 mixed setACL (string $abook, string $ident, string $acl)
 mixed setLogger (array $params)
 mixed unlockEntry (string $abook, string $bookEntry)
Variables
string $sort = 'ascend' (line 38)

Sort order.

Net_IMSP $_imsp (line 45)

Net_IMSP object.

array $_params (line 52)

Parameter list.

Methods
Constructor Net_IMSP_Book (line 59)

Constructor function.

Net_IMSP_Book Net_IMSP_Book (array $params)
  • array $params: Hash containing IMSP parameters.
addEntry (line 598)

Adds an address book entry to an address book.

  • return: True on success / PEAR_Error on failure.
mixed addEntry (string $abook, array $entryInfo)
  • string $abook: Name of address book to add entry to.
  • array $entryInfo: Address book entry information - there MUST be a field 'name' containing the entry name.
createAddressBook (line 398)

Creates a new address book.

  • return: True on success / PEAR_Error on failure.
mixed createAddressBook (string $abookName)
  • string $abookName: FULLY QUALIFIED name such 'jdoe.clients' etc...
deleteACL (line 1142)

Deletes an ACL entry for an address book.

  • return: true on success, PEAR_Error on failure.
mixed deleteACL (string $abook, string $ident)
  • string $abook: Name of the address book.
  • string $ident: Name of entry to remove acl for.
deleteAddressBook (line 461)

Deletes an address book completely!

  • return: true on success / PEAR_Error on failure
mixed deleteAddressBook (string $abookName)
  • string $abookName: Name of address book to delete.
deleteEntry (line 733)

Deletes an abook entry.

  • return: True on success / PEAR_Error on failure.
mixed deleteEntry (string $abook, string $bookEntry)
  • string $abook: Name of address book containing entry.
  • string $bookEntry: Name of entry to delete.
getACL (line 1045)

Retrieves an address book's ACL.

  • return: array containing acl for every user with access to address book or PEAR_Error on failure.
mixed getACL (string $abook)
  • string $abook: Name of address book to retrieve acl for.
getAddressBookList (line 91)

Returns an array containing the names of all the address books available to the logged in user.

  • return: Array of address book names or PEAR_Error.
mixed getAddressBookList ()
getEntry (line 314)

Returns an associative array of a single address book entry.

Note that there will always be a 'name' field.

  • return: Array containing entry or PEAR_Error on failure / no match.
mixed getEntry (string $abook, string $entryName)
  • string $abook: Name of the address book to search.
  • string $entryName: 'name' attribute of the entry to retrieve
init (line 70)

Initialization function to be called after object is returned.

This allows errors to occur and not break the script.

  • return: True on success PEAR_Error on failure.
mixed init ()
lockEntry (line 801)

Attempts to acquire a semaphore on the address book entry.

  • return: true or array on success and PEAR_Error on failure (server depending)
mixed lockEntry (string $abook, string $bookEntry)
  • string $abook: Address book name
  • string $bookEntry: Name of entry to lock
myRights (line 1208)

Returns an ACL string containing the rights for the current user

  • return: acl of current user or PEAR_Error on failure.
mixed myRights (string $abook)
  • string $abook: Name of address book to retrieve acl.
renameAddressBook (line 525)

Renames an address book.

  • return: True / PEAR_Error
mixed renameAddressBook (string $abookOldName, string $abookNewName)
  • string $abookOldName: Old name.
  • string $abookNewName: New address book name.
search (line 164)

Returns an array containing the names that match $search critera in the address book named $abook.

  • return: Array of names of the entries that match or PEAR_Error.
mixed search (string $abook, array $search)
  • string $abook: Address book name to search.
  • array $search: Search criteria in the form of 'fieldName' => 'searchTerm' (may include * wild card).
setACL (line 968)

Sets an Access Control List for an abook.

  • return: True on success / PEAR_Error on failure.
mixed setACL (string $abook, string $ident, string $acl)
  • string $abook: Name of address book.
  • string $ident: Name of user for this acl.
  • string $acl: acl for this user/book.
setLogger (line 1293)

Sets the log information in the Net_IMSP object.

  • return: True on success PEAR_Error on failure.
mixed setLogger (array $params)
  • array $params: Log parameters.
unlockEntry (line 884)

Unlocks a previously locked address book.

  • return: True on success, PEAR_Error on failure.
mixed unlockEntry (string $abook, string $bookEntry)
  • string $abook: Name of address book containing locked entry.
  • string $bookEntry: Name of entry to unlock.

Documentation generated on Sun, 30 Jan 2011 05:15:35 +0000 by phpDocumentor 1.4.3