Home/ Manual/ pspell / functions/ pspell_new_config

pspell_new_config

PHP function Edit on GitHub ✎

(PHP 4 >= 4.0.2, PHP 5, PHP 7, PHP 8)

Load a new dictionary with settings based on a given config

Description

pspell_new_config(PSpell\Config $config): PSpell\Dictionary|false

pspell_new_config() opens up a new dictionary with settings specified in a config, created with pspell_config_create() and modified with pspell_config_*() functions. This method provides you with the most flexibility and has all the functionality provided by pspell_new() and pspell_new_personal().

Parameters

config: The config parameter is the one returned by pspell_config_create() when the config was created.

Return Values

Returns an PSpell\Dictionary instance on success, Falseforfailure

Changelog

Version	Description
8.1.0	Returns an `PSpell\Dictionary` instance now; previously, a Resource was returned.

Examples

pspell_new_config()

php

<?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);
?>

Source: reference/pspell/functions/pspell-new-config.xml · from the official PHP manual (php/doc-en)