mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 14:28:56 +00:00
96c9d88bad
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
108 lines
2.6 KiB
XML
108 lines
2.6 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.enchant-dict-suggest" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>enchant_dict_suggest</refname>
|
|
<refpurpose>Will return a list of values if any of those pre-conditions are not met</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>array</type><methodname>enchant_dict_suggest</methodname>
|
|
<methodparam><type>resource</type><parameter>dict</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>word</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>dict</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Dictionary resource
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>word</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Word to use for the suggestions.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Will returns an array of suggestions if the word is bad spelled.
|
|
</para>
|
|
</refsect1>
|
|
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>A <function>enchant_dict_suggest</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$tag = 'en_US';
|
|
$r = enchant_broker_init();
|
|
if (enchant_broker_dict_exists($r,$tag)) {
|
|
$d = enchant_broker_request_dict($r, $tag);
|
|
|
|
$wordcorrect = enchant_dict_check($d, "soong");
|
|
if (!$wordcorrect) {
|
|
$suggs = enchant_dict_suggest($d, "soong");
|
|
echo "Suggestions for 'soong':";
|
|
print_r($suggs);
|
|
}
|
|
enchant_broker_free_dict($d);
|
|
}
|
|
enchant_broker_free($r);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>enchant_dict_check</function></member>
|
|
<member><function>enchant_dict_quick_check</function></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
|
|
-->
|