yana

phpDocumentor v 1.4.0

Class plugin_search

Description

Search plugin
This plugin searches an index for words.
  • access: public
Plugin
   |
   --plugin_search
Method Summary

Methods

Create index file for search engine
bool search_create_index (
array $ARGS
)
List of parameters:
Name Type Description
$ARGS array array of params passed to the function
Description:
Type: primary Permission: 100 Templates:
parameters taken:
  • string $dir source directory
  • bool $recurse = false recurse sub-directories
  • bool $meta = false include meta-tags (title, keywords aso.)
  • access: public
Search index for a specific string
bool search_start (
array $ARGS
)
List of parameters:
Name Type Description
$ARGS array array of params passed to the function
Description:
Type: read Permission: 0 Templates:
parameters taken:
  • string target string to search for
  • access: public
Show table of statistics
bool search_stats (
array $ARGS
)
List of parameters:
Name Type Description
$ARGS array array of params passed to the function
Description:
this function does not expect any arguments
Type: read Permission: 0 Templates:
  • access: public
inherited from base classes

Inherited From Plugin

Documentation generated on Sat, 03 Jan 2009 22:22:41 +0100 by phpDocumentor 1.4.0

yana author: Thomas MeyerHomepage: www.yanaframework.net