PHPXRef 0.7.1 : phpBB-3.1.12-deutsch : Detail view of base.php

This file is part of the phpBB Forum Software package.

Copyright:	(c) phpBB Limited
License:	GNU General Public License, version 2 (GPL-2.0)
File Size:	292 lines (8 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 1 class

base:: (4 methods):
  search_backend()
  obtain_ids()
  save_ids()
  destroy_cache()

Class: base - X-Ref

optional base class for search plugins providing simple caching based on ACM
and functions to retrieve ignore_words and synonyms

search_backend(&$error) X-Ref

No description

obtain_ids($search_key, &$result_count, &$id_ary, &$start, $per_page, $sort_dir) X-Ref

Retrieves cached search results

param: string $search_key        an md5 string generated from all the passed search options to identify the results
param: int    &$result_count    will contain the number of all results for the search (not only for the current page)
param: array     &$id_ary         is filled with the ids belonging to the requested page that are stored in the cache
param: int     &$start            indicates the first index of the page
param: int     $per_page        number of ids each page is supposed to contain
param: string $sort_dir        is either a or d representing ASC and DESC
return: int SEARCH_RESULT_NOT_IN_CACHE or SEARCH_RESULT_IN_CACHE or SEARCH_RESULT_INCOMPLETE

save_ids($search_key, $keywords, $author_ary, $result_count, &$id_ary, $start, $sort_dir) X-Ref

Caches post/topic ids

param: string $search_key        an md5 string generated from all the passed search options to identify the results
param: string $keywords         contains the keywords as entered by the user
param: array    $author_ary        an array of author ids, if the author should be ignored during the search the array is empty
param: int     $result_count    contains the number of all results for the search (not only for the current page)
param: array    &$id_ary         contains a list of post or topic ids that shall be cached, the first element
param: int    $start            indicates the first index of the page
param: string $sort_dir        is either a or d representing ASC and DESC
return: null

destroy_cache($words, $authors = false) X-Ref

Removes old entries from the search results table and removes searches with keywords that contain a word in $words.

PHP Cross Reference of phpBB-3.1.12-deutsch

/phpbb/search/ -> base.php (summary)

Defines 1 class