\JCaptcha

Joomla! Captcha base object

Synopsis

class JCaptcha extends JObject {

• // members
• protected  $_observers;
• protected  $_state;
• protected  $_methods;
• private JPlugin  $_captcha;
• private  $_name;
• private  $_instances;
• // Inherited members from JObject
• protected  $_errors;
• // methods
• public void __construct()
• public static JCaptcha getInstance()
• public boolean initialise()
• public mixed display()
• public mixed checkAnswer()
• private void _load()
• public mixed getState()
• public void attach()
• public boolean detach()
• // Inherited methods from JObject
• public void __construct()
• public string __toString()
• public mixed def()
• public mixed get()
• public array getProperties()
• public string getError()
• public array getErrors()
• public mixed set()
• public boolean setProperties()
• public void setError()
}


Hierarchy

Extends

• JObject

Members

private

• $_captcha — JPlugin
  Captcha Plugin object
• $_instances — array
  Array of instances of this class.
• $_name — string
  Editor Plugin name

protected

• $_errors — array
  An array of error messages or Exception objects.
• $_methods — array
  A multi dimensional array of [function][] = key for observers
• $_observers — array
  An array of Observer objects to notify
• $_state — mixed
  The state of the observable object

Methods

private

• _load() — Load the Captcha plug-in.

public

• __construct() — Class constructor.
• attach() — Attach an observer object
• checkAnswer() — Checks if the answer is correct.
• detach() — Detach an observer object
• display() — Get the HTML for the captcha.
• getInstance() — Returns the global Captcha object, only creating it if it doesn't already exist.
• getState() — Get the state of the JEditor object
• initialise() — Fire the onInit event to initialise the captcha plug-in.

Inherited from JObject

public

• __toString() — Magic method to convert the object to a string gracefully.
• def() — Sets a default value if not alreay assigned
• get() — Returns a property of the object or the default value if the property is not set.
• getError() — Get the most recent error message.
• getErrors() — Return all errors, if any.
• getProperties() — Returns an associative array of object properties.
• set() — Modifies a property of the object, creating it if it does not already exist.
• setError() — Add an error message.
• setProperties() — Set the object properties based on a named array/hash.