JCaptcha

Extends \JObject

Joomla! Captcha base object

This class allows for simple but smart objects with get and set methods and an internal error handler.

abstract
package

Joomla.Libraries

subpackage

Captcha

since

2.5

Methods

__construct

Class constructor, overridden in descendant classes.

__construct(mixed $properties = null) 
inherited
since

11.1

Arguments

$properties

mixedEither and associative array or another object to set the initial properties of the object.

__toString

Magic method to convert the object to a string gracefully.

__toString() : string
inherited deprecated
since

11.1

deprecated

12.3 Classes should provide their own __toString() implementation.

Response

stringThe classname.

_load

Load the Captcha plugin.

_load(array $options = array()) : void
since

2.5

throws

\RuntimeException

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) : mixed
since

2.5

Arguments

$code

stringThe answer.

Response

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

def

Sets a default value if not already assigned

def(string $property, mixed $default = null) : mixed
inherited
since

11.1

Arguments

$property

stringThe name of the property.

$default

mixedThe default value.

Response

mixed

detach

Detach an observer object

detach(object $observer) : boolean
since

2.5

Arguments

$observer

objectAn observer object to detach.

Response

booleanTrue if the observer object was detached.

display

Get the HTML for the captcha.

display(string $name, string $id, string $class = '') : mixed
since

2.5

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.

get

Returns a property of the object or the default value if the property is not set.

get(string $property, mixed $default = null) : mixed
inherited
since

11.1

see \JObject::getProperties()

Arguments

$property

stringThe name of the property.

$default

mixedThe default value.

Response

mixedThe value of the property.

getError

Get the most recent error message.

getError(integer $i = null, boolean $toString = true) : string
inherited deprecated
since

11.1

see \JError
deprecated

12.3 JError has been deprecated

Arguments

$i

integerOption error index.

$toString

booleanIndicates if JError objects should return their error message.

Response

stringError message

getErrors

Return all errors, if any.

getErrors() : array
inherited deprecated
since

11.1

see \JError
deprecated

12.3 JError has been deprecated

Response

arrayArray of error messages or JErrors.

getInstance

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

getInstance(string $captcha, array $options = array()) : \JCaptcha|null
static
since

2.5

Arguments

$captcha

stringThe plugin to use.

$options

arrayAssociative array of options.

Response

\JCaptcha|nullInstance of this class.

getProperties

Returns an associative array of object properties.

getProperties(boolean $public = true) : array
inherited
since

11.1

see \JObject::get()

Arguments

$public

booleanIf true, returns only the public properties.

Response

array

getState

Get the state of the JEditor 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) : boolean
since

2.5

Arguments

$id

stringThe id of the field.

Response

booleanTrue on success

set

Modifies a property of the object, creating it if it does not already exist.

set(string $property, mixed $value = null) : mixed
inherited
since

11.1

Arguments

$property

stringThe name of the property.

$value

mixedThe value of the property to set.

Response

mixedPrevious value of the property.

setError

Add an error message.

setError(string $error) : void
inherited deprecated
since

11.1

see \JError
deprecated

12.3 JError has been deprecated

Arguments

$error

stringError message.

setProperties

Set the object properties based on a named array/hash.

setProperties(mixed $properties) : boolean
inherited
since

11.1

see \JObject::set()

Arguments

$properties

mixedEither an associative array or another object.

Response

boolean

Properties

_observers

An array of Observer objects to notify

Type(s)

array

_state

The state of the observable object

Type(s)

mixed

_methods

A multi dimensional array of [function][] = key for observers

Type(s)

array

_captcha

Captcha Plugin object

Type(s)

\JPlugin

_name

Editor Plugin name

Type(s)

string

_instances

Array of instances of this class.

static

Type(s)

array<mixed,\JCaptcha>

_errors

An array of error messages or Exception objects.

inherited deprecated

Type(s)

array