<!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>Consider run-together words as valid compounds</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.pspell-config-repl.html">pspell_config_repl</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.pspell-config-save-repl.html">pspell_config_save_repl</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-config-runtogether" class="refentry">
<div class="refnamediv">
<h1 class="refname">pspell_config_runtogether</h1>
<p class="verinfo">(PHP 4 >= 4.0.2, PHP 5)</p><p class="refpurpose"><span class="refname">pspell_config_runtogether</span> — <span class="dc-title">Consider run-together words as valid compounds</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.pspell-config-runtogether-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>pspell_config_runtogether</strong></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$dictionary_link</code></span>
, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$flag</code></span>
)</div>
<p class="para rdfs-comment">
This function determines whether run-together words will be treated as
legal compounds. That is, "thecat" 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="function.pspell-check.html" class="function">pspell_check()</a></span>;
<span class="function"><a href="function.pspell-suggest.html" class="function">pspell_suggest()</a></span> will still return suggestions.
</p>
<p class="para">
<span class="function"><strong>pspell_config_runtogether()</strong></span> should be used on a config
before calling <span class="function"><a href="function.pspell-new-config.html" class="function">pspell_new_config()</a></span>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.pspell-config-runtogether-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">
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">flag</code></em></span>
<dd>
<p class="para">
<strong><code>TRUE</code></strong> if run-together words should be treated as legal compounds,
<strong><code>FALSE</code></strong> otherwise.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.pspell-config-runtogether-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-config-runtogether-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2733">
<p><strong>Example #1 <span class="function"><strong>pspell_config_runtogether()</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_runtogether</span><span style="color: #007700">(</span><span style="color: #0000BB">$pspell_config</span><span style="color: #007700">, </span><span style="color: #0000BB">true</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 /></span><span style="color: #0000BB">pspell_check</span><span style="color: #007700">(</span><span style="color: #0000BB">$pspell_link</span><span style="color: #007700">, </span><span style="color: #DD0000">"thecat"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.pspell-config-repl.html">pspell_config_repl</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.pspell-config-save-repl.html">pspell_config_save_repl</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>
