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

178 lines
6.9 KiB
HTML

<!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>Load a new dictionary</title>
</head>
<body class="docs"><div id="layout">
<div id="layout-content"><div id="function.pspell-new" class="refentry">
<div class="refnamediv">
<h1 class="refname">pspell_new</h1>
<p class="verinfo">(PHP 4 &gt;= 4.0.2, PHP 5, PHP 7)</p><p class="refpurpose"><span class="refname">pspell_new</span> &mdash; <span class="dc-title">Load a new dictionary</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.pspell-new-description">
<h3 class="title">说明</h3>
<div class="methodsynopsis dc-description">
<span class="methodname"><strong>pspell_new</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$language</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$spelling</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$jargon</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$encoding</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$mode</code><span class="initializer"> = 0</span></span>
]]]] ) : <span class="type">int</span></div>
<p class="para rdfs-comment">
<span class="function"><strong>pspell_new()</strong></span> opens up a new dictionary and
returns the dictionary link identifier for use in other pspell
functions.
</p>
<p class="para">
For more information and examples, check out inline manual pspell
website:<a href="http://aspell.net/" class="link external">&raquo;&nbsp;http://aspell.net/</a>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.pspell-new-parameters">
<h3 class="title">参数</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">language</code></dt>
<dd>
<p class="para">
The language parameter is the language code which consists of the
two letter ISO 639 language code and an optional two letter ISO
3166 country code after a dash or underscore.
</p>
</dd>
<dt>
<code class="parameter">spelling</code></dt>
<dd>
<p class="para">
The spelling parameter is the requested spelling for languages
with more than one spelling such as English. Known values are
&#039;american&#039;, &#039;british&#039;, and &#039;canadian&#039;.
</p>
</dd>
<dt>
<code class="parameter">jargon</code></dt>
<dd>
<p class="para">
The jargon parameter contains extra information to distinguish
two different words lists that have the same language and
spelling parameters.
</p>
</dd>
<dt>
<code class="parameter">encoding</code></dt>
<dd>
<p class="para">
The encoding parameter is the encoding that words are expected to
be in. Valid values are &#039;utf-8&#039;, &#039;iso8859-*&#039;, &#039;koi8-r&#039;,
&#039;viscii&#039;, &#039;cp1252&#039;, &#039;machine unsigned 16&#039;, &#039;machine unsigned
32&#039;. This parameter is largely untested, so be careful when
using.
</p>
</dd>
<dt>
<code class="parameter">mode</code></dt>
<dd>
<p class="para">
The mode parameter is the mode in which spellchecker will work.
There are several modes available:
<ul class="itemizedlist">
<li class="listitem">
<span class="simpara">
<strong><code>PSPELL_FAST</code></strong> - Fast mode (least number of
suggestions)
</span>
</li>
<li class="listitem">
<span class="simpara">
<strong><code>PSPELL_NORMAL</code></strong> - Normal mode (more suggestions)
</span>
</li>
<li class="listitem">
<span class="simpara">
<strong><code>PSPELL_BAD_SPELLERS</code></strong> - Slow mode (a lot of
suggestions)
</span>
</li>
<li class="listitem">
<span class="simpara">
<strong><code>PSPELL_RUN_TOGETHER</code></strong> - Consider run-together words
as legal compounds. That is, &quot;thecat&quot; will be a legal compound,
although there should be a space between the two words. Changing this
setting only affects the results returned by
<span class="function"><a href="pspell_check.html" class="function">pspell_check()</a></span>; <span class="function"><a href="pspell_suggest.html" class="function">pspell_suggest()</a></span>
will still return suggestions.
</span>
</li>
</ul>
Mode is a bitmask constructed from different constants listed above.
However, <strong><code>PSPELL_FAST</code></strong>,
<strong><code>PSPELL_NORMAL</code></strong> and
<strong><code>PSPELL_BAD_SPELLERS</code></strong> are mutually exclusive, so you
should select only one of them.
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.pspell-new-returnvalues">
<h3 class="title">返回值</h3>
<p class="para">
Returns the dictionary link identifier on success 或者在失败时返回 <strong><code>FALSE</code></strong>.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.pspell-new-examples">
<h3 class="title">范例</h3>
<p class="para">
<div class="example" id="example-3210">
<p><strong>Example #1 <span class="function"><strong>pspell_new()</strong></span></strong></p>
<div class="example-contents">
<div class="phpcode"><pre><span style="color: #000000">
<span style="color: #0000BB">&lt;?php<br />$pspell_link&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">pspell_new</span><span style="color: #007700">(</span><span style="color: #DD0000">"en"</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">""</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">""</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">""</span><span style="color: #007700">,<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(</span><span style="color: #0000BB">PSPELL_FAST</span><span style="color: #007700">|</span><span style="color: #0000BB">PSPELL_RUN_TOGETHER</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">?&gt;</span>
</span>
</pre></div>
</div>
</div>
</p>
</div>
</div></div></div></body></html>