<?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-save-repl.php',
    1 => 'pspell_config_save_repl',
    2 => 'Determine whether to save a replacement pairs list
  along with the wordlist',
  ),
  'up' => 
  array (
    0 => 'ref.pspell.php',
    1 => 'Pspell Functions',
  ),
  'prev' => 
  array (
    0 => 'function.pspell-config-runtogether.php',
    1 => 'pspell_config_runtogether',
  ),
  'next' => 
  array (
    0 => 'function.pspell-new.php',
    1 => 'pspell_new',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/pspell/functions/pspell-config-save-repl.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.pspell-config-save-repl" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">pspell_config_save_repl</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_save_repl</span> &mdash; <span class="dc-title">Determine whether to save a replacement pairs list
  along with the wordlist</span></p>

 </div>
 
 <div class="refsect1 description" id="refsect1-function.pspell-config-save-repl-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>pspell_config_save_repl</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">$save</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

  <p class="para rdfs-comment">
   <span class="function"><strong>pspell_config_save_repl()</strong></span> determines whether
   <span class="function"><a href="function.pspell-save-wordlist.php" class="function">pspell_save_wordlist()</a></span> will save the replacement pairs
   along with the wordlist. Usually there is no need to use this function
   because if <span class="function"><a href="function.pspell-config-repl.php" class="function">pspell_config_repl()</a></span> is used, the
   replacement pairs will be saved by
   <span class="function"><a href="function.pspell-save-wordlist.php" class="function">pspell_save_wordlist()</a></span> anyway, and if it is not,
   the replacement pairs will not be saved. 
  </p>
  <p class="para">
   <span class="function"><strong>pspell_config_save_repl()</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-save-repl-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">save</code></dt>
     <dd>
      <p class="para">
       <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> if replacement pairs should be saved, <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-save-repl-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-save-repl-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 notes" id="refsect1-function.pspell-config-save-repl-notes">
  <h3 class="title">Notes</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><?php manual_footer($setup); ?>