<!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>Check the word is correctly spelled and provide suggestions</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.enchant-dict-is-in-session.html">enchant_dict_is_in_session</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.enchant-dict-store-replacement.html">enchant_dict_store_replacement</a></div>
<div class="up"><a href="ref.enchant.html">Enchant Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.enchant-dict-quick-check" class="refentry">
<div class="refnamediv">
<h1 class="refname">enchant_dict_quick_check</h1>
<p class="verinfo">(PHP 5 >= 5.3.0, PECL enchant:0.2.0-1.0.1)</p><p class="refpurpose"><span class="refname">enchant_dict_quick_check</span> — <span class="dc-title">Check the word is correctly spelled and provide suggestions</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.enchant-dict-quick-check-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>enchant_dict_quick_check</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$dict</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$word</code></span>
[, <span class="methodparam"><span class="type">array</span> <code class="parameter reference">&$suggestions</code></span>
] )</div>
<p class="para rdfs-comment">
If the word is correctly spelled return <strong><code>TRUE</code></strong>, otherwise return <strong><code>FALSE</code></strong>, if suggestions variable
is provided, fill it with spelling alternatives.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.enchant-dict-quick-check-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">dict</code></em></span>
<dd>
<p class="para">
Dictionary resource
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">word</code></em></span>
<dd>
<p class="para">
The word to check
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">suggestions</code></em></span>
<dd>
<p class="para">
If the word is not correctly spelled, this variable will
contain an array of suggestions.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.enchant-dict-quick-check-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> if the word is correctly spelled or <strong><code>FALSE</code></strong>
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.enchant-dict-quick-check-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2468">
<p><strong>Example #1 A <span class="function"><strong>enchant_dict_quick_check()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$tag </span><span style="color: #007700">= </span><span style="color: #DD0000">'en_US'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$r </span><span style="color: #007700">= </span><span style="color: #0000BB">enchant_broker_init</span><span style="color: #007700">();<br /><br />if (</span><span style="color: #0000BB">enchant_broker_dict_exists</span><span style="color: #007700">(</span><span style="color: #0000BB">$r</span><span style="color: #007700">,</span><span style="color: #0000BB">$tag</span><span style="color: #007700">)) {<br /> </span><span style="color: #0000BB">$d </span><span style="color: #007700">= </span><span style="color: #0000BB">enchant_broker_request_dict</span><span style="color: #007700">(</span><span style="color: #0000BB">$r</span><span style="color: #007700">, </span><span style="color: #0000BB">$tag</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">enchant_dict_quick_check</span><span style="color: #007700">(</span><span style="color: #0000BB">$d</span><span style="color: #007700">, </span><span style="color: #DD0000">'soong'</span><span style="color: #007700">, </span><span style="color: #0000BB">$suggs</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$suggs</span><span style="color: #007700">);<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
Array
(
[0] => song
[1] => snog
[2] => soon
[3] => Sang
[4] => Sung
[5] => sang
[6] => sung
[7] => sponge
[8] => spongy
[9] => snag
[10] => snug
[11] => sonic
[12] => sing
[13] => songs
[14] => Son
[15] => Sonja
[16] => Synge
[17] => son
[18] => Sejong
[19] => sarong
[20] => sooner
[21] => Sony
[22] => sown
[23] => scone
[24] => song's
)
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.enchant-dict-quick-check-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.enchant-dict-check.html" class="function" rel="rdfs-seeAlso">enchant_dict_check()</a> - Check whether a word is correctly spelled or not</span></li>
<li class="member"> <span class="function"><a href="function.enchant-dict-suggest.html" class="function" rel="rdfs-seeAlso">enchant_dict_suggest()</a> - Will return a list of values if any of those pre-conditions are not met</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.enchant-dict-is-in-session.html">enchant_dict_is_in_session</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.enchant-dict-store-replacement.html">enchant_dict_store_replacement</a></div>
<div class="up"><a href="ref.enchant.html">Enchant Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
