<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.pspell.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'en',
  ),
  'this' => 
  array (
    0 => 'function.pspell-config-runtogether.php',
    1 => 'pspell_config_runtogether',
    2 => 'Consider run-together words as valid compounds',
  ),
  'up' => 
  array (
    0 => 'ref.pspell.php',
    1 => 'Pspell Functions',
  ),
  'prev' => 
  array (
    0 => 'function.pspell-config-repl.php',
    1 => 'pspell_config_repl',
  ),
  'next' => 
  array (
    0 => 'function.pspell-config-save-repl.php',
    1 => 'pspell_config_save_repl',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/pspell/functions/pspell-config-runtogether.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.pspell-config-runtogether" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">pspell_config_runtogether</h1>
  <p class="verinfo">(PHP 4 &gt;= 4.0.2, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">pspell_config_runtogether</span> &mdash; <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="methodname"><strong>pspell_config_runtogether</strong></span>(<span class="methodparam"><span class="type"><a href="class.pspell-config.php" class="type PSpell\Config">PSpell\Config</a></span> <code class="parameter">$config</code></span>, <span class="methodparam"><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span> <code class="parameter">$allow</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

  <p class="para rdfs-comment">
   This function determines whether run-together words will be treated 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="function.pspell-check.php" class="function">pspell_check()</a></span>;
   <span class="function"><a href="function.pspell-suggest.php" 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.php" 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><code class="parameter">config</code></dt>
     <dd>
      <p class="para">An <span class="classname"><a href="class.pspell-config.php" class="classname">PSpell\Config</a></span> instance.</p>
     </dd>
    
    
     <dt><code class="parameter">allow</code></dt>
     <dd>
      <p class="para">
       <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> if run-together words should be treated as legal compounds,
       <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> otherwise.
      </p>
     </dd>
    
   </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><a href="reserved.constants.php#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> on failure.
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.pspell-config-runtogether-changelog">
  <h3 class="title">Changelog</h3>
  <table class="doctable informaltable">
   
    <thead>
     <tr>
      <th>Version</th>
      <th>Description</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
 <td>8.1.0</td>
 <td>
  The <code class="parameter">config</code> parameter expects an <span class="classname"><a href="class.pspell-config.php" class="classname">PSpell\Config</a></span>
  instance now; previously, a <span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span> was expected.
 </td>
</tr>

    </tbody>
   
  </table>

 </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-1">
    <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">&lt;?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 </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</span><span style="color: #007700">, </span><span style="color: #DD0000">"thecat"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

   </div>
  </p>
 </div>


</div><?php manual_footer($setup); ?>