Class cmd_spell

Description

Command line spellcheck class, compatible with ispell and aspell.

Located in /plugins/squirrelspell/class/cmd_spell.php (line 33)

squirrelspell
   |
   --cmd_spell
Variable Summary
mixed $debug
string $temp_dir
mixed $userdic
boolean $use_proc_open
Method Summary
cmd_spell cmd_spell ([array $aParams = array()])
array check_text (string $sText)
mixed exec_spell (string $sText)
string prepare_text (string $sText)
mixed proc_open_spell (string $sText)
Variables
mixed $debug = false (line 51)
mixed $missed_words = array() (line 53)
string $spell_command = '' (line 37)
string $temp_dir = '' (line 48)
mixed $userdic = array() (line 38)
boolean $use_proc_open = false (line 44)

Controls which function is used to execute ispell. proc_open() should be used in PHP 4.3+. exec() can be used in older PHP versions.

Inherited Variables

Inherited from squirrelspell

squirrelspell::$error
Methods
Constructor cmd_spell (line 59)

Constructor function

cmd_spell cmd_spell ([array $aParams = array()])
  • array $aParams
check_text (line 212)

Checks block of text

array check_text (string $sText)
  • string $sText: text

Redefinition of:
squirrelspell::check_text()
exec_spell (line 149)
  • return: array with command output or false.
mixed exec_spell (string $sText)
  • string $sText
prepare_text (line 197)

Prepares string for ispell/aspell parsing

Function adds an extra space at the beginning of each line. This way ispell/aspell don't treat these as command characters.

string prepare_text (string $sText)
  • string $sText
proc_open_spell (line 96)
  • return: array with command output or false.
mixed proc_open_spell (string $sText)
  • string $sText

Inherited Methods

Inherited From squirrelspell

squirrelspell::check_text()
squirrelspell::set_error()

Documentation generated on Sat, 01 Nov 2014 04:17:19 +0100 by phpDocumentor 1.4.3