[ Index ]

PHP Cross Reference of DokuWiki

title

Body

[close]

/inc/ -> fulltext.php (summary)

DokuWiki fulltextsearch functions using the index

Author: Andreas Gohr
License: GPL 2 (http://www.gnu.org/licenses/gpl.html)
File Size: 755 lines (26 kb)
Included or required: 2 times
Referenced: 0 times
Includes or requires: 0 files

Defines 15 functions

  ft_pageSearch()
  _ft_pageSearch()
  ft_backlinks()
  ft_mediause()
  ft_pageLookup()
  _ft_pageLookup()
  _ft_pageLookupTitleCompare()
  ft_pagesorter()
  ft_snippet()
  ft_snippet_re_preprocess()
  ft_resultCombine()
  ft_resultUnite()
  ft_resultComplement()
  ft_queryParser()
  ft_termParser()

Functions
Functions that are not part of a class:

ft_pageSearch($query,&$highlight)   X-Ref
The fulltext search

Returns a list of matching documents for the given query

refactored into ft_pageSearch(), _ft_pageSearch() and trigger_event()


_ft_pageSearch(&$data)   X-Ref
Returns a list of matching documents for the given query

author: Andreas Gohr <andi@splitbrain.org>
author: Kazutaka Miyasaka <kazmiya@gmail.com>

ft_backlinks($id)   X-Ref
Returns the backlinks for a given page

Uses the metadata index.

ft_mediause($id,$max)   X-Ref
Returns the pages that use a given media file

Does a quick lookup with the fulltext index, then
evaluates the instructions of the found pages

Aborts after $max found results

ft_pageLookup($id, $in_ns=false, $in_title=false)   X-Ref
Quicksearch for pagenames

By default it only matches the pagename and ignores the
namespace. This can be changed with the second parameter.
The third parameter allows to search in titles as well.

The function always returns titles as well

author: Andreas Gohr <andi@splitbrain.org>
author: Adrian Lang <lang@cosmocode.de>
triggers: SEARCH_QUERY_PAGELOOKUP

_ft_pageLookup(&$data)   X-Ref
No description

_ft_pageLookupTitleCompare($search, $title)   X-Ref
Tiny helper function for comparing the searched title with the title
from the search index. This function is a wrapper around stripos with
adapted argument order and return value.


ft_pagesorter($a, $b)   X-Ref
Sort pages based on their namespace level first, then on their string
values. This makes higher hierarchy pages rank higher than lower hierarchy
pages.


ft_snippet($id,$highlight)   X-Ref
Creates a snippet extract

author: Andreas Gohr <andi@splitbrain.org>
triggers: FULLTEXT_SNIPPET_CREATE

ft_snippet_re_preprocess($term)   X-Ref
Wraps a search term in regex boundary checks.


ft_resultCombine($args)   X-Ref
Combine found documents and sum up their scores

This function is used to combine searched words with a logical
AND. Only documents available in all arrays are returned.

based upon PEAR's PHP_Compat function for array_intersect_key()

param: array $args An array of page arrays

ft_resultUnite($args)   X-Ref
Unites found documents and sum up their scores

based upon ft_resultCombine() function

author: Kazutaka Miyasaka <kazmiya@gmail.com>
param: array $args An array of page arrays

ft_resultComplement($args)   X-Ref
Computes the difference of documents using page id for comparison

nearly identical to PHP5's array_diff_key()

author: Kazutaka Miyasaka <kazmiya@gmail.com>
param: array $args An array of page arrays

ft_queryParser($Indexer, $query)   X-Ref
Parses a search query and builds an array of search formulas

author: Andreas Gohr <andi@splitbrain.org>
author: Kazutaka Miyasaka <kazmiya@gmail.com>

ft_termParser($Indexer, $term, $consider_asian = true, $phrase_mode = false)   X-Ref
Transforms given search term into intermediate representation

This function is used in ft_queryParser() and not for general purpose use.

author: Kazutaka Miyasaka <kazmiya@gmail.com>



Generated: Wed May 23 03:00:10 2012 Cross-referenced by PHPXref 0.7
WikiForumIRCBugsGitXRefTranslate