| [ Index ] |
|
Code source de Horde 3.1.3 |
[Code source] [Imprimer] [Statistiques]
String of supported ACL rights.
| Poids: | 1485 lignes (54 kb) |
| Inclus ou requis: | 0 fois |
| Référencé: | 0 fois |
| Nécessite: | 0 fichiers |
Net_IMSP_Book:: (18 méthodes):
Net_IMSP_Book()
init()
getAddressBookList()
search()
getEntry()
createAddressBook()
deleteAddressBook()
renameAddressBook()
addEntry()
deleteEntry()
lockEntry()
unlockEntry()
setACL()
getACL()
deleteACL()
myRights()
setLogger()
_parseFetchAddressResponse()
Classe: Net_IMSP_Book - X-Ref
Net_IMSP_Book Class - provides api for dealing with IMSP| Net_IMSP_Book($params) X-Ref |
| Constructor function. param: array $params Hash containing IMSP parameters. |
| init() X-Ref |
| Initialization function to be called after object is returned. This allows errors to occur and not break the script. return: mixed True on success PEAR_Error on failure. |
| getAddressBookList() X-Ref |
| Returns an array containing the names of all the address books available to the logged in user. return: mixed Array of address book names or PEAR_Error. |
| search($abook, $search) X-Ref |
| Returns an array containing the names that match $search critera in the address book named $abook. param: string $abook Address book name to search. param: array $search Search criteria in the form of return: mixed Array of names of the entries that match or PEAR_Error. |
| getEntry($abook, $entryName) X-Ref |
| Returns an associative array of a single address book entry. Note that there will always be a 'name' field. param: string $abook Name of the address book to search. param: string $entryName 'name' attribute of the entry to retrieve return: mixed Array containing entry or PEAR_Error on failure / no match. |
| createAddressBook($abookName) X-Ref |
| Creates a new address book. param: string $abookName FULLY QUALIFIED name such 'jdoe.clients' etc... return: mixed True on success / PEAR_Error on failure. |
| deleteAddressBook($abookName) X-Ref |
| Deletes an address book completely! param: string $abookName Name of address book to delete. return: mixed true on success / PEAR_Error on failure |
| renameAddressBook($abookOldName, $abookNewName) X-Ref |
| Renames an address book. param: string $abookOldName Old name. param: string $abookNewName New address book name. return: mixed True / PEAR_Error |
| addEntry($abook, $entryInfo) X-Ref |
| Adds an address book entry to an address book. param: string $abook Name of address book to add entry to. param: array $entryInfo Address book entry information - return: mixed True on success / PEAR_Error on failure. |
| deleteEntry($abook, $bookEntry) X-Ref |
| Deletes an abook entry. param: string $abook Name of address book containing entry. param: string $bookEntry Name of entry to delete. return: mixed True on success / PEAR_Error on failure. |
| lockEntry($abook, $bookEntry) X-Ref |
| Attempts to acquire a semaphore on the address book entry. param: string $abook Address book name param: string $bookEntry Name of entry to lock return: mixed true or array on success and PEAR_Error on failure |
| unlockEntry($abook, $bookEntry) X-Ref |
| Unlocks a previously locked address book. param: string $abook Name of address book containing locked entry. param: string $bookEntry Name of entry to unlock. return: mixed True on success, PEAR_Error on failure. |
| setACL($abook, $ident, $acl) X-Ref |
| Sets an Access Control List for an abook. param: string $abook Name of address book. param: string $ident Name of user for this acl. param: string $acl acl for this user/book. return: mixed True on success / PEAR_Error on failure. |
| getACL($abook) X-Ref |
| Retrieves an address book's ACL. param: string $abook Name of address book to retrieve acl for. return: mixed array containing acl for every user with access to |
| deleteACL($abook, $ident) X-Ref |
| Deletes an ACL entry for an address book. param: string $abook Name of the address book. param: string $ident Name of entry to remove acl for. return: mixed true on success, PEAR_Error on failure. |
| myRights($abook) X-Ref |
| Returns an ACL string containing the rights for the current user param: string $abook Name of address book to retrieve acl. return: mixed acl of current user or PEAR_Error on failure. |
| setLogger($params) X-Ref |
| Sets the log information in the Net_IMSP object. param: array Log parameters. return: mixed True on success PEAR_Error on failure. |
| _parseFetchAddressResponse($server_response) X-Ref |
| Parses a IMSP fetchaddress response text string into key-value pairs param: string $server_response The raw fetchaddress response. return: array Address book entry information as key=>value pairs. |
| Généré le : Sun Feb 25 18:01:28 2007 | par Balluche grâce à PHPXref 0.7 |