Source of: /manual/en/function.pspell-config-personal.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = 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-personal.php',
1 => 'pspell_config_personal',
),
'up' =>
array (
0 => 'ref.pspell.php',
1 => 'Pspell Functions',
),
'prev' =>
array (
0 => 'function.pspell-config-mode.php',
1 => 'pspell_config_mode',
),
'next' =>
array (
0 => 'function.pspell-config-repl.php',
1 => 'pspell_config_repl',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.pspell-config-personal" class="refentry">
<div class="refnamediv">
<h1 class="refname">pspell_config_personal</h1>
<p class="verinfo">(PHP 4 >= 4.0.2, PHP 5)</p><p class="refpurpose"><span class="refname">pspell_config_personal</span> — <span class="dc-title">Set a file that contains personal wordlist</span></p>
</div>
<a name="function.pspell-config-personal.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><b>pspell_config_personal</b></span>
( <span class="methodparam"><span class="type">int</span> <tt class="parameter">$dictionary_link</tt></span>
, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$file</tt></span>
)</div>
<p class="para rdfs-comment">
Set a file that contains personal wordlist. The personal wordlist will be
loaded and used in addition to the standard one after you call
<a href="function.pspell-new-config.php" class="function">pspell_new_config()</a>. The file is also the file where
<a href="function.pspell-save-wordlist.php" class="function">pspell_save_wordlist()</a> will save personal wordlist to.
</p>
<p class="para">
<b>pspell_config_personal()</b> should be used on a config
before calling <a href="function.pspell-new-config.php" class="function">pspell_new_config()</a>.
</p>
</div>
<a name="function.pspell-config-personal.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">dictionary_link</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">file</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The personal wordlist. If the file does not exist, it will be created.
The file should be writable by whoever PHP runs as (e.g. nobody).
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.pspell-config-personal.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <b><tt class="constant">TRUE</tt></b> on success or <b><tt class="constant">FALSE</tt></b> on failure.
</p>
</div>
<a name="function.pspell-config-personal.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example">
<p><b>Example #1 <b>pspell_config_personal()</b></b></p>
<div class="example-contents programlisting">
<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_personal</span><span style="color: #007700">(</span><span style="color: #0000BB">$pspell_config</span><span style="color: #007700">, </span><span style="color: #DD0000">"/var/dictionaries/custom.pws"</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>
</p>
</div>
<a name="function.pspell-config-personal.notes"></a><div class="refsect1 notes">
<h3 class="title">Notes</h3>
<blockquote><p><b class="note">Note</b>:
This function will not work unless you have pspell .11.2 and aspell .32.5
or later.
<br />
</p></blockquote>
</div>
</div><?php manual_footer(); ?>
