<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Set the structure flag in the search object</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="swishsearch.setsort.html">SwishSearch::setSort</a></div>
<div class="next" style="text-align: right; float: right;"><a href="refs.utilspec.server.html">Server Specific Extensions</a></div>
<div class="up"><a href="ref.swish.html">Swish Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="swishsearch.setstructure" class="refentry">
<div class="refnamediv">
<h1 class="refname">SwishSearch::setStructure</h1>
<p class="verinfo">(PECL swish >= 0.1.0)</p><p class="refpurpose"><span class="refname">SwishSearch::setStructure</span> — <span class="dc-title">Set the structure flag in the search object</span></p>
</div>
<div class="refsect1 description" id="refsect1-swishsearch.setstructure-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type"><span class="type void">void</span></span> <span class="methodname"><strong>SwishSearch::setStructure</strong></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$structure</code></span>
)</div>
<div class="warning"><strong class="warning">Warning</strong><p class="simpara">This function is
<em class="emphasis">EXPERIMENTAL</em>. The behaviour of this function, its name, and
surrounding documentation may change without notice in a future release of PHP.
This function should be used at your own risk.
</p></div>
</div>
<div class="refsect1 parameters" id="refsect1-swishsearch.setstructure-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">structure</code></em></span>
<dd>
<p class="para">
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.
</p>
</dd>
</dt>
</dl>
</p>
<p class="para">
<ul class="itemizedlist">
<li class="listitem">
<p class="para">
<strong><code>Swish::IN_FILE</code></strong>
</p>
</li>
<li class="listitem">
<p class="para">
<strong><code>Swish::IN_TITLE</code></strong>
</p>
</li>
<li class="listitem">
<p class="para">
<strong><code>Swish::IN_HEAD</code></strong>
</p>
</li>
<li class="listitem">
<p class="para">
<strong><code>Swish::IN_BODY</code></strong>
</p>
</li>
<li class="listitem">
<p class="para">
<strong><code>Swish::IN_COMMENTS</code></strong>
</p>
</li>
<li class="listitem">
<p class="para">
<strong><code>Swish::IN_HEADER</code></strong>
</p>
</li>
<li class="listitem">
<p class="para">
<strong><code>Swish::IN_EMPHASIZED</code></strong>
</p>
</li>
<li class="listitem">
<p class="para">
<strong><code>Swish::IN_META</code></strong>
</p>
</li>
</ul>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-swishsearch.setstructure-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
No value is returned.
</p>
</div>
<div class="refsect1 examples" id="refsect1-swishsearch.setstructure-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4748">
<p><strong>Example #1 Basic <span class="function"><strong>SwishSearch::setStructure()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br /></span><span style="color: #007700">try {<br /><br /> </span><span style="color: #0000BB">$swish </span><span style="color: #007700">= new </span><span style="color: #0000BB">Swish</span><span style="color: #007700">(</span><span style="color: #DD0000">"index.swish-e"</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$search </span><span style="color: #007700">= </span><span style="color: #0000BB">$swish</span><span style="color: #007700">-></span><span style="color: #0000BB">prepare</span><span style="color: #007700">();<br /><br /> </span><span style="color: #0000BB">$results </span><span style="color: #007700">= </span><span style="color: #0000BB">$search</span><span style="color: #007700">-></span><span style="color: #0000BB">execute</span><span style="color: #007700">(</span><span style="color: #DD0000">"time"</span><span style="color: #007700">);<br /> echo </span><span style="color: #DD0000">"First query found: "</span><span style="color: #007700">, </span><span style="color: #0000BB">$results</span><span style="color: #007700">-></span><span style="color: #0000BB">hits</span><span style="color: #007700">, </span><span style="color: #DD0000">" hits\n"</span><span style="color: #007700">;<br /><br /> </span><span style="color: #0000BB">$search</span><span style="color: #007700">-></span><span style="color: #0000BB">setStructure</span><span style="color: #007700">(</span><span style="color: #0000BB">Swish</span><span style="color: #007700">::</span><span style="color: #0000BB">IN_TITLE</span><span style="color: #007700">|</span><span style="color: #0000BB">Swish</span><span style="color: #007700">::</span><span style="color: #0000BB">IN_HEAD</span><span style="color: #007700">); </span><span style="color: #FF8000">//search in title and head<br /> </span><span style="color: #0000BB">$results </span><span style="color: #007700">= </span><span style="color: #0000BB">$search</span><span style="color: #007700">-></span><span style="color: #0000BB">execute</span><span style="color: #007700">(</span><span style="color: #DD0000">"time"</span><span style="color: #007700">);<br /> echo </span><span style="color: #DD0000">"Second query found: "</span><span style="color: #007700">, </span><span style="color: #0000BB">$results</span><span style="color: #007700">-></span><span style="color: #0000BB">hits</span><span style="color: #007700">, </span><span style="color: #DD0000">" hits\n"</span><span style="color: #007700">;<br /><br /> </span><span style="color: #0000BB">$search</span><span style="color: #007700">-></span><span style="color: #0000BB">setStructure</span><span style="color: #007700">(</span><span style="color: #0000BB">Swish</span><span style="color: #007700">::</span><span style="color: #0000BB">IN_ALL</span><span style="color: #007700">); </span><span style="color: #FF8000">//search in whole document, the default value<br /> </span><span style="color: #0000BB">$results </span><span style="color: #007700">= </span><span style="color: #0000BB">$search</span><span style="color: #007700">-></span><span style="color: #0000BB">execute</span><span style="color: #007700">(</span><span style="color: #DD0000">"time"</span><span style="color: #007700">);<br /> echo </span><span style="color: #DD0000">"Third query found: "</span><span style="color: #007700">, </span><span style="color: #0000BB">$results</span><span style="color: #007700">-></span><span style="color: #0000BB">hits</span><span style="color: #007700">, </span><span style="color: #DD0000">" hits\n"</span><span style="color: #007700">;<br /><br />} catch (</span><span style="color: #0000BB">SwishException $e</span><span style="color: #007700">) {<br /> echo </span><span style="color: #0000BB">$e</span><span style="color: #007700">-></span><span style="color: #0000BB">getMessage</span><span style="color: #007700">(), </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br />}<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
First query found: 5 hits
Second query found: 0 hits
Third query found: 5 hits
</pre></div>
</div>
</div>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="swishsearch.setsort.html">SwishSearch::setSort</a></div>
<div class="next" style="text-align: right; float: right;"><a href="refs.utilspec.server.html">Server Specific Extensions</a></div>
<div class="up"><a href="ref.swish.html">Swish Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
