| [ Index ] |
PHP Cross Reference of Joomla 4.2.2 documentation |
[Source view] [Print] [Project Stats]
Joomla! Content Management System
| Copyright: | (C) 2011 Open Source Matters, Inc. |
| License: | GNU General Public License version 2 or later; see LICENSE.txt |
| File Size: | 268 lines (7 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Captcha:: (8 methods):
__construct()
getInstance()
initialise()
display()
checkAnswer()
setupField()
update()
_load()
| __construct($captcha, $options) X-Ref |
| Class constructor. param: string $captcha The plugin to use. param: array $options Associative array of options. |
| getInstance($captcha, array $options = array() X-Ref |
| Returns the global Captcha object, only creating it if it doesn't already exist. param: string $captcha The plugin to use. param: array $options Associative array of options. return: Captcha|null Instance of this class. |
| initialise($id) X-Ref |
| Fire the onInit event to initialise the captcha plugin. param: string $id The id of the field. return: boolean True on success |
| display($name, $id, $class = '') X-Ref |
| Get the HTML for the captcha. param: string $name The control name. param: string $id The id for the control. param: string $class Value for the HTML class attribute return: string The return value of the function "onDisplay" of the selected Plugin. |
| checkAnswer($code) X-Ref |
| Checks if the answer is correct. param: string $code The answer. return: bool Whether the provided answer was correct |
| setupField(\Joomla\CMS\Form\Field\CaptchaField $field, \SimpleXMLElement $element) X-Ref |
| 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. param: \Joomla\CMS\Form\Field\CaptchaField $field Captcha field instance param: \SimpleXMLElement $element XML form definition return: void |
| update($name, &$args) X-Ref |
| Method to call the captcha callback if it exist. param: string $name Callback name param: array &$args Arguments return: mixed |
| _load(array $options = array() X-Ref |
| Load the Captcha plugin. param: array $options Associative array of options. return: void |
| Generated: Wed Sep 7 05:41:13 2022 | Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer |