Go to the first, previous, next, last section, table of contents.

Hook search (hook_search)

`Description'

Search the full text database coupled with the SQL database and display the records found. The query is built following the instructions found in the configuration file, See section Hook Fulcrum configuration file.

`Template file'

See section hook_search.html.

`Parameters'

`context (mandatory, hook_search)'

`query_text (optional)'

The query typed by the user.

`query_flexion (optional)'

The possible values are:

• French
• none

If the value of this parameter is null or set to none, the words from the user question are used verbatim. If the value of this parameter is set to French, the words from the question are transformed according to the rules of the French language for plural and conjugation. The resulting list of words is searched instead of the original word.

`query_expand (optional)'

The possible values are:

• or
• and
• phrase

If the value of this parameter is null, the question is rephrased to express that we are much interested to find the records that match the question exactly; still quite interested to find the records that match all the words of the question, even if they are scattered over the text; less interested by the documents that contain at least one word from the question but not all of them. If the value of this parameter is or, we are equally interested by all the records that contain at least one word from the question. If the value of this parameter is and, we are only interested by the records that contain all the words from the question, even if they are scattered over the text. If the value of this parameter is phrase, we are only interested by the records that contain the exact phrase that we wrote as a question, each word in order.

`query_<fulcrum fieldname> (optional)'

Each of these parameters must be built with a valid fulcrum fieldname as defined in the configuration file, See section Hook Fulcrum configuration file. The value associated with this parameter is called a constraint and is handled in the following way: In each group that list this field, the records will only match if the field contains the listed value. In each group that does not list this field, the records will only match if at least one of the listed fields contain the value.

Go to the first, previous, next, last section, table of contents.