Captcha
Extends JObjectJoomla! Captcha base object
| abstract | |
|---|---|
| since |
2.5 |
| package |
Joomla CMS |
Methods
__construct
Class constructor.
__construct(string captcha, array options) : mixed
| since |
2.5 |
|---|---|
| throws |
|
Arguments
- captcha
stringThe plugin to use.- options
arrayAssociative array of options.
Response
mixed
_load
Load the Captcha plugin.
_load(array options = array()) : void
| since |
2.5 |
|---|---|
| throws |
|
Arguments
- options
arrayAssociative array of options.
attach
Attach an observer object
attach(object observer) : void
| since |
2.5 |
|---|
Arguments
- observer
objectAn observer object to attach
checkAnswer
Checks if the answer is correct.
checkAnswer(string code) : bool
| since |
2.5 |
|---|---|
| throws |
|
Arguments
- code
stringThe answer.
Response
boolWhether the provided answer was correct
detach
Detach an observer object
detach(object observer) : bool
| since |
2.5 |
|---|
Arguments
- observer
objectAn observer object to detach.
Response
boolTrue if the observer object was detached.
display
Get the HTML for the captcha.
display(string name, string id, string class = '') : mixed
| since |
2.5 |
|---|---|
| throws |
|
Arguments
- name
stringThe control name.- id
stringThe id for the control.- class
stringValue for the HTML class attribute
Response
mixedThe return value of the function "onDisplay" of the selected Plugin.
getInstance
Returns the global Captcha object, only creating it if it doesn't already exist.
getInstance(string captcha, array options = array()) : \Joomla\CMS\Captcha\Captcha|null
| since |
2.5 |
|---|---|
| throws |
|
Arguments
- captcha
stringThe plugin to use.- options
arrayAssociative array of options.
Response
\Joomla\CMS\Captcha\Captcha|nullInstance of this class.
getState
Get the state of the Captcha object
getState() : mixed
| since |
2.5 |
|---|
Response
mixedThe state of the object.
initialise
Fire the onInit event to initialise the captcha plugin.
initialise(string id) : bool
| since |
2.5 |
|---|---|
| throws |
|
Arguments
- id
stringThe id of the field.
Response
boolTrue on success
setupField
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.
setupField(\Joomla\CMS\Form\Field\CaptchaField field, \SimpleXMLElement element) : void
Arguments
- field
\Joomla\CMS\Form\Field\CaptchaFieldCaptcha field instance- element
\SimpleXMLElementXML form definition
Properties
_observers
An array of Observer objects to notify
| since |
2.5 |
|---|
Type(s)
array
_state
The state of the observable object
| since |
2.5 |
|---|
Type(s)
mixed
_methods
A multi dimensional array of [function][] = key for observers
| since |
2.5 |
|---|
Type(s)
array
_captcha
Captcha Plugin object
| since |
2.5 |
|---|
Type(s)
\Joomla\CMS\Plugin\CMSPlugin
_name
Editor Plugin name
| since |
2.5 |
|---|
Type(s)
string
_instances
Array of instances of this class.
| since |
2.5 |
|---|
Type(s)
\Joomla\CMS\Captcha\Captcha[]