[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/plugins/captcha/recaptcha/ -> recaptcha.php (summary)

(no description)

Copyright: (C) 2011 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
File Size: 203 lines (6 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

PlgCaptchaRecaptcha:: (5 methods):
  onPrivacyCollectAdminCapabilities()
  onInit()
  onDisplay()
  onCheckAnswer()
  getResponse()


Class: PlgCaptchaRecaptcha  - X-Ref

Recaptcha Plugin
Based on the official recaptcha library( https://packagist.org/packages/google/recaptcha )

onPrivacyCollectAdminCapabilities()   X-Ref
Reports the privacy related capabilities for this plugin to site administrators.

return: array

onInit($id = 'dynamic_recaptcha_1')   X-Ref
Initialise the captcha

param: string  $id  The id of the field.
return: Boolean True on success, false otherwise

onDisplay($name = null, $id = 'dynamic_recaptcha_1', $class = '')   X-Ref
Gets the challenge HTML

param: string  $name   The name of the field. Not Used.
param: string  $id     The id of the field.
param: string  $class  The class of the field.
return: string  The HTML to be embedded in the form.

onCheckAnswer($code = null)   X-Ref
Calls an HTTP POST function to verify if the user's guess was correct

param: string  $code  Answer provided by user. Not needed for the Recaptcha implementation
return: True if the answer is correct, false otherwise

getResponse(string $privatekey, string $remoteip, string $response)   X-Ref
Get the reCaptcha response.

param: string  $privatekey  The private key for authentication.
param: string  $remoteip    The remote IP of the visitor.
param: string  $response    The response received from Google.
return: bool True if response is good | False if response is bad.



Generated: Wed Sep 7 05:41:13 2022 Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer