mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-28 23:08:55 +00:00
96c9d88bad
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
136 lines
3 KiB
XML
136 lines
3 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.enchant-broker-describe" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>enchant_broker_describe</refname>
|
|
<refpurpose>Enumerates the Enchant providers</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>array</type><methodname>enchant_broker_describe</methodname>
|
|
<methodparam><type>resource</type><parameter>broker</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Enumerates the Enchant providers and tells you some rudimentary
|
|
information about them. The same info is provided through phpinfo().
|
|
</para>
|
|
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>broker</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Broker resource
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&return.success;
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>List the backends provided by the given broker</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$r = enchant_broker_init();
|
|
$bprovides = enchant_broker_describe($r);
|
|
echo "Current broker provides the following backend(s):\n";
|
|
print_r($bprovides);
|
|
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs.similar;
|
|
<screen>
|
|
<![CDATA[
|
|
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
|
|
)
|
|
|
|
)
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
|
|
|
|
<!-- Use when adding See Also links
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function></function></member>
|
|
<member>Or <link linkend="somethingelse">something else</link></member>
|
|
</simplelist>
|
|
</para>
|
|
</refsect1>
|
|
-->
|
|
|
|
|
|
</refentry>
|
|
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|