Hoa central
Public Member Functions | List of all members
Hoa\Console\Readline\Autocompleter\Autocompleter Interface Reference
Inheritance diagram for Hoa\Console\Readline\Autocompleter\Autocompleter:

Public Member Functions

 complete (&$prefix)
 
 getWordDefinition ()
 

Detailed Description

Interface .

Interface for all auto-completers.

Definition at line 49 of file Autocompleter.php.

Member Function Documentation

Hoa\Console\Readline\Autocompleter\Autocompleter::complete ( $prefix)

Complete a word. Returns null for no word, a full-word or an array of full-words.

Parameters
string&$prefixPrefix to autocomplete.
Returns
mixed

Implemented in Hoa\Console\Readline\Autocompleter\Path, Hoa\Console\Readline\Autocompleter\Aggregate, and Hoa\Console\Readline\Autocompleter\Word.

Hoa\Console\Readline\Autocompleter\Autocompleter::getWordDefinition ( )

Get definition of a word. Example: +. PCRE delimiters and options must not be provided.

Returns
string

Implemented in Hoa\Console\Readline\Autocompleter\Path, Hoa\Console\Readline\Autocompleter\Aggregate, and Hoa\Console\Readline\Autocompleter\Word.


The documentation for this interface was generated from the following file: