XoopsCaptcha Class Reference

Public Member Functions
	loadConfig ($methodname=null)
	isActive ()
	loadHandler ($name=null)
	setConfigs ($configs)
	setConfig ($name, $val)
	verify ($skipMember=null, $name=null)
	getCaption ()
	getMessage ()
	destroyGarbage ($clearSession=false)
	render ()
	renderValidationJS ()
	setCode ($code=null)
	loadForm ()

Static Public Member Functions
static	getInstance ()

Data Fields
	$active
	$handler
	$path_basic
	$path_config
	$path_plugin
	$name
	$config = array()
	$message = array()

Protected Member Functions
	__construct ()

Detailed Description

Class XoopsCaptcha

Constructor & Destructor Documentation

__construct()

__construct ( )

protected

construct

Here is the call graph for this function:

Member Function Documentation

destroyGarbage()

destroyGarbage

(

$clearSession = false

)

Destroy historical stuff

Parameters

bool

$clearSession

Returns

bool

Here is the call graph for this function:

Here is the caller graph for this function:

getCaption()

getCaption

(

)

XoopsCaptcha::getCaption()

Returns

mixed|string

getInstance()

static getInstance ( )

static

Get Instance

Returns

XoopsCaptcha Instance

Here is the caller graph for this function:

getMessage()

getMessage

(

)

XoopsCaptcha::getMessage()

Returns

string

isActive()

isActive

(

)

XoopsCaptcha::isActive()

Returns

bool

Here is the call graph for this function:

Here is the caller graph for this function:

loadConfig()

loadConfig

(

$methodname = null

)

XoopsCaptcha::loadConfig()

Parameters

string | null

$methodname

the captcha method, i.e. text, image, recaptcha2, etc

Returns

array

Here is the caller graph for this function:

loadForm()

loadForm

(

)

XoopsCaptcha::loadForm()

Returns

Here is the call graph for this function:

Here is the caller graph for this function:

loadHandler()

loadHandler

(

$name = null

)

XoopsCaptcha::loadHandler()

Parameters

mixed

$name

Returns

Here is the caller graph for this function:

render()

render

(

)

XoopsCaptcha::render()

Returns

string

Here is the call graph for this function:

renderValidationJS()

renderValidationJS

(

)

XoopsCaptcha::renderValidationJS()

Returns

string

setCode()

setCode

(

$code = null

)

XoopsCaptcha::setCode()

Parameters

mixed

$code

Returns

bool

Here is the caller graph for this function:

setConfig()

setConfig	(		$name,
			$val
	)

XoopsCaptcha::setConfig()

Parameters

mixed	$name
mixed	$val

Returns

bool

Here is the caller graph for this function:

setConfigs()

setConfigs

(

$configs

)

XoopsCaptcha::setConfigs()

Parameters

mixed

$configs

Returns

bool

Here is the call graph for this function:

verify()

verify	(		$skipMember = null,
			$name = null
	)

Verify user submission XoopsCaptcha::verify()

Parameters

mixed	$skipMember
mixed	$name

Returns

bool

Here is the call graph for this function:

Field Documentation

$active

$active

$config

$config = array()

$handler

$handler

$message

$message = array()

$name

$name

$path_basic

$path_basic

$path_config

$path_config

$path_plugin

$path_plugin

---

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

• C:/xoops2511b2/htdocs/class/captcha/xoopscaptcha.php