SunshinePHP 2016


(PECL swish >= 0.1.0)

SwishSearch::setStructureSet the structure flag in the search object


void SwishSearch::setStructure ( int $structure )

Esta função é EXPERIMENTAL. O comportamento, seu nome e documentação podem mudar sem aviso em futuras versões do PHP. Utilize por sua própria conta e risco.



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.

  • Swish::IN_FILE

  • Swish::IN_TITLE

  • Swish::IN_HEAD

  • Swish::IN_BODY

  • Swish::IN_COMMENTS

  • Swish::IN_HEADER


  • Swish::IN_META

Valor Retornado

Não há valor retornado.


Exemplo #1 Basic SwishSearch::setStructure() example


try {

$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";


O exemplo acima irá imprimir algo similar à:

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

add a note add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top