File/program/modules/crew/crew_search.php

Description

/program/modules/crew/crew_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 crew_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
crew_search (line 51)

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

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

  • return: FALSE on failure, TRUE on success and $hits, $results updated (maybe)
  • todo: should we take status=0 into account too (individual entry to the workshop)? it looks like a lot of effort for a low yield
bool|array crew_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:09:01 +0200 by phpDocumentor 1.4.0