mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-26 22:08:55 +00:00
6fa29283c5
Closes GH-232. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351794 c90b9560-bf6c-de11-be94-00142212c4b1
130 lines
2.9 KiB
XML
130 lines
2.9 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.enchant-dict-describe" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>enchant_dict_describe</refname>
|
|
<refpurpose>Describes an individual dictionary</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>array</type><methodname>enchant_dict_describe</methodname>
|
|
<methodparam><type>EnchantDictionary</type><parameter>dictionary</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Returns the details of the dictionary.
|
|
</para>
|
|
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
&enchant.param.dictionary;
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&return.success;
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="changelog">
|
|
&reftitle.changelog;
|
|
<informaltable>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>&Version;</entry>
|
|
<entry>&Description;</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
&enchant.changelog.dictionary-param;
|
|
<row>
|
|
<entry>8.0.0</entry>
|
|
<entry>
|
|
Prior to this version, the function returned &false; on failure.
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>A <function>enchant_dict_describe</function> example</title>
|
|
<para>
|
|
Check if a dictionary exists using
|
|
<function>enchant_broker_dict_exists</function> and show the detail of it.
|
|
</para>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$tag = 'en_US';
|
|
$broker = enchant_broker_init();
|
|
if (enchant_broker_dict_exists($broker,$tag)) {
|
|
$dict = enchant_broker_request_dict($r, $tag);
|
|
$dict_details = enchant_dict_describe($dict);
|
|
print_r($dict_details);
|
|
}
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs.similar;
|
|
<screen>
|
|
<![CDATA[
|
|
Array
|
|
(
|
|
[lang] => en_US
|
|
[name] => aspell
|
|
[desc] => Aspell Provider
|
|
[file] => /usr/lib/enchant/libenchant_aspell.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
|
|
-->
|