b2evolution

Multilingual multiuser multiblog engine

b2evolution Technical Documentation (CVS HEAD) [ class tree: main ] [ index: main ] [ all elements ]

Class: SpellChecker

Source Location: /blogs/plugins/tinymce_plugin/tiny_mce/plugins/spellchecker/classes/SpellChecker.php

Class SpellChecker

Class Overview

$Id: SpellChecker.php,v 1.1 2009/08/07 01:59:36 sam2kb Exp $

Located in /blogs/plugins/tinymce_plugin/tiny_mce/plugins/spellchecker/classes/SpellChecker.php [line 9]



		
				Author(s):
		
  • Moxiecode
Information Tags:
Copyright:  Copyright © 2004-2007, Moxiecode Systems AB, All rights reserved.

Methods

[ Top ]
Direct descendents
Child Class Description
GoogleSpell $Id: GoogleSpell.php,v 1.2 2009/08/09 03:08:08 sam2kb Exp $
PSpellShell $Id: PSpellShell.php,v 1.1 2009/08/07 01:59:36 sam2kb Exp $
EnchantSpell $Id: EnchantSpell.php,v 1.1 2009/08/07 01:59:36 sam2kb Exp $
PSpell $Id: PSpell.php,v 1.1 2009/08/07 01:59:36 sam2kb Exp $

[ Top ]
Method Summary
SpellChecker   SpellChecker()   Constructor.
{Array}   &checkWords()   Spellchecks an array of words.
{Array}   &getSuggestions()   Returns suggestions of for a specific word.
{Array}   &loopback()   Simple loopback function everything that gets in will be send back.
void   throwError()   Throws an error message back to the user. This will stop all execution.

[ Top ]
Methods
Constructor SpellChecker  [line 15]

  SpellChecker SpellChecker( $config &$config  )

Constructor.

Parameters:
$config   &$config:  Configuration name/value array.


[ Top ]
checkWords  [line 36]

  {Array} &checkWords( {String} $lang, {Array} $words  )

Spellchecks an array of words.

Parameters:
{String}   $lang:  Language code like sv or en.
{Array}   $words:  Array of words to spellcheck.

API Tags:
Return:  Array of misspelled words.


Redefined in descendants as:

[ Top ]
getSuggestions  [line 47]

  {Array} &getSuggestions( {String} $lang, {String} $word  )

Returns suggestions of for a specific word.

Parameters:
{String}   $lang:  Language code like sv or en.
{String}   $word:  Specific word to get suggestions for.

API Tags:
Return:  Array of suggestions for the specified word.


Redefined in descendants as:

[ Top ]
loopback  [line 25]

  {Array} &loopback( $args.. 0  )

Simple loopback function everything that gets in will be send back.

Parameters:
$args..   0:  Arguments.

API Tags:
Return:  Array of all input arguments.


[ Top ]
throwError  [line 56]

  void throwError( {String} $str  )

Throws an error message back to the user. This will stop all execution.

Parameters:
{String}   $str:  Message to send back to user.


[ Top ]

Documentation generated on Sat, 06 Mar 2010 03:57:40 +0100 by phpDocumentor 1.4.2. This site is hosted and maintained by Daniel HAHLER (Contact).