<!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>Enumerates the Enchant providers</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="ref.enchant.html">Enchant Functions</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.enchant-broker-dict-exists.html">enchant_broker_dict_exists</a></div>
<div class="up"><a href="ref.enchant.html">Enchant Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.enchant-broker-describe" class="refentry">
<div class="refnamediv">
<h1 class="refname">enchant_broker_describe</h1>
<p class="verinfo">(PHP 5 >= 5.3.0, PECL enchant >= 0.1.0)</p><p class="refpurpose"><span class="refname">enchant_broker_describe</span> — <span class="dc-title">Enumerates the Enchant providers</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.enchant-broker-describe-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <span class="methodname"><strong>enchant_broker_describe</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$broker</code></span>
)</div>
<p class="para rdfs-comment">
Enumerates the Enchant providers and tells you some rudimentary
information about them. The same info is provided through phpinfo().
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.enchant-broker-describe-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">broker</code></em></span>
<dd>
<p class="para">
Broker resource
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.enchant-broker-describe-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.enchant-broker-describe-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2463">
<p><strong>Example #1 List the backends provided by the given broker</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$r </span><span style="color: #007700">= </span><span style="color: #0000BB">enchant_broker_init</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$bprovides </span><span style="color: #007700">= </span><span style="color: #0000BB">enchant_broker_describe</span><span style="color: #007700">(</span><span style="color: #0000BB">$r</span><span style="color: #007700">);<br />echo </span><span style="color: #DD0000">"Current broker provides the following backend(s):\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$bprovides</span><span style="color: #007700">);<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>
Current broker provides the following backend(s):
Array
(
[0] => Array
(
[name] => aspell
[desc] => Aspell Provider
[file] => /usr/lib/enchant/libenchant_aspell.so
)
[1] => Array
(
[name] => hspell
[desc] => Hspell Provider
[file] => /usr/lib/enchant/libenchant_hspell.so
)
[2] => Array
(
[name] => ispell
[desc] => Ispell Provider
[file] => /usr/lib/enchant/libenchant_ispell.so
)
[3] => Array
(
[name] => myspell
[desc] => Myspell Provider
[file] => /usr/lib/enchant/libenchant_myspell.so
)
)
</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="ref.enchant.html">Enchant Functions</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.enchant-broker-dict-exists.html">enchant_broker_dict_exists</a></div>
<div class="up"><a href="ref.enchant.html">Enchant Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
