PHP Class Prado\Web\UI\WebControls\TReCaptcha

TReCaptcha 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 setPrivateKey PrivateKey} and {@link setPublicKey PublicKey} 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 TReCaptchaValidator} 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.2
Author: Bérczi Gábor ([email protected])
Inheritance: extends TWebControl, implements Prado\Web\UI\IValidatable
Afficher le fichier Open project: pradosoft/prado

Méthodes publiques

Méthode Description
getCallbackScript ( )
getClientSideOptions ( )
getCustomTranslations ( )
getIsValid ( ) : boolean Returns true if this control validated successfully.
getLanguage ( )
getPrivateKey ( )
getPublicKey ( )
getResponseFieldName ( )
getTagName ( )
getThemeName ( )
getValidationPropertyValue ( )
onPreRender ( $param ) Checks for API keys
regenerateToken ( )
renderContents ( $writer )
setCallbackScript ( $value )
setCustomTranslations ( $value )
setIsValid ( $value )
setLanguage ( $value )
setPrivateKey ( $value )
setPublicKey ( $value )
setThemeName ( $value )
validate ( )

Méthodes protégées

Méthode Description
addAttributesToRender ( $writer )
getChallengeFieldName ( )

Private Methods

Méthode Description
recaptcha_check_answer ( string $privkey, string $remoteip, string $challenge, string $response, array $extra_params = [] ) : boolean Calls an HTTP POST function to verify if the user's guess was correct
recaptcha_get_html ( string $pubkey, string $error = null, boolean $use_ssl = false ) : string Gets the challenge HTML (javascript and non-javascript version).
recaptcha_http_post ( string $host, string $path, array $data, $port = 80 ) : array Submits an HTTP POST to a reCAPTCHA server
recaptcha_qsencode ( $data ) : string Encodes the given data into a query string format

Method Details

addAttributesToRender() protected méthode

protected addAttributesToRender ( $writer )

getCallbackScript() public méthode

public getCallbackScript ( )

getChallengeFieldName() protected méthode

protected getChallengeFieldName ( )

getClientSideOptions() public méthode

public getClientSideOptions ( )

getCustomTranslations() public méthode

public getCustomTranslations ( )

getIsValid() public méthode

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

getLanguage() public méthode

public getLanguage ( )

getPrivateKey() public méthode

public getPrivateKey ( )

getPublicKey() public méthode

public getPublicKey ( )

getResponseFieldName() public méthode

public getResponseFieldName ( )

getTagName() public méthode

public getTagName ( )

getThemeName() public méthode

public getThemeName ( )

getValidationPropertyValue() public méthode

public getValidationPropertyValue ( )

onPreRender() public méthode

Checks for API keys
public onPreRender ( $param )

regenerateToken() public méthode

public regenerateToken ( )

renderContents() public méthode

public renderContents ( $writer )

setCallbackScript() public méthode

public setCallbackScript ( $value )

setCustomTranslations() public méthode

public setCustomTranslations ( $value )

setIsValid() public méthode

public setIsValid ( $value )

setLanguage() public méthode

public setLanguage ( $value )

setPrivateKey() public méthode

public setPrivateKey ( $value )

setPublicKey() public méthode

public setPublicKey ( $value )

setThemeName() public méthode

public setThemeName ( $value )

validate() public méthode

public validate ( )