<!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>Get the list of properties for the index</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="swish.getmetalist.html">Swish::getMetaList</a></div> <div class="next" style="text-align: right; float: right;"><a href="swish.prepare.html">Swish::prepare</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="swish.getpropertylist" class="refentry"> <div class="refnamediv"> <h1 class="refname">Swish::getPropertyList</h1> <p class="verinfo">(PECL swish >= 0.1.0)</p><p class="refpurpose"><span class="refname">Swish::getPropertyList</span> — <span class="dc-title">Get the list of properties for the index</span></p> </div> <div class="refsect1 description" id="refsect1-swish.getpropertylist-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">array</span> <span class="methodname"><strong>Swish::getPropertyList</strong></span> ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$index_name</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-swish.getpropertylist-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><em><code class="parameter">index_name</code></em></span> <dd> <p class="para"> The name of the index file. </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-swish.getpropertylist-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns an array of properties for the given index. </p> </div> <div class="refsect1 examples" id="refsect1-swish.getpropertylist-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-4736"> <p><strong>Example #1 Basic <span class="function"><strong>Swish::getPropertyList()</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">$properties </span><span style="color: #007700">= </span><span style="color: #0000BB">$swish</span><span style="color: #007700">-></span><span style="color: #0000BB">getPropertyList</span><span style="color: #007700">(</span><span style="color: #DD0000">"index.swish-e"</span><span style="color: #007700">);<br /> foreach (</span><span style="color: #0000BB">$properties </span><span style="color: #007700">as </span><span style="color: #0000BB">$prop</span><span style="color: #007700">) {<br /> echo </span><span style="color: #0000BB">$prop</span><span style="color: #007700">[</span><span style="color: #DD0000">"Name"</span><span style="color: #007700">],</span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /> }<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> swishreccount swishrank swishfilenum swishdbfile swishdocpath swishtitle swishdocsize swishlastmodified </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="swish.getmetalist.html">Swish::getMetaList</a></div> <div class="next" style="text-align: right; float: right;"><a href="swish.prepare.html">Swish::prepare</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>