File/program/modules/confab/confab_search.php

Description

/program/modules/confab/confab_search.php - interface to the search-part of this module

This file defines the interface with this module for searching content. The interface consists of a (temporary) table and this function:

    bool confab_search(&$hits,&$results,$qwords, $limit, $offset)

The function is called whenever module content is to be searched. At that point the helper table, which is called 'search_nodes', exists and is populated.

Functions
confab_search (line 55)

search this module's content in selected nodes for keywords in $qwords

This interface is documented in htmlpage_search() in htmlpage_search.php.

this module requires an extra where clause to select only those confabs that are open for registered users (status = 1) or open for anyone (status = 2). this does NOT mean that conversations can be searched (they can't) but either way the header/introduction/footer can be searched. Only if status=0 there cannot be any results because there is just a message 'this confab closed'.

  • return: FALSE on failure, TRUE on success and $hits, $results updated (maybe)
bool|array confab_search (array &$hits, int &$results, array $qwords, int $limit, [int $offset = 0])
  • array &$hits: receives search results (at most $limit)
  • int &$results: receives number of hits (negative value on entry means (re-)calculate total)
  • array $qwords: holds 1 or more keywords to search for (original, utf8lower, quoted)
  • int $limit: maximum number of hits to return (could be 0)
  • int $offset: starting point within this module for returning results

Documentation generated on Tue, 28 Jun 2016 19:08:43 +0200 by phpDocumentor 1.4.0