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
Mostra file Open project: pradosoft/prado

Public Methods

Method 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 ( )

Protected Methods

Method Description
addAttributesToRender ( $writer )
getClientOptions ( )
registerClientScript ( )

Method Details

__construct() public method

public __construct ( )

addAttributesToRender() protected method

protected addAttributesToRender ( $writer )

getActiveControl() public method

public getActiveControl ( )

getClientClassName() public method

public getClientClassName ( )

getClientOptions() protected method

protected getClientOptions ( )

getClientSide() public method

public getClientSide ( )

getIsValid() public method

Defaults to true.
public getIsValid ( ) : boolean
return boolean wether this control validated successfully.

getLanguage() public method

Returns your language.
public getLanguage ( ) : string.
return string.

getResponse() public method

Gets the response for the reCAPTCHA widget.
public getResponse ( )

getResponseFieldName() public method

public getResponseFieldName ( )

getSecretKey() public method

Returns your secret key.
public getSecretKey ( ) : string.
return string.

getSiteKey() public method

Returns your site key.
public getSiteKey ( ) : string.
return string.

getSize() public method

Returns the size of the widget.
public getSize ( ) : string.
return string.

getTabIndex() public method

If other elements in your page use tabindex, it should be set to make user navigation easier.
public getTabIndex ( ) : string.
return string.

getTagName() public method

public getTagName ( )

getTheme() public method

Returns the color theme of the widget.
public getTheme ( ) : string.
return string.

getType() public method

Returns the type of CAPTCHA to serve.
public getType ( ) : string.
return string.

getValidationPropertyValue() public method

public getValidationPropertyValue ( )

getWidgetId() public method

public getWidgetId ( )

onCallback() public method

public onCallback ( $param )

onCallbackExpired() public method

public onCallbackExpired ( $param )

onPreRender() public method

Checks for API keys
public onPreRender ( $param )

raiseCallbackEvent() public method

public raiseCallbackEvent ( $param )

registerClientScript() protected method

protected registerClientScript ( )

render() public method

public render ( $writer )

reset() public method

Optional widget ID, defaults to the first widget created if unspecified.
public reset ( )

setIsValid() public method

public setIsValid ( $value )

setLanguage() public method

public setLanguage ( $value )

setResponse() public method

public setResponse ( $value )

setSecretKey() public method

public setSecretKey ( $value )

setSiteKey() public method

public setSiteKey ( $value )

setSize() public method

Default: normal
public setSize ( $value )

setTabIndex() public method

If other elements in your page use tabindex, it should be set to make user navigation easier. Default: 0
public setTabIndex ( $value )

setTheme() public method

Default: light
public setTheme ( $value )

setType() public method

Default: image
public setType ( $value )

setWidgetId() public method

public setWidgetId ( $value )

validate() public method

public validate ( )