PHP Class Prado\Web\UI\WebControls\TReCaptcha2

TReCaptcha2 displays a reCAPTCHA (a token displayed as an image) that can be used to determine if the input is entered by a real user instead of some program. It can also prevent multiple submits of the same form either by accident, or on purpose (ie. spamming). The reCAPTCHA to solve (a string consisting of two separate words) displayed is automatically generated by the reCAPTCHA system at recaptcha.net. However, in order to use the services of the site you will need to register and get a public and a private API key pair, and supply those to the reCAPTCHA control through setting the {@link setSecretKey SecretKey} and {@link setSiteKey SiteKey} properties. Currently the reCAPTCHA API supports only one reCAPTCHA field per page, so you MUST make sure that all your input is protected and validated by a single reCAPTCHA control. Placing more than one reCAPTCHA control on the page will lead to unpredictable results, and the user will most likely unable to solve any of them successfully. Upon postback, user input can be validated by calling {@link validate()}. The {@link TReCaptcha2Validator} control can also be used to do validation, which provides server-side validation. Calling (@link validate()) will invalidate the token supplied, so all consecutive calls to the method - without solving a new captcha - will return false. Therefore if implementing a multi-stage input process, you must make sure that you call validate() only once, either at the end of the input process, or you store the result till the end of the processing. The following template shows a typical use of TReCaptcha control:

Since: 3.3.1

Author: Cristian Camilo Naranjo Valencia

Inheritance: extends Prado\Web\UI\ActiveControls\TActivePanel, implements Prado\Web\UI\ActiveControls\ICallbackEventHandler, implements Prado\Web\UI\IValidatable

Afficher le fichier Open project: pradosoft/prado

Méthodes publiques

Méthode	Description
__construct ( )
getActiveControl ( )
getClientClassName ( )
getClientSide ( )
getIsValid ( ) : boolean	Returns true if this control validated successfully.
getLanguage ( ) : string.	Returns your language.
getResponse ( )	Gets the response for the reCAPTCHA widget.
getResponseFieldName ( )
getSecretKey ( ) : string.	Returns your secret key.
getSiteKey ( ) : string.	Returns your site key.
getSize ( ) : string.	Returns the size of the widget.
getTabIndex ( ) : string.	Returns the tabindex of the widget and challenge.
getTagName ( )
getTheme ( ) : string.	Returns the color theme of the widget.
getType ( ) : string.	Returns the type of CAPTCHA to serve.
getValidationPropertyValue ( )
getWidgetId ( )
onCallback ( $param )
onCallbackExpired ( $param )
onPreRender ( $param )	Checks for API keys
raiseCallbackEvent ( $param )
render ( $writer )
reset ( )	Resets the reCAPTCHA widget.
setIsValid ( $value )
setLanguage ( $value )
setResponse ( $value )
setSecretKey ( $value )
setSiteKey ( $value )
setSize ( $value )	The size of the widget.
setTabIndex ( $value )	The tabindex of the widget and challenge.
setTheme ( $value )	The color theme of the widget.
setType ( $value )	The type of CAPTCHA to serve.
setWidgetId ( $value )
validate ( )

Méthodes protégées

Méthode	Description
addAttributesToRender ( $writer )
getClientOptions ( )
registerClientScript ( )

Method Details

__construct() public méthode

public __construct ( )

addAttributesToRender() protected méthode

protected addAttributesToRender ( $writer )

getActiveControl() public méthode

public getActiveControl ( )

getClientClassName() public méthode

public getClientClassName ( )

getClientOptions() protected méthode

protected getClientOptions ( )

getClientSide() public méthode

public getClientSide ( )

getIsValid() public méthode

Defaults to true.

public getIsValid ( ) : boolean
Résultat	boolean	wether this control validated successfully.

getLanguage() public méthode

Returns your language.

public getLanguage ( ) : string.
Résultat	string.

getResponse() public méthode

Gets the response for the reCAPTCHA widget.

public getResponse ( )

getResponseFieldName() public méthode

public getResponseFieldName ( )

getSecretKey() public méthode

Returns your secret key.

public getSecretKey ( ) : string.
Résultat	string.

getSiteKey() public méthode

Returns your site key.

public getSiteKey ( ) : string.
Résultat	string.

getSize() public méthode

Returns the size of the widget.

public getSize ( ) : string.
Résultat	string.

getTabIndex() public méthode

If other elements in your page use tabindex, it should be set to make user navigation easier.

public getTabIndex ( ) : string.
Résultat	string.

getTagName() public méthode

public getTagName ( )

getTheme() public méthode

Returns the color theme of the widget.

public getTheme ( ) : string.
Résultat	string.

getType() public méthode

Returns the type of CAPTCHA to serve.

public getType ( ) : string.
Résultat	string.

getValidationPropertyValue() public méthode

public getValidationPropertyValue ( )

getWidgetId() public méthode

public getWidgetId ( )

onCallback() public méthode

public onCallback ( $param )

onCallbackExpired() public méthode

public onCallbackExpired ( $param )

onPreRender() public méthode

Checks for API keys

public onPreRender ( $param )

raiseCallbackEvent() public méthode

public raiseCallbackEvent ( $param )

registerClientScript() protected méthode

protected registerClientScript ( )

render() public méthode

public render ( $writer )

reset() public méthode

Optional widget ID, defaults to the first widget created if unspecified.

public reset ( )

setIsValid() public méthode

public setIsValid ( $value )

setLanguage() public méthode

public setLanguage ( $value )

setResponse() public méthode

public setResponse ( $value )

setSecretKey() public méthode

public setSecretKey ( $value )

setSiteKey() public méthode

public setSiteKey ( $value )

setSize() public méthode

Default: normal

public setSize ( $value )

setTabIndex() public méthode

If other elements in your page use tabindex, it should be set to make user navigation easier. Default: 0

public setTabIndex ( $value )

setTheme() public méthode

Default: light

public setTheme ( $value )

setType() public méthode

Default: image

public setType ( $value )

setWidgetId() public méthode

public setWidgetId ( $value )

validate() public méthode

public validate ( )