Référence de la classe JCaptcha

Graphe d'héritage de JCaptcha:

Graphe de collaboration de JCaptcha:

Liste de tous les membres

Fonctions membres publiques
	__construct ($captcha, $options)
	initialise ($id)
	display ($name, $id, $class= '')
	checkAnswer ($code)
	getState ()
	attach ($observer)
	detach ($observer)
Fonctions membres publiques inherited from JObject
	__construct ($properties=null)
	__toString ()
	def ($property, $default=null)
	get ($property, $default=null)
	getProperties ($public=true)
	getError ($i=null, $toString=true)
	getErrors ()
	set ($property, $value=null)
	setProperties ($properties)
	setError ($error)
	toString ()

Fonctions membres publiques statiques
static	getInstance ($captcha, array $options=array())

Attributs protégés
	$_observers = array()
	$_state = null
	$_methods = array()
Attributs protégés inherited from JObject
	$_errors = array()

Fonctions membres privées
	_load (array $options=array())

Attributs privés
	$_captcha
	$_name

Attributs privés statiques
static	$_instances = array()

---

Documentation des constructeurs et destructeur

JCaptcha::__construct	(		$captcha,
			$options
	)

Class constructor.

Paramètres:

string	$editor	The editor to use.
array	$options	Associative array of options.

Depuis:

2.5

Références $options.

---

Documentation des fonctions membres

JCaptcha::_load ( array  $options = array() )

private

Load the Captcha plug-in.

Paramètres:

array

$options

Associative array of options.

Renvoie:

void

Depuis:

2.5

Exceptions:

RuntimeException

Références $name, $options, $params, $path, JFile\exists(), JFilterInput\getInstance(), JPluginHelper\getPlugin(), JPATH_PLUGINS, et JText\sprintf().

Voici le graphe d'appel pour cette fonction :

JCaptcha::attach

(

$observer

)

Attach an observer object

Paramètres:

object

$observer

An observer object to attach

Renvoie:

void

Depuis:

2.5

Références $check, $class, et $key.

JCaptcha::checkAnswer

(

$code

)

Checks if the answer is correct.

Renvoie:

the return value of the function "onCheckAnswer" of the selected Plugin.

Depuis:

2.5

JCaptcha::detach

(

$observer

)

Detach an observer object

Paramètres:

object

$observer

An observer object to detach.

Renvoie:

boolean True if the observer object was detached.

Depuis:

2.5

Références $key.

JCaptcha::display	(		$name,
			$id,
			$class = ''
	)

Get the HTML for the captcha.

Renvoie:

the return value of the function "onDisplay" of the selected Plugin.

Depuis:

2.5

Références $class, $id, et $name.

static JCaptcha::getInstance (   $captcha, array  $options = array()  )

static

Returns the global Captcha object, only creating it if it doesn't already exist.

Paramètres:

string	$captcha	The plugin to use.
array	$options	Associative array of options.

Renvoie:

object The JCaptcha object.

Depuis:

2.5

Références $options, JFactory\getApplication(), et null.

Référencé par JFormFieldCaptcha\getInput(), et JFormRuleCaptcha\test().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

JCaptcha::getState

(

)

Get the state of the JEditor object

Renvoie:

mixed The state of the object.

Depuis:

2.5

JCaptcha::initialise

(

$id

)

Renvoie:

boolean True on success

Depuis:

2.5

Références $id, et JFactory\getApplication().

Voici le graphe d'appel pour cette fonction :

---

Documentation des données membres

JCaptcha::$_captcha

private

JCaptcha::$_instances = array()

staticprivate

JCaptcha::$_methods = array()

protected

JCaptcha::$_name

private

JCaptcha::$_observers = array()

protected

JCaptcha::$_state = null

protected

---

La documentation de cette classe a été générée à partir du fichier suivant :

• captcha/captcha.php