function pspell_new_config()

in pspell/pspell.php [89:199]

• 9 lines of code
• 1 McCabe index (conditional complexity)

function pspell_new_config(#[LanguageLevelTypeAware(['8.1' => 'PSpell\Config'], default: 'int')] $config) {}

/**
 * Check a word
 * @link https://php.net/manual/en/function.pspell-check.php
 * @param int $dictionary
 * @param string $word <p>
 * The tested word.
 * </p>
 * @return bool <b>TRUE</b> if the spelling is correct, <b>FALSE</b> if not.
 */
function pspell_check(#[LanguageLevelTypeAware(['8.1' => 'PSpell\Dictionary'], default: 'int')] $dictionary, string $word): bool {}

/**
 * Suggest spellings of a word
 * @link https://php.net/manual/en/function.pspell-suggest.php
 * @param int $dictionary
 * @param string $word <p>
 * The tested word.
 * </p>
 * @return array|false an array of possible spellings.
 */
function pspell_suggest(#[LanguageLevelTypeAware(['8.1' => 'PSpell\Dictionary'], default: 'int')] $dictionary, string $word): array|false {}

/**
 * Store a replacement pair for a word
 * @link https://php.net/manual/en/function.pspell-store-replacement.php
 * @param int $dictionary <p>
 * A dictionary link identifier, opened with
 * <b>pspell_new_personal</b>
 * </p>
 * @param string $misspelled <p>
 * The misspelled word.
 * </p>
 * @param string $correct <p>
 * The fixed spelling for the <i>misspelled</i> word.
 * </p>
 * @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
 */
function pspell_store_replacement(#[LanguageLevelTypeAware(['8.1' => 'PSpell\Dictionary'], default: 'int')] $dictionary, string $misspelled, string $correct): bool {}

/**
 * Add the word to a personal wordlist
 * @link https://php.net/manual/en/function.pspell-add-to-personal.php
 * @param int $dictionary
 * @param string $word <p>
 * The added word.
 * </p>
 * @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
 */
function pspell_add_to_personal(#[LanguageLevelTypeAware(['8.1' => 'PSpell\Dictionary'], default: 'int')] $dictionary, string $word): bool {}

/**
 * Add the word to the wordlist in the current session
 * @link https://php.net/manual/en/function.pspell-add-to-session.php
 * @param int $dictionary
 * @param string $word <p>
 * The added word.
 * </p>
 * @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
 */
function pspell_add_to_session(#[LanguageLevelTypeAware(['8.1' => 'PSpell\Dictionary'], default: 'int')] $dictionary, string $word): bool {}

/**
 * Clear the current session
 * @link https://php.net/manual/en/function.pspell-clear-session.php
 * @param int $dictionary
 * @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
 */
function pspell_clear_session(#[LanguageLevelTypeAware(['8.1' => 'PSpell\Dictionary'], default: 'int')] $dictionary): bool {}

/**
 * Save the personal wordlist to a file
 * @link https://php.net/manual/en/function.pspell-save-wordlist.php
 * @param int $dictionary <p>
 * A dictionary link identifier opened with
 * <b>pspell_new_personal</b>.
 * </p>
 * @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
 */
function pspell_save_wordlist(#[LanguageLevelTypeAware(['8.1' => 'PSpell\Dictionary'], default: 'int')] $dictionary): bool {}

/**
 * Create a config used to open a dictionary
 * @link https://php.net/manual/en/function.pspell-config-create.php
 * @param string $language <p>
 * The language parameter is the language code which consists of the
 * two letter ISO 639 language code and an optional two letter ISO
 * 3166 country code after a dash or underscore.
 * </p>
 * @param string $spelling <p>
 * The spelling parameter is the requested spelling for languages
 * with more than one spelling such as English. Known values are
 * 'american', 'british', and 'canadian'.
 * </p>
 * @param string $jargon <p>
 * The jargon parameter contains extra information to distinguish
 * two different words lists that have the same language and
 * spelling parameters.
 * </p>
 * @param string $encoding <p>
 * The encoding parameter is the encoding that words are expected to
 * be in. Valid values are 'utf-8', 'iso8859-*', 'koi8-r',
 * 'viscii', 'cp1252', 'machine unsigned 16', 'machine unsigned
 * 32'. This parameter is largely untested, so be careful when
 * using.
 * </p>
 * @return int Retuns a pspell config identifier.
 */
#[LanguageLevelTypeAware(['8.1' => 'PSpell\Config'], default: 'int')]
function pspell_config_create(string $language, string $spelling = "", string $jargon = "", string $encoding = "") {}