PHP Класс Horde_Imsp_Book, horde

Copyright 2002-2016 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.
Автор: Michael J Rubinsky ([email protected])
Показать файл Открыть проект

Открытые свойства

Свойство Тип Описание
$sort string Sort order.

Защищенные свойства (Protected)

Свойство Тип Описание
$_imsp Horde_Imsp_Client_Base Horde_Imsp_Client object.
$_params array Parameter list.

Открытые методы

Метод Описание
__construct ( Horde_Imsp_Client_Base $client, array $params ) Constructor function.
addEntry ( string $abook, array $entryInfo ) Adds an address book entry to an address book.
createAddressBook ( string $abookName ) Creates a new address book.
deleteACL ( string $abook, string $ident ) Deletes an ACL entry for an address book.
deleteAddressBook ( string $abookName ) Deletes an address book completely!
deleteEntry ( string $abook, string $bookEntry ) Deletes an abook entry.
getACL ( string $abook ) : mixed Retrieves an address book's ACL.
getAddressBookList ( ) : mixed Returns an array containing the names of all the address books available to the logged in user.
getEntry ( string $abook, string $entryName ) : array Returns an associative array of a single address book entry.
lockEntry ( string $abook, string $bookEntry ) : mixed Attempts to acquire a semaphore on the address book entry.
myRights ( string $abook ) : mixed Returns an ACL string containing the rights for the current user
renameAddressBook ( string $abookOldName, string $abookNewName ) Renames an address book.
search ( string $abook, mixed $search ) : array Returns an array containing the names that match $search critera in the address book named $abook.
setACL ( string $abook, string $ident, string $acl ) : mixed Sets an Access Control List for an abook.
unlockEntry ( string $abook, string $bookEntry ) Unlocks a previously locked address book.

Защищенные методы

Метод Описание
_parseFetchAddressResponse ( string $server_response ) : array Parses a IMSP fetchaddress response text string into key-value pairs

Описание методов

__construct() публичный Метод

Constructor function.
public __construct ( Horde_Imsp_Client_Base $client, array $params )
$client Horde_Imsp_Client_Base
$params array Hash containing IMSP parameters.

_parseFetchAddressResponse() защищенный Метод

Parses a IMSP fetchaddress response text string into key-value pairs
protected _parseFetchAddressResponse ( string $server_response ) : array
$server_response string The raw fetchaddress response.
Результат array Address book entry information as key=>value pairs.

addEntry() публичный Метод

Adds an address book entry to an address book.
public addEntry ( string $abook, array $entryInfo )
$abook string Name of address book to add entry to.
$entryInfo array Address book entry information - there MUST be a field 'name' containing the entry name.

createAddressBook() публичный Метод

Creates a new address book.
public createAddressBook ( string $abookName )
$abookName string FULLY QUALIFIED name such 'jdoe.clients' etc...

deleteACL() публичный Метод

Deletes an ACL entry for an address book.
public deleteACL ( string $abook, string $ident )
$abook string Name of the address book.
$ident string Name of entry to remove acl for.

deleteAddressBook() публичный Метод

Deletes an address book completely!
public deleteAddressBook ( string $abookName )
$abookName string Name of address book to delete.

deleteEntry() публичный Метод

Deletes an abook entry.
public deleteEntry ( string $abook, string $bookEntry )
$abook string Name of address book containing entry.
$bookEntry string Name of entry to delete.

getACL() публичный Метод

Retrieves an address book's ACL.
public getACL ( string $abook ) : mixed
$abook string Name of address book to retrieve acl for.
Результат mixed array containing acl for every user with access to address book or PEAR_Error on failure.

getAddressBookList() публичный Метод

Returns an array containing the names of all the address books available to the logged in user.
public getAddressBookList ( ) : mixed
Результат mixed Array of address book names

getEntry() публичный Метод

Note that there will always be a 'name' field.
public getEntry ( string $abook, string $entryName ) : array
$abook string Name of the address book to search.
$entryName string 'name' attribute of the entry to retrieve
Результат array Array containing entry.

lockEntry() публичный Метод

Attempts to acquire a semaphore on the address book entry.
public lockEntry ( string $abook, string $bookEntry ) : mixed
$abook string Address book name
$bookEntry string Name of entry to lock
Результат mixed true or array on success (depends on server in use).

myRights() публичный Метод

Returns an ACL string containing the rights for the current user
public myRights ( string $abook ) : mixed
$abook string Name of address book to retrieve acl.
Результат mixed acl of current user.

renameAddressBook() публичный Метод

Renames an address book.
public renameAddressBook ( string $abookOldName, string $abookNewName )
$abookOldName string Old name.
$abookNewName string New address book name.

setACL() публичный Метод

Sets an Access Control List for an abook.
public setACL ( string $abook, string $ident, string $acl ) : mixed
$abook string Name of address book.
$ident string Name of user for this acl.
$acl string acl for this user/book.
Результат mixed True on success / PEAR_Error on failure.

unlockEntry() публичный Метод

Unlocks a previously locked address book.
public unlockEntry ( string $abook, string $bookEntry )
$abook string Name of address book containing locked entry.
$bookEntry string Name of entry to unlock.

Описание свойств

$_imsp защищенное свойство

Horde_Imsp_Client object.
protected Horde_Imsp_Client_Base $_imsp
Результат Horde_Imsp_Client_Base

$_params защищенное свойство

Parameter list.
protected array $_params
Результат array

$sort публичное свойство

Sort order.
public string $sort
Результат string