<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.pspell-store-replacement" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>pspell_store_replacement</refname>
  <refpurpose>Store a replacement pair for a word</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>pspell_store_replacement</methodname>
   <methodparam><type>PSpell\Dictionary</type><parameter>dictionary</parameter></methodparam>
   <methodparam><type>string</type><parameter>misspelled</parameter></methodparam>
   <methodparam><type>string</type><parameter>correct</parameter></methodparam>
  </methodsynopsis>
  <simpara>
   <function>pspell_store_replacement</function> stores a replacement pair for
   a word, so that replacement can be returned by
   <function>pspell_suggest</function> later. In order to be able to take
   advantage of this function, you have to use
   <function>pspell_new_personal</function> to open the dictionary. In order
   to permanently save the replacement pair, you have to
   use <function>pspell_config_personal</function> and
   <function>pspell_config_repl</function> to set the path where to save your
   custom wordlists, and then use <function>pspell_save_wordlist</function>
   for the changes to be written to disk. 
  </simpara>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>dictionary</parameter></term>
     <listitem>
      &pspell.parameter.pspell-dictionary;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>misspelled</parameter></term>
     <listitem>
      <para>
       The misspelled word.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>correct</parameter></term>
     <listitem>
      <para>
       The fixed spelling for the <parameter>misspelled</parameter> word.
      </para>
     </listitem>
    </varlistentry>
   </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>
     &pspell.changelog.pspell-dictionary;
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>pspell_store_replacement</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$pspell_config = pspell_config_create("en");
pspell_config_personal($pspell_config, "/var/dictionaries/custom.pws");
pspell_config_repl($pspell_config, "/var/dictionaries/custom.repl");
$pspell = pspell_new_config($pspell_config);

pspell_store_replacement($pspell, $misspelled, $correct);
pspell_save_wordlist($pspell);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    This function will not work unless you have pspell .11.2 and aspell .32.5
    or later.
   </para>
  </note>
 </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
-->
