[ Index ]

PHP Cross Reference of Moodle 1.9.3 [Build 15-Oct-2008]

title

Body

[close]

/search/ -> indexlib.php (summary)

Global Search Engine for Moodle

Author: Michael Champanis (mchampan) [cynnical@gmail.com], Valery Fremaux [valery.fremaux@club-internet.fr] > 1.8
License: http://www.gnu.org/copyleft/gpl.html GNU Public License
File Size: 259 lines (7 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 2 classes

IndexInfo:: (5 methods):
  __construct()
  valid()
  is_valid_dir()
  is_valid_db()
  __get()

IndexDBControl:: (4 methods):
  checkTableExists()
  checkDB()
  addDocument()
  delDocument()


Class: IndexInfo  - X-Ref

main class for searchable information in the Lucene index

__construct($path = SEARCH_INDEX_PATH)   X-Ref
No description

valid(&$err = null)   X-Ref
returns false on error, and the error message via referenced variable $err

param: array $err array of errors

is_valid_dir()   X-Ref
is the index dir valid


is_valid_db()   X-Ref
is the db table valid


__get($var)   X-Ref
shorthand get method for the class variables

param: object $var

Class: IndexDBControl  - X-Ref

DB Index control class

Used to control the search index database table
checkTableExists()   X-Ref
does the table exist?


checkDB()   X-Ref
is our database setup valid?


addDocument($document=null)   X-Ref
add a document record to the table

param: document must be a Lucene SearchDocument instance

delDocument($document)   X-Ref
remove a document record from the index

param: document must be a Lucene document instance, or at least a dbid enveloppe



Generated: Wed Jan 14 11:33:29 2009 Cross-referenced by PHPXref 0.7