• 홈
  • Horde_Imsp_Book

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])
파일 보기 프로젝트 열기: horde/horde

공개 프로퍼티들

프로퍼티 타입 설명
$sort string Sort order.

보호된 프로퍼티들

프로퍼티 타입 설명
$_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