<!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>Returns a list of available dictionaries</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.enchant-broker-init.html">enchant_broker_init</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.enchant-broker-request-dict.html">enchant_broker_request_dict</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-list-dicts" class="refentry"> <div class="refnamediv"> <h1 class="refname">enchant_broker_list_dicts</h1> <p class="verinfo">(PHP 5 >= 5.3.0, PECL enchant >= 1.0.1)</p><p class="refpurpose"><span class="refname">enchant_broker_list_dicts</span> — <span class="dc-title">Returns a list of available dictionaries</span></p> </div> <div class="refsect1 description" id="refsect1-function.enchant-broker-list-dicts-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <span class="methodname"><strong>enchant_broker_list_dicts</strong></span> ( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$broker</code></span> )</div> <p class="para rdfs-comment"> Returns a list of available dictionaries with their details. </p> </div> <div class="refsect1 parameters" id="refsect1-function.enchant-broker-list-dicts-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-list-dicts-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-list-dicts-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-2465"> <p><strong>Example #1 List all available dictionaries for one 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">$dicts </span><span style="color: #007700">= </span><span style="color: #0000BB">enchant_broker_list_dicts</span><span style="color: #007700">(</span><span style="color: #0000BB">$r</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$dicts</span><span style="color: #007700">);<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> Array ( [0] => Array ( [lang_tag] => de [provider_name] => aspell [provider_desc] => Aspell Provider [provider_file] => /usr/lib/enchant/libenchant_aspell.so ) [1] => Array ( [lang_tag] => de_DE [provider_name] => aspell [provider_desc] => Aspell Provider [provider_file] => /usr/lib/enchant/libenchant_aspell.so ) [3] => Array ( [lang_tag] => en [provider_name] => aspell [provider_desc] => Aspell Provider [provider_file] => /usr/lib/enchant/libenchant_aspell.so ) [4] => Array ( [lang_tag] => en_GB [provider_name] => aspell [provider_desc] => Aspell Provider [provider_file] => /usr/lib/enchant/libenchant_aspell.so ) [5] => Array ( [lang_tag] => en_US [provider_name] => aspell [provider_desc] => Aspell Provider [provider_file] => /usr/lib/enchant/libenchant_aspell.so ) [6] => Array ( [lang_tag] => hi_IN [provider_name] => myspell [provider_desc] => Myspell Provider [provider_file] => /usr/lib/enchant/libenchant_myspell.so ) ) </pre></div> </div> </div> </p> </div> <div class="refsect1 seealso" id="refsect1-function.enchant-broker-list-dicts-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"> <span class="function"><a href="function.enchant-broker-describe.html" class="function" rel="rdfs-seeAlso">enchant_broker_describe()</a> - Enumerates the Enchant providers</span></li> </ul> </p> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.enchant-broker-init.html">enchant_broker_init</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.enchant-broker-request-dict.html">enchant_broker_request_dict</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>