JavaScript & AJAX API

1. 1 Installation outside of PHP Applications
2. 2 Scripting & PHPSpellCheck
3. 3 Class LiveSpellInstance
1. 3.1 Core Properties
1. 3.1.1 CaseSensitive
2. 3.1.2 CheckGrammar
3. 3.1.3 CSSTheme
4. 3.1.4 Fields
5. 3.1.5 FormToSubmit
6. 3.1.6 IgnoreAllCaps
7. 3.1.7 IgnoreNumeric
8. 3.1.8 Language
9. 3.1.9 SettingsFile
10. 3.1.10 UserInterfaceLanguage
2. 3.2 Setup Properties
1. 3.2.1 CustomOpener
2. 3.2.2 CustomOpenerClose
3. 3.2.3 ServerModel
4. 3.2.4 Delay
5. 3.2.5 WindowMode
6. 3.2.6 Strict
7. 3.2.7 ShowSummaryScreen
8. 3.2.8 ShowMeanings
9. 3.2.9 MeaningProvider
10. 3.2.10 UndoLimit
11. 3.2.11 HiddenButtons
3. 3.3 Methods
1. 3.3.1 checkInWindow()
2. 3.3.2 checkInSitu()
3. 3.3.3 activateAsYouType()
4. 3.3.4 pauseAsYouType()
4. 3.4 Rendering Methods
1. 3.4.1 url()
2. 3.4.2 DrawSpellButton ([inPlace] [,text] [,Class] [,style] )
3. 3.4.3 DrawSpellImageButton ([inPlace] [,image] [,rollover] [,text] [,Class] [,style])
4. 3.4.4 DrawSpellLink ([inPlace] [,text] [,Class] [,style])
5. 3.4.5 SpellButton ([inPlace][,text][,Class][,style])
6. 3.4.6 SpellLink ([inPlace][,text][,Class][,style])
7. 3.4.7 SpellImageButton ([inPlace][,image,][,rolloverImage][,Class][,style])
5. 3.5 Javascript Events
1. 3.5.1 onDialogOpen()
2. 3.5.2 onDialogComplete()
3. 3.5.3 onDialogCancel()
4. 3.5.4 onDialogClose()
5. 3.5.5 onChangeLanguage(Language)
6. 3.5.6 onIgnore (Word)
7. 3.5.7 onIgnoreAll (Word)
8. 3.5.8 onChangeWord (From, To)
9. 3.5.9 onChangeAll (From, To)
10. 3.5.10 onLearnWord (Word)
11. 3.5.11 onLearnAutoCorrect(From,To)
12. 3.5.12 onUpdateFields(arrayOfFieldIds)
6. 3.6 AJAX Methods
1. 3.6.1 AjaxSpellCheck(word, makeSuggestions)
2. 3.6.2 AjaxSpellCheckArray(arrayOfWords, makeSuggestions)
3. 3.6.3 AjaxDidYouMean(inputString)
7. 3.7 AJAX Events & Callbacks
1. 3.7.1 onSpellCheck (word, spelling, reason, suggestions)
2. 3.7.2 onDidYouMean(suggestion, original)

For Runtime control and integration with non PHP Languages

• Fully featured JavaScript API and
• Detailed event model.
• AJAX spell-checker API allowing - allowing you to build custom form validation and UI elements in minutes.

Installation outside of PHP Applications

The JavaScript API allows developers the choice to use all of PHPSpellCheck's functionality using JavaScript as the integration language. This also allows PHPSpellCheck to be implemented within non-php applications.

1. Ensure that phpspellcheck is installed in the website root (and test this installation using the examples).
2. Use JavaScript to implement PHPSpellCheck. Example code in javascript can be generated using the API explorer on our homepage

e.g.

<script src="/phpspellcheck/include.js' type='text/javascript'></script>
<script type='text/javascript'>
var mySpell = new LiveSpellInstance();
mySpell.Fields = "ALL"
mySpell.DrawSpellImageButton()
mySpell.ActivateAsYouType()
</script>

Scripting & PHPSpellCheck

You can access your existing PHPSpellCheck AsYouType and SpellButton objects in JavaScript using their ID attribute as their JavaScript object name. Both the AsYouType and SpellButton PHP objects create an instance of the JavaScript LiveSpellObject class documented below.

<?php
        require "/phpspellcheck/include.php";   
        $mySpell = new SpellCheckButton();
        $mySpell->InstallationPath = "/phpspellcheck/";  
        echo $mySpell->SpellImageButton();
?>      
        
<script type='text/javascript'>
        var mySpellObject = <?php echo ($mySpell->ID)?>;

        mySpellObject.onDialogOpen = function(){
                alert("onDialogOpen event fired")               
        }

</script>

Class LiveSpellInstance

Core Properties

CaseSensitive

• Consider case mistakes when spellchecking.
  • (bool) [Default Value: true]

CheckGrammar

• Check for structural grammar errors such as repeated words, and sentence casing.
  • (bool) [Default Value: true]

CSSTheme

• Theme for the spell-checker UI context menu and spelling dialog window.
• Maps to a folder name within /phpspellcheck/themes/
• See the Skinning tutorial
  • (string) [Default Value: ""]

Fields

• Set the html elements to be spell-checked by this instance.
• Multiple fields may be set using:
  • a "comma,separated,list" or
  • array("an","array","of","ids").
• Each field must have an InnerHTML or Value property.
  • (string) [Default Value: "ALL"] (all text-areas and text inputs on the page)

FormToSubmit

• A form id to submit upon successful spellchecking using the dialog.
  • (string) [Default Value: ""]

IgnoreAllCaps

• Ignore ALL CAPITALIZED words.
  • (bool) [Default Value: true]

IgnoreNumeric

• Ignore strings with numbers in them which are often product codes or serial numbers.
• E.g. HSH-S872-282P
  • (bool) [Default Value: true]

Language

• [Dictionary] language to be used for spellchecking.
• This maps to a ".dic" dictionary in your /phpspellcheck/dictionaries directory
• Exclude the ".dic" file extension in the value
• Multiple languages can be set simultaneously using a comma separated list
  • E.g. "English (International), Svenska"

SettingsFile

• Low level Settings File used to set up the spellchecker UI.
• Maps to a file in /phpspellcheck/settings
  • (string)[Default Value: "default-settings" ]

UserInterfaceLanguage

• Language of the user interface dialog and context menu.
• See the User Interface Language guide for all values and details on customization.
  • (string)[Default Value: "en" ]

Setup Properties

CustomOpener

• Set a custom function which can be set to override the regular spell-checker window opening method.
• Also see function url()
  • (function)[Default Value: null]

CustomOpenerClose

• Set a custom function called when spellchecking in a CustomOpener scenario is completed.
  • (function)[Default Value: null]

ServerModel

• Server hypertext processing language.
  • (string)[Default Value: "php"]

Delay

• Delay in milliseconds between the user finishing typing and As-You-Type fields having their spelling re-validated.
  • (int)[Default Value: 888]

WindowMode

Sets the behavior of the spellchecker dialog to either:

• "modal" - a floating toolbar linked to the opening page
• "popup" - a popup browser window
  • (string)[Default Value: "modal"]

Strict

• Enforces Banned Words and Enforced Corrections such that they cannot be ignored by the user.
  • (bool)[Default Value: true]

ShowSummaryScreen

• Shows a summary of statistics after a spell checker dialog has successfully finished.
  • (bool)[Default Value: true]

ShowMeanings

• Shows the meaning of words and thesaurus using the "Lookup meaning..." link in the spell checker dialog.
• Also see MeaningProvider
  • (bool)[Default Value: true]

MeaningProvider

• The URL expression that the meaning lookup will go to for definitions and synonyms
  • (string)[Default Value: "http://www.thefreedictionary.com/{word}" ]

UndoLimit

• Maximum remembered levels of user undo.
  • (int)[Default Value: 20]

HiddenButtons

• A "comma,separated,list" of buttons to be removed from the spell-checker dialog and context menu - identified by their id
  • (string)[Default Value: ""]

Methods

checkInWindow()

• Spell checks your Fields in a pop-up dialog window.
  • Arguments: none
  • Returns: null

checkInSitu()

• Spell checks your text-area fields in place using red-wiggly-underlining and a context menu.
  • Arguments: none
  • Returns: null

activateAsYouType()

• Arguments: none
• Returns: null

pauseAsYouType()

• Pauses the behavior started by the activateAsYouType function
  • Arguments: none
  • Returns: null

Rendering Methods

url()

• Returns the URL used to open the spell-checker dialog window.
  • Arguments: none
  • Returns: (string)

DrawSpellButton ([inPlace] [,text] [,Class] [,style] )

• document.writes a SpellButton
  • Arguments: see SpellButton function
  • Returns: null - writes an element to the HTML DOM

DrawSpellImageButton ([inPlace] [,image] [,rollover] [,text] [,Class] [,style])

• document.writes a SpellImageButton
  • Arguments: see SpellImageButton function
  • Returns: null - writes an element to the HTML DOM

DrawSpellLink ([inPlace] [,text] [,Class] [,style])

• document.writes a SpellLink
  • Arguments: see SpellLink function
  • Returns: null - writes an element to the HTML DOM

SpellButton ([inPlace][,text][,Class][,style])

• Returns an HTML string for a form button that will open a spellchecker.
• Also see DrawSpellButton.
• Arguments:
  • inPlace (boolean) [Default Value:false]. Spell-check will take place in the context of the text area (true) - or in a popup window (false)
  • text (string) [Default Value:"Spell Check"] - the value attribute of the button
  • Class (string) [Default Value:""] CSS class to be applied to the button
  • style (string) [Default Value:""] The CSS style attribute to be applied to the button

SpellLink ([inPlace][,text][,Class][,style])

• Returns an HTML string for a hyperlink that will open a spell-checker.
• Also see DrawSpellLink.
• Arguments:
  • inPlace (boolean) [Default Value:false]. Spell-check will take place in the context of the text area (true) - or in a popup window (false)
  • text (string) [Default Value:"Spell Check"] - the value attribute of the button
  • Class (string) [Default Value:""] CSS class to be applied to the button
  • style (string) [Default Value:""] The CSS style attribute to be applied to the button

SpellImageButton ([inPlace][,image,][,rolloverImage][,Class][,style])

• Returns an HTML string for an image with rollover effect that will open a spellchecker. Also see *DrawSpellImageButton.
• Arguments:
  • inPlace (boolean) [Default Value:false]. Spell-check will take place in the context of the text area (true) - or in a popup window (false)
  • text (string) [Default Value:"Spell Check"] - the value attribute of the button
  • image (string) [Default Value:""] - image of the button. If unset uses a standard image.
  • rolloverImage (string) [Default Value:""] - rollover image of the button.
  • Class (string) [Default Value:""] CSS class to be applied to the button
  • style (string) [Default Value:""] The CSS style attribute to be applied to the button

Javascript Events

onDialogOpen()

• Spellchecker dialog is opened.

onDialogComplete()

• Spellchecker dialog completes spellchecking all words.

onDialogCancel()

• Spellchecker dialog is cancelled before spellchecking all words.

onDialogClose()

• Spellchecker dialog closes for any reason.

onChangeLanguage(Language)

• User changes the selected dictionary language in either a dialog window or context menu.

onIgnore (Word)

• A word is ignored by the user.
  • Arguments: (string) Word

onIgnoreAll (Word)

• The users tells the spellchecker to "Ignore All"
  • Arguments: (string) Word

onChangeWord (From, To)

• The user corrects a word's spelling.
  • Arguments: (string) From, (string) To

• The user corrects a word's spelling.
  • Arguments: (string) From, (string) To

onChangeAll (From, To)

• The user corrects a words spelling and applies that change globally across all current fields.
  • Arguments: (string) From, (string) To

onLearnWord (Word)

• A words is added to the user's own personal dictionary.
  • Arguments: (string) Word

onLearnAutoCorrect(From,To)

• A words is added to the user's own personal auto-correct.
  • Arguments: (string) From, (string) To

onUpdateFields(arrayOfFieldIds)

• A form field is updated due to spellchecking. The fields affected are listed in the arrayofFieldIds array.
  • Arguments: (array) arrayofFieldIds. An array of strings of the fields which have been updated.

AJAX Methods

AjaxSpellCheck(word, makeSuggestions)

• Makes an AJAX request to spell-check the word.
• Results are returned asynchronously to the onSpellCheck callback event.
• Spelling suggestions are only returned to onSpellCheck if makeSuggestions is true.
  • Arguments: (string) word, (bool) makeSuggestions
  • Returns null - results are sent to the onSpellCheck event

AjaxSpellCheckArray(arrayOfWords, makeSuggestions)

• Arguments: (array) arrayOfWords, (bool) makeSuggestions
• Returns null - results are sent to the onSpellCheck event

AjaxDidYouMean(inputString)

• Requests the most likely "Did You Mean..." search query string for inputString.
• Results are returned asynchronously to the onDidYouMean event.
  • Arguments: (string) inputString
  • Returns null - results are sent to the onDidYouMean event

AJAX Events & Callbacks

onSpellCheck (word, spelling, reason, suggestions)

• Callback function for the ajaxSpellCheck method (also ajaxSpellCheckArray, see below)
• Arguments:
  • (string) word. The word which was spell checked.
  • (bool) Spelling - a boolean spellchecking result.
  • (char) reason is the reason for spelling failure:
    • "E" - Enforced Correction
    • "B" - Word is on your banned words list
    • "C" - A CaSe Mistake
    • "X" - (infrequent) Unlicensed software
    • "S" - Spelling mistake. Not found in any dictionary and none of the above cases apply.
    • "" - Spelling was correct
  • (array) suggestions - returns a sorted array of spelling suggestion is probability order. Will be empty if makeSuggestions was set false in the calling function.

onDidYouMean(suggestion, original)

• Callback function for the AjaxDidYouMean function.
• Arguments:
  • (string) suggestion:
    • If spelling of the original is not valid - a suggestion string will be returned.
    • If spelling is valid - the suggestion will be an empty string.
  • (string) original - the original AjaxDidYouMean inputString