PHP Class RecaptchaPlugin, vanilla

Inheritance: extends Plugin
Afficher le fichier Open project: vanilla/vanilla

Protected Properties

Свойство Type Description
$privateKey string reCAPTCHA private key
$publicKey string reCAPTCHA public key

Méthodes publiques

Méthode Description
__construct ( ) Plugin initialization.
captcha_get_handler ( Gdn_PluginManager $sender ) Hook to return captcha submission data.
captcha_isEnabled_handler ( Gdn_PluginManager $sender, array $args ) Hook to indicate a captcha service is available.
captcha_render_handler ( Gdn_Controller $sender ) Hook (view) to render a captcha.
captcha_settings_handler ( SettingsController $sender ) Hook (view) to manage captcha config.
captcha_validate_handler ( Gdn_PluginManager $sender ) : boolean Hook to validate captchas.
gdn_form_captcha_handler ( Gdn_Form $sender ) : string Display reCAPTCHA entry field.
getPrivateKey ( ) : string Get private key from memory.
getPublicKey ( ) : string Get public key from memory.
setPrivateKey ( string $key ) Override private key in memory.
setPublicKey ( string $key ) Override public key in memory.
settingsController_registration_handler ( SettingsController $sender ) Hook (controller) to manage captcha config.
setup ( ) On plugin enable.
validateCaptcha ( string $captchaText ) : boolean Validate a reCAPTCHA submission.

Method Details

__construct() public méthode

Plugin initialization.
public __construct ( )

captcha_get_handler() public méthode

Hook to return captcha submission data.
public captcha_get_handler ( Gdn_PluginManager $sender )
$sender Gdn_PluginManager

captcha_isEnabled_handler() public méthode

Hook to indicate a captcha service is available.
public captcha_isEnabled_handler ( Gdn_PluginManager $sender, array $args )
$sender Gdn_PluginManager
$args array

captcha_render_handler() public méthode

THIS METHOD ECHOS DATA
public captcha_render_handler ( Gdn_Controller $sender )
$sender Gdn_Controller

captcha_settings_handler() public méthode

THIS METHOD ECHOS DATA
public captcha_settings_handler ( SettingsController $sender )
$sender SettingsController

captcha_validate_handler() public méthode

Hook to validate captchas.
public captcha_validate_handler ( Gdn_PluginManager $sender ) : boolean
$sender Gdn_PluginManager
Résultat boolean

gdn_form_captcha_handler() public méthode

THIS METHOD ECHOS DATA
public gdn_form_captcha_handler ( Gdn_Form $sender ) : string
$sender Gdn_Form
Résultat string

getPrivateKey() public méthode

Get private key from memory.
public getPrivateKey ( ) : string
Résultat string

getPublicKey() public méthode

Get public key from memory.
public getPublicKey ( ) : string
Résultat string

setPrivateKey() public méthode

Override private key in memory.
public setPrivateKey ( string $key )
$key string

setPublicKey() public méthode

Override public key in memory.
public setPublicKey ( string $key )
$key string

settingsController_registration_handler() public méthode

Hook (controller) to manage captcha config.
public settingsController_registration_handler ( SettingsController $sender )
$sender SettingsController

setup() public méthode

On plugin enable.
public setup ( )

validateCaptcha() public méthode

Validate a reCAPTCHA submission.
public validateCaptcha ( string $captchaText ) : boolean
$captchaText string
Résultat boolean

Property Details

$privateKey protected_oe property

reCAPTCHA private key
protected string $privateKey
Résultat string

$publicKey protected_oe property

reCAPTCHA public key
protected string $publicKey
Résultat string