<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Store a replacement pair for a word</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.pspell-save-wordlist.html">pspell_save_wordlist</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.pspell-suggest.html">pspell_suggest</a></div>
<div class="up"><a href="ref.pspell.html">Pspell Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.pspell-store-replacement" class="refentry">
<div class="refnamediv">
<h1 class="refname">pspell_store_replacement</h1>
<p class="verinfo">(PHP 4 >= 4.0.2, PHP 5)</p><p class="refpurpose"><span class="refname">pspell_store_replacement</span> — <span class="dc-title">Store a replacement pair for a word</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.pspell-store-replacement-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>pspell_store_replacement</strong></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$dictionary_link</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$misspelled</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$correct</code></span>
)</div>
<p class="simpara">
<span class="function"><strong>pspell_store_replacement()</strong></span> stores a replacement pair for
a word, so that replacement can be returned by
<span class="function"><a href="function.pspell-suggest.html" class="function">pspell_suggest()</a></span> later. In order to be able to take
advantage of this function, you have to use
<span class="function"><a href="function.pspell-new-personal.html" class="function">pspell_new_personal()</a></span> to open the dictionary. In order
to permanently save the replacement pair, you have to
use <span class="function"><a href="function.pspell-config-personal.html" class="function">pspell_config_personal()</a></span> and
<span class="function"><a href="function.pspell-config-repl.html" class="function">pspell_config_repl()</a></span> to set the path where to save your
custom wordlists, and then use <span class="function"><a href="function.pspell-save-wordlist.html" class="function">pspell_save_wordlist()</a></span>
for the changes to be written to disk.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.pspell-store-replacement-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">dictionary_link</code></em></span>
<dd>
<p class="para">
A dictionary link identifier, opened with
<span class="function"><a href="function.pspell-new-personal.html" class="function">pspell_new_personal()</a></span>
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">misspelled</code></em></span>
<dd>
<p class="para">
The misspelled word.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">correct</code></em></span>
<dd>
<p class="para">
The fixed spelling for the <em><code class="parameter">misspelled</code></em> word.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.pspell-store-replacement-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.pspell-store-replacement-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2738">
<p><strong>Example #1 <span class="function"><strong>pspell_store_replacement()</strong></span></strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$pspell_config </span><span style="color: #007700">= </span><span style="color: #0000BB">pspell_config_create</span><span style="color: #007700">(</span><span style="color: #DD0000">"en"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">pspell_config_personal</span><span style="color: #007700">(</span><span style="color: #0000BB">$pspell_config</span><span style="color: #007700">, </span><span style="color: #DD0000">"/var/dictionaries/custom.pws"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">pspell_config_repl</span><span style="color: #007700">(</span><span style="color: #0000BB">$pspell_config</span><span style="color: #007700">, </span><span style="color: #DD0000">"/var/dictionaries/custom.repl"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$pspell_link </span><span style="color: #007700">= </span><span style="color: #0000BB">pspell_new_config</span><span style="color: #007700">(</span><span style="color: #0000BB">$pspell_config</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">pspell_store_replacement</span><span style="color: #007700">(</span><span style="color: #0000BB">$pspell_link</span><span style="color: #007700">, </span><span style="color: #0000BB">$misspelled</span><span style="color: #007700">, </span><span style="color: #0000BB">$correct</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">pspell_save_wordlist</span><span style="color: #007700">(</span><span style="color: #0000BB">$pspell_link</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 notes" id="refsect1-function.pspell-store-replacement-notes">
<h3 class="title">Notes</h3>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
This function will not work unless you have pspell .11.2 and aspell .32.5
or later.
</p>
</p></blockquote>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.pspell-save-wordlist.html">pspell_save_wordlist</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.pspell-suggest.html">pspell_suggest</a></div>
<div class="up"><a href="ref.pspell.html">Pspell Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
