Class \Prado\Web\UI\WebControls\TReCaptcha2

TReCaptcha2 class.

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 \Prado\Web\UI\WebControls\setSecretKey and \Prado\Web\UI\WebControls\setSiteKey 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 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:

<com:TReCaptcha2 ID="Captcha"
                SiteKey="..."
                SecretKey="..."
/>
<com:TReCaptcha2Validator ControlToValidate="Captcha"
                         ErrorMessage="You are challenged!" />

Class hierarchy

\Prado\Web\UI\WebControls\TReCaptcha2 implements ICallbackEventHandler, IValidatable

\Prado\Web\UI\ActiveControls\TActivePanel implements IActiveControl

\Prado\Web\UI\WebControls\TPanel

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

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

\Prado\TApplicationComponent

\Prado\TComponent

Author: Cristian Camilo Naranjo Valencia
Since: 3.3.1

Methods summary
`public`	`__construct() : mixed` Creates a new callback control, sets the adapter to TActiveControlAdapter. If you override this class, be sure to set the adapter appropriately by, for example, by calling this constructor.
`public`	`getActiveControl() : TBaseActiveCallbackControl`
`public`	`getClientClassName() : mixed`
`public`	`getClientSide() : TCallbackClientSide`
`public`	`getIsValid() : bool` Returns true if this control validated successfully. Defaults to true.
`public`	`getLanguage() : string` Returns your language.
`public`	`getResponse() : mixed` Gets the response for the reCAPTCHA widget.
`public`	`getResponseFieldName() : mixed`
`public`	`getSecretKey() : string` Returns your secret key.
`public`	`getSiteKey() : string` Returns your site key.
`public`	`getSize() : string` Returns the size of the widget.
`public`	`getTabIndex() : string` Returns the tabindex of the widget and challenge. If other elements in your page use tabindex, it should be set to make user navigation easier.
`public`	`getTagName() : mixed`
`public`	`getTheme() : string` Returns the color theme of the widget.
`public`	`getType() : string` Returns the type of CAPTCHA to serve.
`public`	`getValidationPropertyValue() : mixed`
`public`	`getWidgetId() : mixed`
`public`	`onCallback(mixed $param) : mixed`
`public`	`onCallbackExpired(mixed $param) : mixed`
`public`	`onPreRender(mixed $param) : mixed` Checks for API keys
`public`	`raiseCallbackEvent(mixed $param) : mixed` Raises callback event. The implementation of this function should raise appropriate event(s) (e.g. OnClick, OnCommand) indicating the component is responsible for the callback event.
`public`	`render(mixed $writer) : mixed` Renders and replaces the panel's content on the client-side. When render() is called before the OnPreRender event, such as when render() is called during a callback event handler, the rendering is defered until OnPreRender event is raised.
`public`	`reset() : mixed` Resets the reCAPTCHA widget. Optional widget ID, defaults to the first widget created if unspecified.
`public`	`setIsValid(bool $value) : mixed`
`public`	`setLanguage(string $value) : mixed`
`public`	`setResponse(mixed $value) : mixed`
`public`	`setSecretKey(string $value) : mixed`
`public`	`setSiteKey(string $value) : mixed`
`public`	`setSize(string $value) : mixed` The size of the widget. Default: normal
`public`	`setTabIndex(string $value) : mixed` The tabindex of the widget and challenge. If other elements in your page use tabindex, it should be set to make user navigation easier. Default: 0
`public`	`setTheme(string $value) : mixed` The color theme of the widget. Default: light
`public`	`setType(string $value) : mixed` The type of CAPTCHA to serve. Default: image
`public`	`setWidgetId(mixed $value) : mixed`
`public`	`validate() : mixed`
`protected`	`addAttributesToRender(mixed $writer) : mixed` Adds attribute id to the renderer.
`protected`	`getClientOptions() : mixed`
`protected`	`registerClientScript() : mixed`

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, getActiveControl, getAdapter, getAllowChildControls, getApplication, getAttribute, getAttributes, getAutoGlobalListen, getBackColor, getBackImageUrl, getBehaviors, getBehaviorsEnabled, getBorderColor, getBorderStyle, getBorderWidth, getClassHierarchy, getClientID, getControls, getCssClass, getCustomData, getDecorator, getDefaultButton, getDirection, getDisplay, getEnabled, getEnableTheming, getEnableViewState, getEnsureId, getEventHandlers, getFont, getForeColor, getGroupingText, getHasAdapter, getHasAttributes, getHasChildInitialized, getHasControls, getHasInitialized, getHasLoaded, getHasLoadedPostData, getHasPreRendered, getHasStyle, getHeight, getHorizontalAlign, getID, getIsSkinApplied, getListeningToGlobalEvents, getNamingContainer, getPage, getParent, getPluginModule, getRegisteredObject, getRequest, getResponse, getScrollBars, getService, getSession, getSkinID, getSourceTemplateControl, getStyle, getSubProperty, getTabIndex, getTemplateControl, getToolTip, getUniqueID, getUser, getViewState, getVisible, getWidth, getWrap, 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, setBackImageUrl, setBorderColor, setBorderStyle, setBorderWidth, setCssClass, setCustomData, setDefaultButton, setDirection, setDisplay, setEnabled, setEnableTheming, setEnableViewState, setEnsureId, setForeColor, setGroupingText, setHeight, setHorizontalAlign, setID, setPage, setScrollBars, setSkinID, setStyle, setSubProperty, setTabIndex, setTemplateControl, setToolTip, setViewState, setVisible, setWidth, setWrap, 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`	`'g-recaptcha-response'`

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\TReCaptcha2

Class hierarchy