<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.pspell-new-config" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>pspell_new_config</refname>
  <refpurpose>Load a new dictionary with settings based on a given config
  </refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>PSpell\Dictionary</type><type>false</type></type><methodname>pspell_new_config</methodname>
   <methodparam><type>PSpell\Config</type><parameter>config</parameter></methodparam>
  </methodsynopsis>
  <simpara>
   <function>pspell_new_config</function> opens up a new dictionary with
   settings specified in a <parameter>config</parameter>, created with
   <function>pspell_config_create</function> and modified with
   <function>pspell_config_*</function> functions. This method provides you
   with the most flexibility and has all the functionality provided by
   <function>pspell_new</function> and
   <function>pspell_new_personal</function>.
  </simpara>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>config</parameter></term>
     <listitem>
      <para>
       The <parameter>config</parameter> parameter is the one returned by
       <function>pspell_config_create</function> when the config was created.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns an <classname>PSpell\Dictionary</classname> instance on success, &return.falseforfailure;
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     &pspell.changelog.pspell-config;
     <row>
      <entry>8.1.0</entry>
      <entry>
       Returns an <classname>PSpell\Dictionary</classname> instance now;
       previously, a &resource; was returned.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>pspell_new_config</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$pspell_config = pspell_config_create("en");
pspell_config_personal($pspell_config, "/var/dictionaries/custom.pws");
pspell_config_repl($pspell_config, "/var/dictionaries/custom.repl");
$pspell = pspell_new_config($pspell_config);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
