AfsHelperConfiguration Class Reference

Configuration class for AFS helper classes. More...

Inheritance diagram for AfsHelperConfiguration:

Public Member Functions
	__construct ()
	Constructs new configuration class with default parameters set.
Query coder
	has_query_coder ()
	Checks whether a query coder has been defined.
	get_query_coder ()
	Retrieves query coder.
	set_query_coder (AfsQueryCoderInterface $query_coder)
	Defines new query coder.
Reply text
	get_reply_text_visitor ()
	Retrieves reply text visitor.
	set_reply_text_visitor (AfsTextVisitorInterface $visitor)
	Defines new reply text visitor.
Spellcheck text
	get_spellcheck_text_visitor ()
	Retrieves spellcheck text visitor.
	set_spellcheck_text_visitor (AfsSpellcheckTextVisitorInterface $visitor)
	Defines new spellcheck text visitor.
Public Member Functions inherited from AfsConfigurationBase
	get_helper_format ()
	Retrieves reply helper format.
	is_array_format ()
	Checks whether helper format is set to ARRAYS.
	is_helper_format ()
	Checks whether helper format is set to HELPERS.
	set_helper_format ($format)
	Defines new reply helper format.
	get_user_session_manager ()
	Restrievs user and session id manager.
	set_user_sessionmanager (AfsUserSessionManager $user_session_mgr)
	Defines new user and session id manager.

Detailed Description

Configuration class for AFS helper classes.

Examples:

full_example.php.

Member Function Documentation

get_query_coder

(

)

Retrieves query coder.

Returns

query coder (see AfsQueryCoderInterface).

get_reply_text_visitor

(

)

Retrieves reply text visitor.

This visitor is used to format text for title and abstract replies.

Returns

reply text visitor (see AfsTextVisitorInterface).

get_spellcheck_text_visitor

(

)

Retrieves spellcheck text visitor.

Returns

spellcheck text visitor (see AfsSpellcheckTextVisitorInterface).

has_query_coder

(

)

Checks whether a query coder has been defined.

Returns

True when a query coder is defined, false otherwise.

set_query_coder

(

AfsQueryCoderInterface

$query_coder

)

Defines new query coder.

Parameters

$query_coder

[in] new query coder to set.

Returns

current instance.

set_reply_text_visitor

(

AfsTextVisitorInterface

$visitor

)

Defines new reply text visitor.

Parameters

$visitor

[in] new visitor to set

Returns

current instance.

set_spellcheck_text_visitor

(

AfsSpellcheckTextVisitorInterface

$visitor

)

Defines new spellcheck text visitor.

Parameters

$visitor

[in] new visitor to set.

Returns

current instance.