mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-21 03:18:55 +00:00

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@33132 c90b9560-bf6c-de11-be94-00142212c4b1
180 lines
5.2 KiB
XML
180 lines
5.2 KiB
XML
<reference id="ref.aspell">
|
|
<title>Aspell functions</title>
|
|
<titleabbrev>Aspell</titleabbrev>
|
|
|
|
<partintro>
|
|
<simpara>
|
|
The <function>aspell</function> functions allows you to check the
|
|
spelling on a word and offer suggestions.
|
|
</simpara>
|
|
<note>
|
|
<simpara>
|
|
aspell works only with very old (up to .27.* or so) versions of
|
|
aspell library. Neither this module, nor those versions of aspell
|
|
library are supported any longer. If you want to use
|
|
spell-checking capabilities in php, use <link
|
|
linkend="ref.pspell">pspell</link> instead. It uses pspell
|
|
library and works with newer versions of aspell.
|
|
</simpara>
|
|
</note>
|
|
<simpara>
|
|
You need the aspell library, available from: <ulink
|
|
url="&url.aspell;">&url.aspell;</ulink>.
|
|
</simpara>
|
|
</partintro>
|
|
|
|
<refentry id="function.aspell-new">
|
|
<refnamediv>
|
|
<refname>aspell_new</refname>
|
|
<refpurpose>Load a new dictionary</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcprototype>
|
|
<funcdef>int <function>aspell_new</function></funcdef>
|
|
<paramdef>string <parameter>master</parameter></paramdef>
|
|
<paramdef>string <parameter>personal</parameter></paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
<simpara>
|
|
<function>Aspell_new</function> opens up a new dictionary and
|
|
returns the dictionary link identifier for use in other aspell
|
|
functions.</simpara>
|
|
<para>
|
|
<example>
|
|
<title><function>Aspell_new</function></title>
|
|
<programlisting role="php">
|
|
$aspell_link=aspell_new ("english");
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.aspell-check">
|
|
<refnamediv>
|
|
<refname>aspell_check</refname>
|
|
<refpurpose>Check a word</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcprototype>
|
|
<funcdef>boolean <function>aspell_check</function></funcdef>
|
|
<paramdef>int <parameter>dictionary_link</parameter></paramdef>
|
|
<paramdef>string <parameter>word</parameter></paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
<simpara>
|
|
<function>Aspell_check</function> checks the spelling of a word
|
|
and returns true if the spelling is correct, false if not.
|
|
</simpara>
|
|
<para>
|
|
<example>
|
|
<title><function>Aspell_check</function></title>
|
|
<programlisting>
|
|
$aspell_link=aspell_new ("english");
|
|
if (aspell_check ($aspell_link, "testt")) {
|
|
echo "This is a valid spelling";
|
|
} else {
|
|
echo "Sorry, wrong spelling";
|
|
}
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.aspell-check-raw">
|
|
<refnamediv>
|
|
<refname>aspell_check_raw</refname>
|
|
<refpurpose>
|
|
Check a word without changing its case or trying to trim it
|
|
</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcprototype>
|
|
<funcdef>boolean <function>aspell_check_raw</function></funcdef>
|
|
<paramdef>int <parameter>dictionary_link</parameter></paramdef>
|
|
<paramdef>string <parameter>word</parameter></paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
<simpara>
|
|
<function>Aspell_check_raw</function> checks the spelling of a
|
|
word, without changing its case or trying to trim it in any way
|
|
and returns true if the spelling is correct, false if not.
|
|
</simpara>
|
|
<para>
|
|
<example>
|
|
<title><function>Aspell_check_raw</function></title>
|
|
<programlisting role="php">
|
|
$aspell_link=aspell_new ("english");
|
|
if (aspell_check_raw ($aspell_link, "test")) {
|
|
echo "This is a valid spelling";
|
|
} else {
|
|
echo "Sorry, wrong spelling";
|
|
}
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.aspell-suggest">
|
|
<refnamediv>
|
|
<refname>aspell_suggest</refname>
|
|
<refpurpose>Suggest spellings of a word</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcprototype>
|
|
<funcdef>array <function>aspell_suggest</function></funcdef>
|
|
<paramdef>int <parameter>dictionary_link</parameter></paramdef>
|
|
<paramdef>string <parameter>word</parameter></paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
<simpara>
|
|
<function>Aspell_suggest</function> returns an array of possible
|
|
spellings for the given word.
|
|
</simpara>
|
|
<para>
|
|
<example>
|
|
<title><function>Aspell_suggest</function></title>
|
|
<programlisting role="php">
|
|
$aspell_link=aspell_new ("english");
|
|
|
|
if (!aspell_check ($aspell_link, "test")) {
|
|
$suggestions=aspell_suggest ($aspell_link, "test");
|
|
|
|
for ($i=0; $i < count ($suggestions); $i++) {
|
|
echo "Possible spelling: " . $suggestions[$i] . "<br>";
|
|
}
|
|
}
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
</reference>
|
|
|
|
<!-- 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
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"../../manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
-->
|