uTools-Manuals/docs/php/pspell_store_replacement.html
2019-04-28 19:00:34 +08:00

123 lines
6.0 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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 class="docs"><div id="layout">
<div id="layout-content"><div id="function.pspell-store-replacement" class="refentry">
<div class="refnamediv">
<h1 class="refname">pspell_store_replacement</h1>
<p class="verinfo">(PHP 4 &gt;= 4.0.2, PHP 5, PHP 7)</p><p class="refpurpose"><span class="refname">pspell_store_replacement</span> &mdash; <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">说明</h3>
<div class="methodsynopsis dc-description">
<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>
) : <span class="type">bool</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="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="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="pspell_config_personal.html" class="function">pspell_config_personal()</a></span> and
<span class="function"><a href="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="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">参数</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">dictionary_link</code></dt>
<dd>
<p class="para">
A dictionary link identifier, opened with
<span class="function"><a href="pspell_new_personal.html" class="function">pspell_new_personal()</a></span>
</p>
</dd>
<dt>
<code class="parameter">misspelled</code></dt>
<dd>
<p class="para">
The misspelled word.
</p>
</dd>
<dt>
<code class="parameter">correct</code></dt>
<dd>
<p class="para">
The fixed spelling for the <code class="parameter">misspelled</code> word.
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.pspell-store-replacement-returnvalues">
<h3 class="title">返回值</h3>
<p class="para">
成功时返回 <strong><code>TRUE</code></strong> 或者在失败时返回 <strong><code>FALSE</code></strong>
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.pspell-store-replacement-examples">
<h3 class="title">范例</h3>
<p class="para">
<div class="example" id="example-3212">
<p><strong>Example #1 <span class="function"><strong>pspell_store_replacement()</strong></span></strong></p>
<div class="example-contents">
<div class="phpcode"><pre><span style="color: #000000">
<span style="color: #0000BB">&lt;?php<br />$pspell_config&nbsp;</span><span style="color: #007700">=&nbsp;</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">,&nbsp;</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">,&nbsp;</span><span style="color: #DD0000">"/var/dictionaries/custom.repl"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$pspell_link&nbsp;</span><span style="color: #007700">=&nbsp;</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">,&nbsp;</span><span style="color: #0000BB">$misspelled</span><span style="color: #007700">,&nbsp;</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">?&gt;</span>
</span>
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 notes" id="refsect1-function.pspell-store-replacement-notes">
<h3 class="title">注释</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></div></div></body></html>