(no version information, might be only in CVS)

SwishSearch->setStructure -- Set the structure flag in the search object


void SwishSearch->setStructure ( int structure )


This function is EXPERIMENTAL. The behaviour of this function, the name of this function, and anything else documented about this function may change without notice in a future release of PHP. Use this function at your own risk.



The structure flag a bitmask is used to limit search to certain parts of HTML documents (like title, meta, body etc.). Its possible values are listed below. To combine several values use bitwise OR operator, see example below.

Return Values

No value is returned.


Example 1. Basic SwishSearch->setStructure() example



$swish = new Swish("index.swish-e");
$search = $swish->prepare();

$results = $search->execute("time");
"First query found: ", $results->hits, " hits\n";

$search->setStructure(Swish::IN_TITLE|Swish::IN_HEAD); //search in title and head
$results = $search->execute("time");
"Second query found: ", $results->hits, " hits\n";

$search->setStructure(Swish::IN_ALL); //search in whole document, the default value
$results = $search->execute("time");
"Third query found: ", $results->hits, " hits\n";

catch (SwishException $e) {
$e->getMessage(), "\n";


The above example will output something similar to:

First query found: 5 hits
Second query found: 0 hits
Third query found: 5 hits