PHP Класс 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:
С версии: 3.3.1
Автор: Cristian Camilo Naranjo Valencia
Наследование: extends Prado\Web\UI\ActiveControls\TActivePanel, implements Prado\Web\UI\ActiveControls\ICallbackEventHandler, implements Prado\Web\UI\IValidatable
Показать файл Открыть проект

Открытые методы

Метод Описание
__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 ( )

Защищенные методы

Метод Описание
addAttributesToRender ( $writer )
getClientOptions ( )
registerClientScript ( )

Описание методов

__construct() публичный Метод

public __construct ( )

addAttributesToRender() защищенный Метод

protected addAttributesToRender ( $writer )

getActiveControl() публичный Метод

public getActiveControl ( )

getClientClassName() публичный Метод

public getClientClassName ( )

getClientOptions() защищенный Метод

protected getClientOptions ( )

getClientSide() публичный Метод

public getClientSide ( )

getIsValid() публичный Метод

Defaults to true.
public getIsValid ( ) : boolean
Результат boolean wether this control validated successfully.

getLanguage() публичный Метод

Returns your language.
public getLanguage ( ) : string.
Результат string.

getResponse() публичный Метод

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

getResponseFieldName() публичный Метод

getSecretKey() публичный Метод

Returns your secret key.
public getSecretKey ( ) : string.
Результат string.

getSiteKey() публичный Метод

Returns your site key.
public getSiteKey ( ) : string.
Результат string.

getSize() публичный Метод

Returns the size of the widget.
public getSize ( ) : string.
Результат string.

getTabIndex() публичный Метод

If other elements in your page use tabindex, it should be set to make user navigation easier.
public getTabIndex ( ) : string.
Результат string.

getTagName() публичный Метод

public getTagName ( )

getTheme() публичный Метод

Returns the color theme of the widget.
public getTheme ( ) : string.
Результат string.

getType() публичный Метод

Returns the type of CAPTCHA to serve.
public getType ( ) : string.
Результат string.

getValidationPropertyValue() публичный Метод

getWidgetId() публичный Метод

public getWidgetId ( )

onCallback() публичный Метод

public onCallback ( $param )

onCallbackExpired() публичный Метод

public onCallbackExpired ( $param )

onPreRender() публичный Метод

Checks for API keys
public onPreRender ( $param )

raiseCallbackEvent() публичный Метод

public raiseCallbackEvent ( $param )

registerClientScript() защищенный Метод

protected registerClientScript ( )

render() публичный Метод

public render ( $writer )

reset() публичный Метод

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

setIsValid() публичный Метод

public setIsValid ( $value )

setLanguage() публичный Метод

public setLanguage ( $value )

setResponse() публичный Метод

public setResponse ( $value )

setSecretKey() публичный Метод

public setSecretKey ( $value )

setSiteKey() публичный Метод

public setSiteKey ( $value )

setSize() публичный Метод

Default: normal
public setSize ( $value )

setTabIndex() публичный Метод

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

setTheme() публичный Метод

Default: light
public setTheme ( $value )

setType() публичный Метод

Default: image
public setType ( $value )

setWidgetId() публичный Метод

public setWidgetId ( $value )

validate() публичный Метод

public validate ( )