PHP Class Horde_Core_Ajax_Imple_ContactAutoCompleter, horde

Author: Michael Slusarz ([email protected])
Inheritance: extends Horde_Core_Ajax_Imple_AutoCompleter
Mostra file Open project: horde/horde Class Usage Examples

Public Methods

Method Description
getAddressList ( string $str = '', array $opts = [] ) : Horde_Mail_Rfc822_List Uses the Registry to expand names.

Protected Methods

Method Description
_getAddressbookSearchParams ( ) : object Return search parameters necessary to do a contacts API search.
_getAutoCompleter ( )
_getAutoCompleterParams ( ) : array Return the basic autocompleter parameters.
_handleAutoCompleter ( $input )

Method Details

_getAddressbookSearchParams() abstract protected method

Return search parameters necessary to do a contacts API search.
abstract protected _getAddressbookSearchParams ( ) : object
return object Object with these properties: - fields: TODO - sources: TODO

_getAutoCompleter() protected method

protected _getAutoCompleter ( )

_getAutoCompleterParams() protected method

Return the basic autocompleter parameters.
protected _getAutoCompleterParams ( ) : array
return array Autocompleter parameters.

_handleAutoCompleter() protected method

protected _handleAutoCompleter ( $input )

getAddressList() public method

This function will not search if the address string is empty.
public getAddressList ( string $str = '', array $opts = [] ) : Horde_Mail_Rfc822_List
$str string The name(s) or address(es) to expand.
$opts array Additional options: - levenshtein: (boolean) Do levenshtein sorting, - count_only: (boolean) Only return the count of results.
return Horde_Mail_Rfc822_List Expand results.