TYPO3 CMS  TYPO3_6-2
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController Class Reference
Inheritance diagram for TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController:
tx_rtehtmlarea_pi1

Public Member Functions

 main ()
 
 startHandler ($xml_parser, $tag, $attributes)
 
 endHandler ($xml_parser, $tag)
 
 spellCheckHandler ($xml_parser, $string)
 
 collectDataHandler ($xml_parser, $string)
 
 defaultHandler ($xml_parser, $string)
 

Public Attributes

 $extKey = 'rtehtmlarea'
 
 $siteUrl
 
 $charset = 'utf-8'
 
 $parserCharset = 'utf-8'
 
 $defaultAspellEncoding = 'utf-8'
 
 $aspellEncoding
 
 $result
 
 $text
 
 $misspelled = array()
 
 $suggestedWords
 
 $wordCount = 0
 
 $suggestionCount = 0
 
 $suggestedWordCount = 0
 
 $pspell_link
 
 $pspellMode = 'normal'
 
 $dictionary
 
 $AspellDirectory
 
 $pspell_is_available
 
 $forceCommandMode = 0
 
 $filePrefix = 'rtehtmlarea_'
 
 $xmlCharacterData = ''
 

Protected Member Functions

 setMainDictionaryPath ()
 
 getMainDictionaryCharacterSet ()
 
 setPersonalDictionaryPath ()
 
 fixPersonalDictionaryCharacterSet ()
 

Protected Attributes

 $csConvObj
 
 $uploadFolder = 'uploads/tx_rtehtmlarea/'
 
 $mainDictionaryPath
 
 $personalDictionaryPath
 

Detailed Description

Spell checking plugin 'tx_rtehtmlarea_pi1' for the htmlArea RTE extension.

Author
Stanislas Rolland <typo3(arobas)sjbr.ca>

Definition at line 24 of file SpellCheckingController.php.

Member Function Documentation

◆ collectDataHandler()

TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController::collectDataHandler (   $xml_parser,
  $string 
)
Todo:
Define visibility

Definition at line 642 of file SpellCheckingController.php.

◆ defaultHandler()

TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController::defaultHandler (   $xml_parser,
  $string 
)
Todo:
Define visibility

Definition at line 649 of file SpellCheckingController.php.

◆ endHandler()

TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController::endHandler (   $xml_parser,
  $tag 
)
Todo:
Define visibility

Definition at line 521 of file SpellCheckingController.php.

References TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController\spellCheckHandler().

◆ fixPersonalDictionaryCharacterSet()

TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController::fixPersonalDictionaryCharacterSet ( )
protected

Ensures that the personal dictionary is utf-8 encoded

Returns
void

Definition at line 448 of file SpellCheckingController.php.

References TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController\$result, and TYPO3\CMS\Core\Utility\GeneralUtility\SYSLOG_SEVERITY_ERROR.

Referenced by TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController\main().

◆ getMainDictionaryCharacterSet()

TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController::getMainDictionaryCharacterSet ( )
protected

Gets the character set the main dictionary

Returns
string character set the main dictionary

Definition at line 374 of file SpellCheckingController.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\SYSLOG_SEVERITY_ERROR, and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController\main().

◆ main()

TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController::main ( )

Main class of Spell Checker plugin for Typo3 CMS

Returns
string content produced by the plugin
Todo:
Define visibility

Definition at line 152 of file SpellCheckingController.php.

References TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController\$defaultAspellEncoding, TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController\$dictionary, $GLOBALS, TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController\$misspelled, TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController\$parserCharset, TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController\$pspellMode, TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController\$result, TYPO3\CMS\Core\Utility\GeneralUtility\_POST(), die, TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController\fixPersonalDictionaryCharacterSet(), TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController\getMainDictionaryCharacterSet(), TYPO3\CMS\Core\Utility\GeneralUtility\inList(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), TYPO3\CMS\Core\Utility\GeneralUtility\quoteJSvalue(), TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController\setMainDictionaryPath(), TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController\setPersonalDictionaryPath(), TYPO3\CMS\Core\Utility\ExtensionManagementUtility\siteRelPath(), TYPO3\CMS\Core\Utility\GeneralUtility\SYSLOG_SEVERITY_ERROR, TYPO3\CMS\Core\Utility\GeneralUtility\tempnam(), TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode(), TYPO3_MODE, and TYPO3\CMS\Core\Utility\GeneralUtility\unlink_tempfile().

◆ setMainDictionaryPath()

TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController::setMainDictionaryPath ( )
protected

Sets the path to the main dictionary

Returns
string path to the main dictionary

Definition at line 356 of file SpellCheckingController.php.

References TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController\$mainDictionaryPath, and TYPO3\CMS\Core\Utility\GeneralUtility\SYSLOG_SEVERITY_ERROR.

Referenced by TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController\main().

◆ setPersonalDictionaryPath()

TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController::setPersonalDictionaryPath ( )
protected

Sets the path to the personal dictionary

Returns
string path to the personal dictionary

Definition at line 416 of file SpellCheckingController.php.

References $GLOBALS, TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController\$personalDictionaryPath, TYPO3\CMS\Core\Utility\GeneralUtility\_POST(), TYPO3\CMS\Core\Resource\ResourceFactory\getInstance(), and TYPO3_MODE.

Referenced by TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController\main().

◆ spellCheckHandler()

TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController::spellCheckHandler (   $xml_parser,
  $string 
)
Todo:
Define visibility

Definition at line 557 of file SpellCheckingController.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\tempnam(), TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode(), and TYPO3\CMS\Core\Utility\GeneralUtility\unlink_tempfile().

Referenced by TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController\endHandler(), and TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController\startHandler().

◆ startHandler()

TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController::startHandler (   $xml_parser,
  $tag,
  $attributes 
)
Todo:
Define visibility

Definition at line 480 of file SpellCheckingController.php.

References TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController\spellCheckHandler().

Member Data Documentation

◆ $AspellDirectory

TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController::$AspellDirectory
Todo:
Define visibility

Definition at line 115 of file SpellCheckingController.php.

◆ $aspellEncoding

TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController::$aspellEncoding
Todo:
Define visibility

Definition at line 60 of file SpellCheckingController.php.

◆ $charset

TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController::$charset = 'utf-8'
Todo:
Define visibility

Definition at line 45 of file SpellCheckingController.php.

◆ $csConvObj

TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController::$csConvObj
protected

Definition at line 29 of file SpellCheckingController.php.

◆ $defaultAspellEncoding

TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController::$defaultAspellEncoding = 'utf-8'
Todo:
Define visibility

Definition at line 55 of file SpellCheckingController.php.

Referenced by TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController\main().

◆ $dictionary

TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController::$dictionary
Todo:
Define visibility

Definition at line 110 of file SpellCheckingController.php.

Referenced by TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController\main().

◆ $extKey

TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController::$extKey = 'rtehtmlarea'
Todo:
Define visibility

Definition at line 35 of file SpellCheckingController.php.

◆ $filePrefix

TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController::$filePrefix = 'rtehtmlarea_'
Todo:
Define visibility

Definition at line 130 of file SpellCheckingController.php.

◆ $forceCommandMode

TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController::$forceCommandMode = 0
Todo:
Define visibility

Definition at line 125 of file SpellCheckingController.php.

◆ $mainDictionaryPath

TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController::$mainDictionaryPath
protected

Definition at line 136 of file SpellCheckingController.php.

Referenced by TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController\setMainDictionaryPath().

◆ $misspelled

TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController::$misspelled = array()
Todo:
Define visibility

Definition at line 75 of file SpellCheckingController.php.

Referenced by TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController\main().

◆ $parserCharset

TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController::$parserCharset = 'utf-8'
Todo:
Define visibility

Definition at line 50 of file SpellCheckingController.php.

Referenced by TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController\main().

◆ $personalDictionaryPath

TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController::$personalDictionaryPath
protected

Definition at line 139 of file SpellCheckingController.php.

Referenced by TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController\setPersonalDictionaryPath().

◆ $pspell_is_available

TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController::$pspell_is_available
Todo:
Define visibility

Definition at line 120 of file SpellCheckingController.php.

◆ $pspell_link

TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController::$pspell_link
Todo:
Define visibility

Definition at line 100 of file SpellCheckingController.php.

◆ $pspellMode

TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController::$pspellMode = 'normal'
Todo:
Define visibility

Definition at line 105 of file SpellCheckingController.php.

Referenced by TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController\main().

◆ $result

TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController::$result
Todo:
Define visibility

Definition at line 65 of file SpellCheckingController.php.

Referenced by TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController\fixPersonalDictionaryCharacterSet(), and TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController\main().

◆ $siteUrl

TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController::$siteUrl
Todo:
Define visibility

Definition at line 40 of file SpellCheckingController.php.

◆ $suggestedWordCount

TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController::$suggestedWordCount = 0
Todo:
Define visibility

Definition at line 95 of file SpellCheckingController.php.

◆ $suggestedWords

TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController::$suggestedWords
Todo:
Define visibility

Definition at line 80 of file SpellCheckingController.php.

◆ $suggestionCount

TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController::$suggestionCount = 0
Todo:
Define visibility

Definition at line 90 of file SpellCheckingController.php.

◆ $text

TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController::$text
Todo:
Define visibility

Definition at line 70 of file SpellCheckingController.php.

◆ $uploadFolder

TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController::$uploadFolder = 'uploads/tx_rtehtmlarea/'
protected

Definition at line 133 of file SpellCheckingController.php.

◆ $wordCount

TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController::$wordCount = 0
Todo:
Define visibility

Definition at line 85 of file SpellCheckingController.php.

◆ $xmlCharacterData

TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController::$xmlCharacterData = ''
Todo:
Define visibility

Definition at line 144 of file SpellCheckingController.php.