php-doc-en/functions/aspell.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.21 $ -->
 <reference id="ref.aspell">
  <title>Aspell functions [deprecated]</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 [deprecated]</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <funcsynopsis>
     <funcprototype>
      <funcdef>int <function>aspell_new</function></funcdef>
      <paramdef>string <parameter>master</parameter></paramdef>
      <paramdef>string 
       <parameter><optional>personal</optional></parameter> </paramdef>
     </funcprototype>
    </funcsynopsis>
    <!-- TODO: personal??? -->
    <simpara>
     <function>aspell_new</function> opens up a new dictionary and
     returns the dictionary link identifier for use in other aspell
     functions. Returns &false; on error.
    </simpara>
    <para>
     <example>
      <title><function>aspell_new</function></title>
      <programlisting role="php">
<![CDATA[
$aspell_link = aspell_new("english");
]]>
      </programlisting>
     </example>
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.aspell-check">
   <refnamediv>
    <refname>aspell_check</refname>
    <refpurpose>Check a word [deprecated]</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <funcsynopsis>
     <funcprototype>
      <funcdef>bool <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>
<![CDATA[
$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 [deprecated]
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <funcsynopsis>
     <funcprototype>
      <funcdef>bool <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">
<![CDATA[
$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 [deprecated]</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">
<![CDATA[
$aspell_link = aspell_new("english");

if (!aspell_check($aspell_link, "test")) {
    $suggestions = aspell_suggest($aspell_link, "test");

    foreach ($suggestions as $suggestion) {
        echo "Possible spelling: $suggestion<br>\n"; 
    }
}
]]>
      </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
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../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
-->