CaptchaProviderInterface

Captcha Provider Interface

since

5.0.0

package

Joomla CMS

Methods

checkAnswer

Calls an HTTP POST function to verify if the user's guess was correct.

checkAnswer(string code = null) : 
since

5.0.0

throws

RuntimeException

Arguments

code

string|nullAnswer provided by user

Response

boolIf the answer is correct, false otherwise

display

Gets the challenge HTML

display( name = '', mixed||string|int attributes = []) : 
since

5.0.0

throws

RuntimeException

Arguments

name

stringInput name

attributes

array<string|int, mixed>The class of the field

Response

stringThe HTML to be embedded in the form

getName

Return Captcha name, CMD string.

getName() : 
since

5.0.0

Response

string

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\FormField field, \SimpleXMLElement element) : 
since

5.0.0

throws

RuntimeException

Arguments

field

FormFieldCaptcha field instance

element

SimpleXMLElementXML form definition

Response

void