The PHP Spell Check Settings File

1. 1 Finding Your Settings File
2. 2 Creating A New Settings File
3. 3 Editing The Settings File
1. 3.1 Registration
2. 3.2 Basic Settings
3. 3.3 Basic Settings
4. 3.4 Suggestion Tolerance
5. 3.5 Suggestion Tolerance
6. 3.6 Dictionary Path
7. 3.7 Custom Vocabulary
8. 3.8 Banned Words
9. 3.9 Enforced Corrections
10. 3.10 Common Typing Mistakes

The settings file allows developers to fine tune the behavior of the spellchecker engine behind the SpellCheckButton and SpellAsYouType user interfaces.

Settings in this file are at server level - and so cannot be accessed though the usual APIs for security reasons.

Finding Your Settings File

The settings file is located at /phpspellcheck/core/settings/default-settings.php

• The settings file is written in PHP Code
• The settings file is well commented
• The file should be modified with reference to the PHP Spell Check Server-Side Class
• Care should be taken when modifying this file - as it may affect or stop the function of your spellcheckers.

Creating A New Settings File

1. Duplicate '/phpspellcheck/core/settings/default-settings.php
2. Rename to my-settings.php
3. In your SpellCheckButton and SpellAsYouType implementations set the SettingsFile property to 'my-settings'

Editing The Settings File

REGISTRATION

This allows you to apply a professional Live-Spell License Key.

• $spellcheckObject -> LicenceKey="TRIAL";

BASIC SETTINGS

This allows you to change the default values of basic spellchecking settings $spellcheckObject -> IgnoreAllCaps = false; $spellcheckObject -> IgnoreNumeric = false; $spellcheckObject -> CaseSensitive = true;

BASIC SETTINGS

This allows you to change the default values of basic spellchecking settings

• $spellcheckObject -> IgnoreAllCaps = false;
• $spellcheckObject -> IgnoreNumeric = false;
• $spellcheckObject -> CaseSensitive = true;

SUGGESTION TOLERANCE

Set the tollerance of the spellchecker to 'unlikely' suggestions. 0=few suggestions ... 10=more suggestions

• $spellcheckObject -> SuggestionTollerance = 1.5;

SUGGESTION TOLERANCE

Set the tollerance of the spellchecker to 'unlikely' suggestions. 0=few suggestions ... 10=more suggestions

• $spellcheckObject -> SuggestionTollerance = 1.5;

DICTIONARY PATH

Set up the file path to the (.dic) dictionaries folder

• $spellcheckObject -> DictionaryPath = ("../dictionaries/");

CUSTOM VOCABULARY

Add vocabulary to the spellchecker from a text file loaded from the DictionaryPath

• $spellcheckObject -> LoadCustomDictionary("custom.txt");
  • All words in this file are added to the vocabulary. 1 word per ascii line.

• $spellcheckObject -> LoadCustomDictionaryFromURL( $URL );
  • All words in this file (fetched as text) are added to the vocabulary. 1 word per ascii line. Useful for integration with other systems. May slow performance somewhat.

• $spellcheckObject ->AddCustomDictionaryFromArray($array) // This is great for SQL integration
  • All words in the array of strings are added to the vocabulary. This is great for SQL integration (populate the array from an SQL query)

BANNED WORDS

Ban a list of words which will never be allowed as correct spellings. This is great for filtering profanity.*/

• $spellcheckObject -> LoadCustomBannedWords("language-rules/banned-words.txt");

You can also add banned words from an array which you could easily populate from an SQL query

• $spellcheckObject -> AddBannedWords(array("veryRudeWord"));

Read more about Banned Words and Strict Legal Spellchecking...

ENFORCED CORRECTIONS

$spellcheckObject -> LoadEnforcedCorrections("language-rules/enforced-corrections.txt");

• The file is found relative to the DictionaryPath
• The enforced corrections can be sued to manually override the spelling suggestions for any word.

COMMON TYPING MISTAKES

• The file is found relative to the DictionaryPath
• Load a list of common typing mistakes to fine tune the suggestion performance