Antidot PHP API  version 0.16.0
##PHP API to simplify integration of Antidot components
 All Classes Files Functions Variables Groups Pages
Public Member Functions | List of all members
AfsSpellcheckBaseText Class Reference

Base class for AFS spellcheck texts. More...

Inheritance diagram for AfsSpellcheckBaseText:
AfsSpellcheckMatch AfsSpellcheckText

Public Member Functions

 __construct ($text, $pre='')
 Constructs instance.
 get_text ()
 Retrieves text.
 get_pre ()
 Retrieves prefix text.
 accept (AfsSpellcheckTextVisitorInterface $visitor)
 Accept visitors.

Detailed Description

Base class for AFS spellcheck texts.

It accepts AfsSpellcheckTextVisitorInterface visitor in order to retrieve raw and formatted spellcheck texts.

Constructor & Destructor Documentation

__construct (   $text,
  $pre = '' 
)

Constructs instance.

Parameters
$text[in] text of the instance.
$pre[in] prefix text which should never be highlighted (see AfsSpellcheckMatch for more details)

Member Function Documentation

accept ( AfsSpellcheckTextVisitorInterface  $visitor)

Accept visitors.

Parameters
$visitor[in] visitor which implements AfsSpellcheckTextVisitorInterface.
Returns
AfsRawAndFormattedText returned from visitor call.
Exceptions
Exceptionwhen necessary method has not been implemented in visitor.
get_pre ( )

Retrieves prefix text.

Returns
prefix text.
get_text ( )

Retrieves text.

Returns
text.