Class JCaptcha

Joomla! Captcha base object

JObject

JCaptcha

Package: Joomla\Libraries\Captcha
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE.txt
Since: 2.5
Located at cms/captcha/captcha.php

Methods summary

`public`	# `__construct( string $captcha, array $options )` Class constructor. Class constructor. Parameters `$captcha` `string` - $captcha The editor to use. `$options` `array` - $options Associative array of options. Since 2.5 Overrides `JObject::__construct`
`public static JCaptcha\|null`	# `getInstance( string $captcha, array $options = array() )` Returns the global Captcha object, only creating it if it doesn't already exist. Returns the global Captcha object, only creating it if it doesn't already exist. Parameters `$captcha` `string` - $captcha The plugin to use. `$options` `array` - $options Associative array of options. Returns `JCaptcha\|null` - Instance of this class. Since 2.5
`public boolean`	# `initialise( string $id )` Fire the onInit event to initialise the captcha plugin. Fire the onInit event to initialise the captcha plugin. Parameters `$id` `string` - $id The id of the field. Returns `boolean` - True on success Since 2.5
`public mixed`	# `display( string $name, string $id, string $class = '' )` Get the HTML for the captcha. Get the HTML for the captcha. Parameters `$name` `string` - $name The control name. `$id` `string` - $id The id for the control. `$class` `string` - $class Value for the HTML class attribute Returns `mixed` - The return value of the function "onDisplay" of the selected Plugin. Since 2.5
`public mixed`	# `checkAnswer( string $code )` Checks if the answer is correct. Checks if the answer is correct. Parameters `$code` `string` - $code The answer. Returns `mixed` - The return value of the function "onCheckAnswer" of the selected Plugin. Since 2.5
`public mixed`	# `getState( )` Get the state of the JEditor object Get the state of the JEditor object Returns `mixed` - The state of the object. Since 2.5
`public`	# `attach( object $observer )` Attach an observer object Attach an observer object Parameters `$observer` `object` - $observer An observer object to attach Since 2.5
`public boolean`	# `detach( object $observer )` Detach an observer object Detach an observer object Parameters `$observer` `object` - $observer An observer object to detach. Returns `boolean` - True if the observer object was detached. Since 2.5

Methods inherited from JObject

__toString(), def(), get(), getError(), getErrors(), getProperties(), set(), setError(), setProperties()

Magic methods summary

Properties summary

`protected array`	`$_observers`	# An array of Observer objects to notify An array of Observer objects to notify Since 2.5
`protected mixed`	`$_state`	# The state of the observable object The state of the observable object Since 2.5
`protected array`	`$_methods`	# A multi dimensional array of [function][] = key for observers A multi dimensional array of [function][] = key for observers Since 2.5

Properties inherited from JObject

$_errors

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JCaptcha

Methods summary

Parameters

Since

Overrides

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Returns

Since

Parameters

Since

Parameters

Returns

Since

Methods inherited from JObject

Magic methods summary

Properties summary

Since

Since

Since

Properties inherited from JObject