Class \Prado\Web\UI\WebControls\TReCaptcha

TReCaptcha class.

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 \Prado\Web\UI\WebControls\setPrivateKey and \Prado\Web\UI\WebControls\setPublicKey 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 validate(). The 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:

<com:TReCaptcha ID="Captcha"
                PublicKey="..."
                PrivateKey="..."
/>
<com:TReCaptchaValidator ControlToValidate="Captcha"
                         ErrorMessage="You are challenged!" />

Class hierarchy

\Prado\Web\UI\WebControls\TReCaptcha implements IValidatable

\Prado\Web\UI\WebControls\TWebControl implements IStyleable

\Prado\Web\UI\TControl implements IRenderable, IBindable

\Prado\TApplicationComponent

\Prado\TComponent

Author: Bérczi Gábor <gabor.berczi@devworx.hu>
Since: 3.2

Methods summary
`public`	`getCallbackScript() : mixed`
`public`	`getClientSideOptions() : mixed`
`public`	`getCustomTranslations() : mixed`
`public`	`getIsValid() : bool` Returns true if this control validated successfully. Defaults to true.
`public`	`getLanguage() : mixed`
`public`	`getPrivateKey() : mixed`
`public`	`getPublicKey() : mixed`
`public`	`getResponseFieldName() : mixed`
`public`	`getTagName() : string` Returns the tag name used for this control. By default, the tag name is 'span'. You can override this method to provide customized tag names.
`public`	`getThemeName() : mixed`
`public`	`getValidationPropertyValue() : mixed`
`public`	`onPreRender(mixed $param) : mixed` Checks for API keys
`public`	`regenerateToken() : mixed`
`public`	`renderContents(mixed $writer) : mixed` Renders the body content enclosed between the control tag. By default, child controls and text strings will be rendered. You can override this method to provide customized content rendering.
`public`	`setCallbackScript(mixed $value) : mixed`
`public`	`setCustomTranslations(mixed $value) : mixed`
`public`	`setIsValid(bool $value) : mixed`
`public`	`setLanguage(mixed $value) : mixed`
`public`	`setPrivateKey(mixed $value) : mixed`
`public`	`setPublicKey(mixed $value) : mixed`
`public`	`setThemeName(mixed $value) : mixed`
`public`	`validate() : mixed`
`protected`	`addAttributesToRender(mixed $writer) : mixed` Adds attribute name-value pairs to renderer. By default, the method will render 'id', 'accesskey', 'disabled', 'tabindex', 'title' and all custom attributes. The method can be overriden to provide customized attribute rendering.
`protected`	`getChallengeFieldName() : mixed`
`private`	`recaptcha_check_answer(string $privkey, string $remoteip, string $challenge, string $response[, array<string\|int, mixed> $extra_params = [] ]) : bool` Calls an HTTP POST function to verify if the user's guess was correct
`private`	`recaptcha_get_html(string $pubkey[, string $error = null ][, bool $use_ssl = false ]) : string` Gets the challenge HTML (javascript and non-javascript version). This is called from the browser, and the resulting reCAPTCHA HTML widget is embedded within the HTML form it was called from.
`private`	`recaptcha_http_post(string $host, string $path, array<string\|int, mixed> $data[, int $port = 80 ]) : array<string\|int, mixed>` Submits an HTTP POST to a reCAPTCHA server
`private`	`recaptcha_qsencode(array<string\|int, mixed> $data) : string` Encodes the given data into a query string format

Inherited methods
__call, __callStatic, __clone, __construct, __destruct, __get, __isset, __set, __sleep, __unset, __wakeup, addedControl, addParsedObject, applyStyleSheetSkin, asa, attachBehavior, attachBehaviors, attachClassBehavior, attachEventHandler, autoBindProperty, bindProperty, broadcastEvent, bubbleEvent, callBehaviorsMethod, canGetProperty, canSetProperty, clearBehaviors, clearNamingContainer, clearStyle, clearViewState, convertUniqueIdToClientId, copyBaseAttributes, createChildControls, createdOnTemplate, dataBind, detachBehavior, detachBehaviors, detachClassBehavior, detachEventHandler, disableBehavior, disableBehaviors, enableBehavior, enableBehaviors, ensureChildControls, evaluateExpression, evaluateStatements, findControl, findControlsByID, findControlsByType, focus, fxAttachClassBehavior, fxDetachClassBehavior, getAccessKey, getAdapter, getAllowChildControls, getApplication, getAttribute, getAttributes, getAutoGlobalListen, getBackColor, getBehaviors, getBehaviorsEnabled, getBorderColor, getBorderStyle, getBorderWidth, getClassHierarchy, getClientID, getControls, getCssClass, getCustomData, getDecorator, getDisplay, getEnabled, getEnableTheming, getEnableViewState, getEnsureId, getEventHandlers, getFont, getForeColor, getHasAdapter, getHasAttributes, getHasChildInitialized, getHasControls, getHasInitialized, getHasLoaded, getHasLoadedPostData, getHasPreRendered, getHasStyle, getHeight, getID, getIsSkinApplied, getListeningToGlobalEvents, getNamingContainer, getPage, getParent, getPluginModule, getRegisteredObject, getRequest, getResponse, getService, getSession, getSkinID, getSourceTemplateControl, getStyle, getSubProperty, getTabIndex, getTemplateControl, getToolTip, getUniqueID, getUser, getViewState, getVisible, getWidth, hasAttribute, hasEvent, hasEventHandler, hasMethod, hasProperty, isa, isObjectRegistered, listen, loadState, onDataBinding, onInit, onLoad, onPreRender, onUnload, publishAsset, publishFilePath, raiseEvent, registerObject, removeAttribute, removedControl, render, renderBeginTag, renderChildren, renderContents, renderControl, renderEndTag, saveState, setAccessKey, setAdapter, setAttribute, setBackColor, setBorderColor, setBorderStyle, setBorderWidth, setCssClass, setCustomData, setDisplay, setEnabled, setEnableTheming, setEnableViewState, setEnsureId, setForeColor, setHeight, setID, setPage, setSkinID, setStyle, setSubProperty, setTabIndex, setTemplateControl, setToolTip, setViewState, setVisible, setWidth, trackViewState, unbindProperty, unlisten, unregisterObject, _getZappableSleepProps, addAttributesToRender, autoDataBindProperties, clearChildState, clearControlState, createControlCollection, createStyle, dataBindChildren, dataBindProperties, getCallChain, getChildControlsCreated, getClassFxEvents, getControlStage, getControlState, getTagName, initRecursive, instanceBehavior, isDescendentOf, loadRecursive, loadStateRecursive, preRenderRecursive, raiseBubbleEvent, saveStateRecursive, setChildControlsCreated, setControlStage, setControlState, traverseChildControls, unloadRecursive, broadcastEventInternal, clearCachedUniqueID, clearNameTable, fillNameTable, filter_prado_fx, generateAutomaticID

Constants summary
`public mixed`	`ChallengeFieldName`	`'recaptcha_challenge_field'`
`public mixed`	`RECAPTCHA_API_SECURE_SERVER`	`"https://www.google.com/recaptcha/api"`
`public mixed`	`RECAPTCHA_API_SERVER`	`"http://www.google.com/recaptcha/api"`
`public mixed`	`RECAPTCHA_JS`	`'http://www.google.com/recaptcha/api/js/recaptcha_ajax.js'`
`public mixed`	`RECAPTCHA_VERIFY_SERVER`	`"www.google.com"`
`public mixed`	`ResponseFieldName`	`'recaptcha_response_field'`

Inherited constants
\Prado\Web\UI\TControl::AUTOMATIC_ID_PREFIX, \Prado\Web\UI\TControl::CLIENT_ID_SEPARATOR, \Prado\Web\UI\TControl::CS_CHILD_INITIALIZED, \Prado\Web\UI\TControl::CS_CONSTRUCTED, \Prado\Web\UI\TControl::CS_INITIALIZED, \Prado\Web\UI\TControl::CS_LOADED, \Prado\Web\UI\TControl::CS_PRERENDERED, \Prado\Web\UI\TControl::CS_STATE_LOADED, \Prado\TApplicationComponent::FX_CACHE_FILE, \Prado\TComponent::GLOBAL_RAISE_EVENT_LISTENER, \Prado\Web\UI\TControl::ID_FORMAT, \Prado\Web\UI\TControl::ID_SEPARATOR, \Prado\Web\UI\TControl::IS_CHILD_CREATED, \Prado\Web\UI\TControl::IS_CREATING_CHILD, \Prado\Web\UI\TControl::IS_DISABLE_THEMING, \Prado\Web\UI\TControl::IS_DISABLE_VIEWSTATE, \Prado\Web\UI\TControl::IS_ID_SET, \Prado\Web\UI\TControl::IS_SKIN_APPLIED, \Prado\Web\UI\TControl::IS_STYLESHEET_APPLIED, \Prado\Web\UI\TControl::RF_ADAPTER, \Prado\Web\UI\TControl::RF_AUTO_BINDINGS, \Prado\Web\UI\TControl::RF_CHILD_STATE, \Prado\Web\UI\TControl::RF_CONTROLS, \Prado\Web\UI\TControl::RF_CONTROLSTATE, \Prado\Web\UI\TControl::RF_DATA_BINDINGS, \Prado\Web\UI\TControl::RF_EVENTS, \Prado\Web\UI\TControl::RF_NAMED_CONTROLS, \Prado\Web\UI\TControl::RF_NAMED_CONTROLS_ID, \Prado\Web\UI\TControl::RF_NAMED_OBJECTS, \Prado\Web\UI\TControl::RF_SKIN_ID

Classes

Interfaces

Traits

Search results

Class \Prado\Web\UI\WebControls\TReCaptcha

Class hierarchy