XOOPS  2.6.0
SearchPluginInterface Interface Reference

Public Member Functions

 search ($queries, $andor, $limit, $start, $uid)
 

Detailed Description

Author
trabis lusop.nosp@m.oema.nosp@m.s@gma.nosp@m.il.c.nosp@m.om

Definition at line 18 of file interface.php.

Member Function Documentation

SearchPluginInterface::search (   $queries,
  $andor,
  $limit,
  $start,
  $uid 
)

search method

Parameters
string[]$queries search term strings
string$andor$queries relation, either 'AND' or 'OR'
int$limitmaximum number of matches to return
int$startoffset in full set of matches
type$uiduser id to limit search
Returns
array of items matching criteria Each item is an associative array with the following keys: 'title' => result title 'content' => content preview 'link' => url to full content 'time' => unix timestamp of item 'uid' => associated user id 'image' => icon to display by result
Todo:
the result item should be a defined object

The documentation for this interface was generated from the following file: