PHP Class Phergie_Plugin_Php_Source_Local, phergie

Author: Phergie Development Team ([email protected])

Inheritance: implements Phergie_Plugin_Php_Source

Protected Properties

Property	Type	Description
$database	PDO	Local database for storage
$url	string	Source of the PHP function summary

Method	Description
__construct ( string $path ) : void	Constructor to initialize the data source.
findFunction ( string $function ) : array \| null	Searches for a description of the function.

Method	Description
buildDatabase ( boolean $rebuild = false ) : void	Build the database and parses the function summary file into it.

Constructor to initialize the data source.

public __construct ( string $path ) : void
$path	string	Path to the SQLite database to use
return	void

Build the database and parses the function summary file into it.

protected buildDatabase ( boolean $rebuild = false ) : void
$rebuild	boolean	TRUE to force a rebuild of the table used to house function information, FALSE otherwise, defaults to FALSE
return	void

Searches for a description of the function.

public findFunction ( string $function ) : array \| null
$function	string	Search pattern to match against the function name, wildcards supported using %
return	array \| null	Associative array containing the function name and description or NULL if no results are found

Local database for storage

protected PDO $database
return	PDO

Source of the PHP function summary

protected string $url
return	string