axCaptcha Class Reference

Public Member Functions
	__construct (array $options=array())
	Constructor.
	generate ($lang)
	Generates a captcha for the given lang.
	verify ($answer)
	Verify the answer agains the last generated question.
Protected Member Functions
	_parseDictionnary ($path)
	Parses the dictionnary pointed by $path and saves the parse results in class cache.
Protected Attributes
	$_options
	Internal configuration.
	$_dictionnary_struct
	$_session
	axSession handle

---

Detailed Description

Definition at line 32 of file axCaptcha.class.php.

---

Constructor & Destructor Documentation

axCaptcha::__construct

(

array $

options = array()

)

Constructor.

Parameters:

array

$config

[optional] [default array()] The configuration

Definition at line 56 of file axCaptcha.class.php.

---

Member Function Documentation

axCaptcha::_parseDictionnary

(

$

path

)

[protected]

Parses the dictionnary pointed by $path and saves the parse results in class cache.

The dictionnary file will be parsed using PHP parse_ini_file.

Parameters:

string

$path

The dictionnary path

Exceptions:

RuntimeException

If the file cannot be parsed

Returns:

void

Definition at line 76 of file axCaptcha.class.php.

axCaptcha::generate

(

$

lang

)

Generates a captcha for the given lang.

Returns the question after storing the answer in session for next use.

Parameters:

string

$lang

The question language

Exceptions:

axMissingFileException	If the dictionnary file doesn't exists
RuntimeException	If the given langugage is not found in the dictionnary

Returns:

string

Definition at line 91 of file axCaptcha.class.php.

axCaptcha::verify

(

$

answer

)

Verify the answer agains the last generated question.

Return true if the provided answer match any of possible question results.

See also:

axCaptcha::generate

Parameters:

string

$answer

The input field provided by the form

Returns:

boolean

Definition at line 142 of file axCaptcha.class.php.

---

Field Documentation

axCaptcha::$_dictionnary_struct [protected]

Definition at line 44 of file axCaptcha.class.php.

array axCaptcha::$_options [protected]

Internal configuration.

Definition at line 38 of file axCaptcha.class.php.

axSession axCaptcha::$_session [protected]

axSession handle

Definition at line 50 of file axCaptcha.class.php.

---

The documentation for this class was generated from the following file:

• H:/Workspace/php-axiom/www/php-axiom/libraries/axiom/axCaptcha.class.php