Référence de la classe Captcha

Graphe d'héritage de Captcha:

Fonctions membres publiques
	__construct ($captcha, $options)
	initialise ($id)
	display ($name, $id, $class='')
	checkAnswer ($code)
	setupField (\Joomla\CMS\Form\Field\CaptchaField $field, \SimpleXMLElement $element)
Fonctions membres publiques hérités de DispatcherAwareInterface
	setDispatcher (DispatcherInterface $dispatcher)

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

Fonctions membres privées
	update ($name, &$args)
	_load (array $options=array())

Attributs privés
	$captcha
	$name

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

Description détaillée

Joomla! Captcha base object

Depuis

2.5

Documentation des constructeurs et destructeur

__construct()

__construct	(		$captcha,
			$options
	)

Class constructor.

Paramètres

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

Depuis

2.5

Exceptions

Références $options, Factory\getApplication(), Joomla\CMS\Application\getDispatcher(), name, et Joomla\Event\setDispatcher().

Documentation des fonctions membres

_load()

_load ( array  $options = array() )

private

Load the Captcha plugin.

Paramètres

array

$options

Associative array of options.

Renvoie

void

Depuis

2.5

Exceptions

Références $name, $options, $params, $path, Joomla\CMS\Application\getDispatcher(), InputFilter\getInstance(), PluginHelper\getPlugin(), JPATH_PLUGINS, name, et Text\sprintf().

checkAnswer()

checkAnswer

(

$code

)

Checks if the answer is correct.

Paramètres

string

$code

The answer.

Renvoie

bool Whether the provided answer was correct

Depuis

2.5

Exceptions

Références $result, et null.

display()

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

Get the HTML for the captcha.

Paramètres

string	$name	The control name.
string	$id	The id for the control.
string	$class	Value for the HTML class attribute

Renvoie

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

Depuis

2.5

Exceptions

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

getInstance()

static 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

Captcha|null Instance of this class.

Depuis

2.5

Exceptions

Références $options.

Référencé par CaptchaField\setup(), et CaptchaRule\test().

initialise()

initialise

(

$id

)

Fire the onInit event to initialise the captcha plugin.

Paramètres

string

$id

The id of the field.

Renvoie

boolean True on success

Depuis

2.5

Exceptions

Références $id.

setupField()

setupField	(	\Joomla\CMS\Form\Field\CaptchaField	$field,
		\SimpleXMLElement	$element
	)

Method to react on the setup of a captcha field. Gives the possibility to change the field and/or the XML element for the field.

Paramètres

\Joomla\CMS\Form\Field\CaptchaField	$field	Captcha field instance
\SimpleXMLElement	$element	XML form definition

Renvoie

void

Références $field, $result, et null.

update()

update (   $name, &  $args  )

private

Method to call the captcha callback if it exist.

Paramètres

string	$name	Callback name
array	&$args	Arguments

Renvoie

mixed

Depuis

4.0.0

Références $name, et null.

Documentation des champs

$captcha

$captcha

private

$instances

$instances = array()

staticprivate

$name

$name

private

---

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

• Captcha.php